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

Run using a PipelineConfig class and CLI overrides #901

Open
lewfish opened this issue Apr 17, 2020 · 2 comments
Open

Run using a PipelineConfig class and CLI overrides #901

lewfish opened this issue Apr 17, 2020 · 2 comments

Comments

@lewfish
Copy link
Contributor

lewfish commented Apr 17, 2020

To run a pipeline, you point the run CLI at a file with a get_config function that returns an instance of PipelineConfig. This is useful for storing particular configurations especially when they are very complex, but seems unnecessarily convoluted if you just want to run a pipeline using all the default options and a few overrides of those defaults. An alternative would be the ability to just point the run CLI at a PipelineConfig class, and supply any fields and their values to override. Example invocation: rastervision2 run my_module.MyPipelineConfig --override x 3 --override a.b "hello" This would make sense for pipelines that do some ephemeral data processing that was perhaps kicked off in an automated way by some other process.

Some things to think about:

  • How to represent overrides of nested or array fields
  • How to do input validation (can we harness the builtin Pydantic validation as much as possible)
  • Generating useful --help docs that list the fields in an automated way from the Pydantic field descriptions
@lewfish
Copy link
Contributor Author

lewfish commented Apr 17, 2020

@echeipesh originally proposed this idea

@lewfish
Copy link
Contributor Author

lewfish commented Dec 8, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants