Model links lazy evaluation in pipeline code #2205

avishniakov · 2023-12-28T11:15:10Z

Describe changes

I implemented the ability to do lazy loading of Artifact Version, Artifact Version Metadata, and Model Version Metadata inside the pipeline body. The following syntax will evaluate objects only during pipeline execution (before it was fixed on pipeline compilation):

    @pipeline(model_version=ModelVersion(name=model_name),...)
    def my_pipe():
        model_version = get_pipeline_context().model_version
        artifact = model_version.get_artifact("artifact_name")
        artifact_metadata = artifact.run_metadata["metadata_key"]
        model_metadata = model_version.run_metadata["metadata_key2"]
        my_step(artifact, artifact_metadata, model_metadata)

Side changes:

log_model_version_metadata is now listed on root level (from zenml import log_model_version_metadata)

Side breaking change:

Unified metdata and run_metadata across Artifact and Model Versions:ModelVersion().metadata becomes ModelVersion().run_metadata

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
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.
If my changes require changes to the dashboard, these changes are communicated/requested.

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)

review-notebook-app · 2023-12-28T11:15:16Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

coderabbitai · 2023-12-28T11:15:16Z

Important

Auto 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.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
- Generate unit-tests for this file.
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 tests 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 generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

…ion-in-pipeline-code

github-actions · 2023-12-28T15:24:59Z

E2E template updates in examples/e2e have been pushed.

…ion-in-pipeline-code

.github/workflows/update-templates-to-examples.yml

src/zenml/config/pipeline_configurations.py

src/zenml/lazy_load/model_version.py

src/zenml/lazy_load/run_metadata.py

src/zenml/models/v2/base/internal.py

tests/integration/functional/pipelines/test_pipeline_context.py

Co-authored-by: Alex Strick van Linschoten <[email protected]>

…e-code' of https://github.com/zenml-io/zenml into feature/OSS-2713-model-links-lazy-evaluation-in-pipeline-code

…ion-in-pipeline-code

strickvl

🙏🏻

src/zenml/new/pipelines/pipeline_context.py

src/zenml/steps/base_step.py

src/zenml/orchestrators/input_utils.py

src/zenml/config/pipeline_configurations.py

schustmi · 2024-01-12T14:05:57Z

src/zenml/metadata/lazy_load.py

