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 Active Stack as part of configuration YAML #2261

Open
1 task
strickvl opened this issue Jan 10, 2024 · 3 comments
Open
1 task

Add Active Stack as part of configuration YAML #2261

strickvl opened this issue Jan 10, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@strickvl
Copy link
Contributor

Open Source Contributors Welcomed!

Please comment below if you would like to work on this issue!

Contact Details [Optional]

support@zenml.io

What happened?

After a discussion about the Run Config YAML and potential improvements, it became apparent that including the active stack name or ID in the configuration YAML would significantly enhance usability. This change would allow users to specify which stack the pipeline should run on directly within the config YAML.

Task Description

Update the ZenML configuration YAML structure to include an option for setting the active stack. Users should be able to specify the stack name or ID under a dedicated section in the YAML, which ZenML will then use to determine the active stack for pipeline execution.

Expected Outcome

  • The configuration YAML should have a clear and user-friendly section for specifying the active stack.
  • ZenML should correctly interpret and use the specified stack for running the pipeline.
  • This update will provide users with greater control and flexibility in their pipeline execution environment.

Steps to Implement

  • Design and implement a new section in the Run Config YAML format for specifying the active stack (name or ID).
  • Update the ZenML backend to read and apply this configuration when initializing pipeline runs.
  • Ensure backward compatibility and graceful handling when the stack section is not specified in existing YAMLs.
  • Test the implementation thoroughly to ensure the correct stack is used based on the YAML configuration. (Include tests in PR).
  • Update documentation to guide users on how to use this new feature in their YAML configurations.

Additional Context

This enhancement is part of ongoing efforts to make ZenML more flexible and user-centric, enabling users to tailor their MLOps workflows more precisely to their needs.

cc: @schustmi @znegrin

Code of Conduct

  • I agree to follow this project's Code of Conduct
@strickvl strickvl added enhancement New feature or request good first issue Good for newcomers labels Jan 10, 2024
@kabinja
Copy link

kabinja commented Jan 12, 2024

Hello, if that task is still available, I can start working on it :)

@strickvl
Copy link
Contributor Author

@kabinja yes for sure! let us know if you have any questions, and please do follow the CONTRIBUTING document, esp w/r/t to branching and making your PR off the develop branch!

@schustmi
Copy link
Contributor

@kabinja One little detail for you that will be quite helpful: This is the pydantic class that defines the structure of the yaml configuration file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants