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

Design scalable AIP arguments structure to support adding new features #73

Closed
verovaleros opened this issue Nov 5, 2024 · 6 comments · Fixed by #74
Closed

Design scalable AIP arguments structure to support adding new features #73

verovaleros opened this issue Nov 5, 2024 · 6 comments · Fixed by #74
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@verovaleros
Copy link
Member

verovaleros commented Nov 5, 2024

We will continue adding new functionality and options to AIP (metrics, generate blocklists for range, comparisons, etc).

Would be great to have some sort of structure for argparse so we don't just keep adding arguments without thinking through the whole structure.

@verovaleros verovaleros converted this from a draft issue Nov 5, 2024
@verovaleros verovaleros self-assigned this Nov 5, 2024
@verovaleros verovaleros added this to the v3.1.0 milestone Nov 5, 2024
@verovaleros verovaleros added the enhancement New feature or request label Nov 5, 2024
@verovaleros
Copy link
Member Author

blocks #68

@verovaleros
Copy link
Member Author

I think we can use subparsers for extra functionality. By default, it would run as it normally does from bin/aip running all models for today.

We could have a command bin/aip run which can support several scenarios:

  • Run all models for a specific day
  • Run a given model for a specific day.
  • Run all models between two dates.
  • Run a specific model between two dates.

@verovaleros verovaleros moved this from 🆕 New to 📋 Backlog in Stratosphere AIP Nov 5, 2024
@verovaleros
Copy link
Member Author

Another command can be --rebuild-kb, which now takes a date. This could be bin/aip rebuild-kb which can take a date as input --start-date or something like that.

@verovaleros
Copy link
Member Author

I think argparse should work for now, but in the future we may want to migrate to click or typer if it brings more flexibility.

@verovaleros
Copy link
Member Author

The idea is then:

  • Maintain current functionality
  • Migrate --rebuild-kb to subparser command rebuild-knowledge-base
  • Migrate --date and --model to subparser command run-models

@verovaleros
Copy link
Member Author

It's very frustrating that for argparse the global arguments need to be called first, e.g.:

bin/aip -v rebuild-kb --start-date YYYY-MM-DD

@verovaleros verovaleros linked a pull request Nov 5, 2024 that will close this issue
7 tasks
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Stratosphere AIP Nov 8, 2024
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
1 participant