+        from zenml.models import RunMetadataResponse
+
+        return RunMetadataResponse(
+            id=uuid4(),


As you already pointed out in the PR description, not a huge fan of this. I don't think we can easily remove that from the BaseResponse class (for our actual responses, we do always want the ID to be in there). There's also a problem when users in their pipeline function try to access any properties of the lazy responses, they will get random values or strange error messages.

At least the error messages we could prevent by maybe having a separate subclass for it, but not convinced this is a good idea..

class LazyArtifactVersionResponse(ArtifactVersionResponse): _lazy_load_name: Optional[str] = None _lazy_load_version: Optional[str] = None _lazy_load_model_version: Optional["ModelVersion"] = None # We should probably do this for all properties, otherwise users will run into strange error message when they # try to access any of those on a lazy object @property def id(self) -> UUID: raise RuntimeError("ID can't be accessed for lazy AVR") ...

Actually instead of overwriting all properties, we probably only need to overwrite the get_body() and get_metadata() functions to raise errors which describe the issue.

Super, thanks!

avishniakov · 2024-01-12T14:59:02Z

Thanks a lot @schustmi - a golden review 👍🏼 You solved all design issues with one shot. Please read it again once CI passes.

stefannica

I agree to the overall solution of passing references to model versions and artifacts at pipeline compilation time and deferring their resolution at pipeline execution time. I can't say I fully understand all the implications of this, given that I'm not familiar with this area of code. Good to go from my end.

…ion-in-pipeline-code

* MV data lazy loading in pipelines * add tests * new template ref * use `BaseModel` * Auto-update of Starter template * update to `v7` syntax * update test signatures * Auto-update of E2E template * update test signatures * wandb lint * lint * remove leftover * Apply suggestions from code review Co-authored-by: Alex Strick van Linschoten <[email protected]> * renaming * model lazy load in `model` * metadata lazy load in `metadata` * implement Michael's suggestions --------- Co-authored-by: GitHub Actions <[email protected]> Co-authored-by: Alex Strick van Linschoten <[email protected]>

avishniakov added 2 commits December 28, 2023 12:12

MV data lazy loading in pipelines

a9507df

add tests

b0d288e

avishniakov changed the base branch from main to develop December 28, 2023 11:15

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Dec 28, 2023

avishniakov and others added 5 commits December 28, 2023 12:16

new template ref

b3250c4

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

f37c039

…ion-in-pipeline-code

use BaseModel

6b36164

Auto-update of Starter template

58b092c

update to v7 syntax

820d80b

avishniakov marked this pull request as ready for review December 28, 2023 12:25

avishniakov and others added 2 commits December 28, 2023 16:05

update test signatures

78cea79

Auto-update of E2E template

41acb73

update test signatures

a819949

htahir1 requested a review from schustmi January 3, 2024 08:41

avishniakov added 6 commits January 9, 2024 15:43

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

4d88dad

…ion-in-pipeline-code

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

1044410

…ion-in-pipeline-code

wandb lint

81ad088

lint

9fb0412

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

873a6e1

…ion-in-pipeline-code

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

0f737f9

…ion-in-pipeline-code

avishniakov requested a review from strickvl January 11, 2024 13:06

strickvl requested changes Jan 11, 2024

View reviewed changes

avishniakov and others added 4 commits January 11, 2024 16:40

remove leftover

963d27c

Apply suggestions from code review

bc3da8b

Co-authored-by: Alex Strick van Linschoten <[email protected]>

Merge branch 'feature/OSS-2713-model-links-lazy-evaluation-in-pipelin…

95e6e46

…e-code' of https://github.com/zenml-io/zenml into feature/OSS-2713-model-links-lazy-evaluation-in-pipeline-code

renaming

e4870dc

avishniakov added 3 commits January 11, 2024 16:56

model lazy load in model

551ef4e

metadata lazy load in metadata

394977f

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

7b6307e

…ion-in-pipeline-code

avishniakov requested a review from strickvl January 12, 2024 06:38

strickvl approved these changes Jan 12, 2024

View reviewed changes

schustmi requested changes Jan 12, 2024

View reviewed changes

implement Michael's suggestions

919b14b

avishniakov requested a review from schustmi January 12, 2024 14:58

strickvl requested a review from stefannica January 15, 2024 08:15

stefannica approved these changes Jan 17, 2024

View reviewed changes

schustmi approved these changes Jan 17, 2024

View reviewed changes

Merge branch 'develop' into feature/OSS-2713-model-links-lazy-evaluat…

d098bd2

…ion-in-pipeline-code

avishniakov merged commit 7453864 into develop Jan 17, 2024
6 of 25 checks passed

avishniakov deleted the feature/OSS-2713-model-links-lazy-evaluation-in-pipeline-code branch January 17, 2024 13:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Model links lazy evaluation in pipeline code #2205

Model links lazy evaluation in pipeline code #2205

avishniakov commented Dec 28, 2023 •

edited

Loading

review-notebook-app bot commented Dec 28, 2023

coderabbitai bot commented Dec 28, 2023 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

github-actions bot commented Dec 28, 2023

strickvl left a comment

schustmi Jan 12, 2024

schustmi Jan 12, 2024

avishniakov Jan 12, 2024

avishniakov commented Jan 12, 2024

stefannica left a comment

Model links lazy evaluation in pipeline code #2205

Model links lazy evaluation in pipeline code #2205

Conversation

avishniakov commented Dec 28, 2023 • edited Loading

Describe changes

Pre-requisites

Types of changes

review-notebook-app bot commented Dec 28, 2023

coderabbitai bot commented Dec 28, 2023 • edited Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

github-actions bot commented Dec 28, 2023

strickvl left a comment

Choose a reason for hiding this comment

schustmi Jan 12, 2024

Choose a reason for hiding this comment

schustmi Jan 12, 2024

Choose a reason for hiding this comment

avishniakov Jan 12, 2024

Choose a reason for hiding this comment

avishniakov commented Jan 12, 2024

stefannica left a comment

Choose a reason for hiding this comment

avishniakov commented Dec 28, 2023 •

edited

Loading

coderabbitai bot commented Dec 28, 2023 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)