Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scalable AIP arguments #74

Merged
merged 8 commits into from
Nov 8, 2024
Merged

Conversation

verovaleros
Copy link
Member

@verovaleros verovaleros commented Nov 5, 2024

Description

closes #73

This PR introduces a key change in the argument parsing of AIP, that is, the use of argparse subparser commands.

Why? We expect to have growing functionality in AIP which may not be fully related to the normal generation of blocklists, such as metrics, running models for a given time frame, etc. We thought better to have these as commands that can be invoked.

The main changes after introducing this are:

  • Migrate --rebuild-kb to subparser command rebuild-knowledge-base
  • Migrate --date and --model to subparser command run-models
  • Test to make sure it maintain current functionality (bin/aip still runs the default all models for date.today())

General usage

image

Command run-models

image

Command rebuild-kb

image

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Run AIP with multiple scenarios: without commands, with commands, with some arguments, with dates in the past, rebuilding the knowledge base, etc.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings

Changes to the documentation

  • I have made corresponding changes to the documentation

@verovaleros verovaleros self-assigned this Nov 5, 2024
@verovaleros verovaleros added the enhancement New feature or request label Nov 5, 2024
@verovaleros verovaleros added this to the v3.1.0 milestone Nov 5, 2024
@verovaleros verovaleros marked this pull request as ready for review November 5, 2024 17:58
@verovaleros verovaleros merged commit 55df89a into development Nov 8, 2024
3 checks passed
@verovaleros verovaleros deleted the add-scalable-aip-arguments branch November 8, 2024 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Design scalable AIP arguments structure to support adding new features
1 participant