Pending Changes for Active Stack #3372

preyasshah9 · 2025-02-24T01:29:59Z

Describe changes

I implemented changes that were left-over as a part of #2370.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

CLAassistant · 2025-02-24T01:30:05Z

All committers have signed the CLA.

coderabbitai · 2025-02-24T01:30:05Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

schustmi

There is one major part missing here still: When running/building a pipeline for which this config attribute is set, we actually need to use the temporary_active_stack context manager to switch the stack for the run/build.

This will be in PipelineDefinion.build(...) and PipelineDefinition._run(...).

schustmi · 2025-02-24T08:29:54Z

src/zenml/config/pipeline_run_configuration.py

@@ -46,6 +47,7 @@ class PipelineRunConfiguration(
    steps: Dict[str, StepConfigurationUpdate] = {}
    settings: Dict[str, SerializeAsAny[BaseSettings]] = {}
    tags: Optional[List[str]] = None
+    stack: Optional[Stack] = None


This should be an Optional[str] instead. The Stack object is not something that can be defined in a yaml file, which is usually how users specify attributes of this run configuration class. The value for stack will be the name or ID of a stack, which will then be passed to temporary_active_stack.

preyasshah9 · 2025-03-02T20:40:04Z

src/zenml/pipelines/pipeline_definition.py

-                pipeline_id=pipeline_id,
-                code_repository=code_repository,
-            )
+            with temporary_active_stack(stack_name_or_id=run_config.stack):


Read the value of stack from the PipelineRunConfiguration and if available use that within the temporary_active_stack context manager. Same below.

preyasshah9 · 2025-03-02T20:42:12Z

@schustmi Hi Michael,

Thank you for the feedback on PR. I have processed through code and tried to address your comment to best of my understanding. Let me know if this sounds good!
Let me know if this sounds good. If you have any pointers on how to test this change specifically, I would really appreciate this.

schustmi

One thing I forgot: Could you also add this logic to temporarily set a different stack on the PipelineDefinition.create_run_template method?

As for testing this:

The test should first register a second stack (should probably just be default local orchestrator/artifact store)
The active stack should be the default one
We then configure any pipeline (just a single-step, do nothing pipeline should be fine) to run on a different stack.
The above bullet point can be done either via a config file, or by passing it directly to test_pipeline.with_options(stack=...). These should probably be two different test cases.
It should then run the pipeline run = test_pipeline(), and check whether the run ran on the configured stack. assert run.stack.id == ...
We can then also check that the stack gets correctly reset to the previously active stack: assert Client().active_stack.id == ...

I think examples for most of these can be found in tests/unit/pipelines/test_base_pipeline.py (e.g. running a pipeline, configuring from a file). Let me know if I can help in any other way

schustmi · 2025-03-07T15:03:47Z

src/zenml/pipelines/pipeline_definition.py

-            local_repo = code_repository_utils.find_active_code_repository()
-            code_repository = build_utils.verify_local_repository_context(
-                deployment=deployment, local_repo_context=local_repo
+            _from_config_file = self._parse_config_file(


Not a huge fan of you having to do this manually before the compilation step in many places, but I also don't see any easy way around this. I'll refactor this (the entire config file logic is very messy right now) after this PR is merged.

preyasshah9 · 2025-03-10T02:43:15Z

PipelineDefinition.create_run_template

When create_run_template function is called, it is already within the context manager of temporary_active_stack:

zenml/src/zenml/cli/pipeline.py

Line 363 in 0d059d3

template = pipeline_instance.create_run_template(name=name)

I can also add a context manager but I believe this case is already handled.

schustmi · 2025-03-10T08:18:38Z

PipelineDefinition.create_run_template

When create_run_template function is called, it is already within the context manager of temporary_active_stack:

zenml/src/zenml/cli/pipeline.py

Line 363 in 0d059d3

template = pipeline_instance.create_run_template(name=name)

I can also add a context manager but I believe this case is already handled.

Yep, but that is only available when using the CLI to create a run template, but not when doing this from purely in code. I think the better solution would be to remove the context manager from the CLI function, and instead pass the --stack CLI option via the newly introduced PipelineRunConfiguration.stack attribute if set.

preyasshah9 · 2025-03-11T00:51:54Z

@schustmi Added some unit tests as per your comment. When I ran locally, I did not see issues related to the tests I added. I don't think unit tests are auto-executed by CI here. I executed tests on my branch using: bash scripts/test-coverage-xml.sh

preyasshah9 · 2025-03-17T03:28:57Z

PipelineDefinition.create_run_template

When create_run_template function is called, it is already within the context manager of temporary_active_stack:

zenml/src/zenml/cli/pipeline.py

Line 363 in 0d059d3

template = pipeline_instance.create_run_template(name=name)

I can also add a context manager but I believe this case is already handled.

Yep, but that is only available when using the CLI to create a run template, but not when doing this from purely in code. I think the better solution would be to remove the context manager from the CLI function, and instead pass the --stack CLI option via the newly introduced PipelineRunConfiguration.stack attribute if set.

One last question. I did pass the stack option to the pipeline_instance.with_options. However, passing it to the create_run_template, there are a couple of calls this function is making:

deployment = self._create_deployment(**self._run_args, skip_schedule_registration=True)
return Client().create_run_template(name=name, deployment_id=deployment.id, **kwargs)

Here the create_run_template, but it is not possible (or required) to patch the stack. Let me know if this needs to be updated.

However, _create_deployment seems an important place that uses stack option. This calls the _compile function which initializes the PipelineRunConfiguration. But there is no easier way to pass it outside of the configuration file. The options passed from parent functions are hidden, and the options from config file are not overridden.

zenml/src/zenml/pipelines/pipeline_definition.py

Line 1053 in 271076b

self._reconfigure_from_file_with_overrides(config_path=config_path)

.

Any suggestions?

preyasshah9 · 2025-03-25T01:12:18Z

@schustmi Friendly ping for the clarification :)

preyasshah9 mentioned this pull request Feb 24, 2025

Add Active Stack as part of configuration YAML #2261

Open

1 task

preyasshah9 force-pushed the active_stack_config_yaml branch from eb058fb to cede201 Compare February 24, 2025 02:52

schustmi requested changes Feb 24, 2025

View reviewed changes

preyasshah9 commented Mar 2, 2025

View reviewed changes

preyasshah9 requested a review from schustmi March 2, 2025 20:40

Pending Changes for Active Stack

0d059d3

preyasshah9 force-pushed the active_stack_config_yaml branch from 25a491e to 0d059d3 Compare March 2, 2025 20:50

schustmi requested changes Mar 7, 2025

View reviewed changes

preyasshah9 marked this pull request as ready for review March 10, 2025 02:43

Added Unit Test

60f7ef6

Linter Fixes

3f514a8

preyasshah9 requested a review from schustmi March 10, 2025 22:55

schustmi and others added 2 commits March 13, 2025 17:52

Merge branch 'develop' into active_stack_config_yaml

1e08efb

CLI removal from Pipeline

eee6818

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pending Changes for Active Stack #3372

Pending Changes for Active Stack #3372

preyasshah9 commented Feb 24, 2025 •

edited

Loading

CLAassistant commented Feb 24, 2025 •

edited

Loading

coderabbitai bot commented Feb 24, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

schustmi left a comment

schustmi Feb 24, 2025

preyasshah9 Mar 2, 2025

preyasshah9 commented Mar 2, 2025

schustmi left a comment

schustmi Mar 7, 2025 •

edited

Loading

preyasshah9 commented Mar 10, 2025

schustmi commented Mar 10, 2025

preyasshah9 commented Mar 11, 2025

preyasshah9 commented Mar 17, 2025 •

edited

Loading

preyasshah9 commented Mar 25, 2025

Pending Changes for Active Stack #3372

Are you sure you want to change the base?

Pending Changes for Active Stack #3372

Conversation

preyasshah9 commented Feb 24, 2025 • edited Loading

Describe changes

Pre-requisites

Types of changes

CLAassistant commented Feb 24, 2025 • edited Loading

coderabbitai bot commented Feb 24, 2025 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

schustmi left a comment

Choose a reason for hiding this comment

schustmi Feb 24, 2025

Choose a reason for hiding this comment

preyasshah9 Mar 2, 2025

Choose a reason for hiding this comment

preyasshah9 commented Mar 2, 2025

schustmi left a comment

Choose a reason for hiding this comment

schustmi Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

preyasshah9 commented Mar 10, 2025

schustmi commented Mar 10, 2025

preyasshah9 commented Mar 11, 2025

preyasshah9 commented Mar 17, 2025 • edited Loading

preyasshah9 commented Mar 25, 2025

preyasshah9 commented Feb 24, 2025 •

edited

Loading

CLAassistant commented Feb 24, 2025 •

edited

Loading

coderabbitai bot commented Feb 24, 2025 •

edited

Loading

schustmi Mar 7, 2025 •

edited

Loading

preyasshah9 commented Mar 17, 2025 •

edited

Loading