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

Use subparsers/subcommands for experiment CLI #57

Open
WarmCyan opened this issue Jul 12, 2023 · 2 comments
Open

Use subparsers/subcommands for experiment CLI #57

WarmCyan opened this issue Jul 12, 2023 · 2 comments
Labels
cli discussion Discussion about a potential feature needed enhancement New feature or request

Comments

@WarmCyan
Copy link
Collaborator

As the CLI becomes more complicated, and there are additional plans to make it more complicated, putting everything into the same base parser is becoming confusing.

It's convenient to be able to just type experiment [my_experiment_name], but as the number of possible "commands" grows (e.g. experiment reports, experiment ls), the potential for conflicting names also grows.

reports and ls should be put as sub commands, and a new run subcommand should be added for the primary run-the-experiment usecase.

Thoughts on this are welcome, it unfortunately is a breaking change for any prior experiment's reproduction lines.

@WarmCyan WarmCyan added enhancement New feature or request discussion Discussion about a potential feature needed labels Jul 12, 2023
@WarmCyan WarmCyan added the cli label Jul 30, 2023
@WarmCyan
Copy link
Collaborator Author

Once this goes through, it might actually be worth moving the curifactory commands (project.py) into the experiment command instead, e.g.

curifactory init -> experiment init
curifactory completion -> experiment completion

Similarly, some of the flags could probably just become subcommands instead. Specifically

experiment [...] --map -> experiment map [...]
experiment [...] --check -> experiment check [...] (once #81 done)

Other sub commands might include:
experiment reset [...] (#70)

@WarmCyan
Copy link
Collaborator Author

This should also allow two important functionalities:

  • Print out associated cache paths for a particular run
  • Print out the parameters registry for a hash starting with ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli discussion Discussion about a potential feature needed enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant