Dynamic (templated) names for model versions #2909

avishniakov · 2024-08-06T14:28:12Z

Describe changes

This PR gives the ability to name Model Versions using {date} and {time} placeholders to use for automated runs with meaningful naming or for scheduling purposes.
Model(version="my_model_version_{date}_{time}",...) will be translated into a meaningful name upon pipeline execution.

This PR also has some minor improvements/refactors to ensure that the Model Version is created at a proper time and uses the time of the run as a filler.

Results of testing in Pro:

Display of ModelVersions associated with Runs is partially working: visible in Pipeline Run, not visible in the Step Run. My best guess: is that the code is relying on the config states, which are not the valid source of truth in the templated world anymore, so we would need a change here. Data is available in the respective resources of the Run Responses.
Scheduling with templated names works as expected.
Side bug: none of my AWS resources were connected to a connector after creating via UI, something to look into separately.

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)

coderabbitai · 2024-08-06T14:28:17Z

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.

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 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

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.

avishniakov · 2024-08-06T14:29:25Z

@coderabbitai review

…ersions

coderabbitai · 2024-08-06T14:29:30Z

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

…ersions

schustmi

I tried to review this but I feel I lack the understanding how the whole model linkage to pipeline/step runs is supposed to work. @avishniakov can you maybe explain that before I continue?

I can configure a pipeline/step to be associated with a certain model by putting it in the decorator/config file
These will be linked to my pipeline run/step run
Are there other ways that we link models and pipeline/step runs?

src/zenml/orchestrators/base_orchestrator.py

src/zenml/models/v2/core/model_version.py

src/zenml/orchestrators/step_launcher.py

src/zenml/models/v2/core/pipeline_run.py

src/zenml/new/pipelines/pipeline.py

src/zenml/new/steps/step_context.py

avishniakov · 2024-08-22T11:54:46Z

I tried to review this but I feel I lack the understanding how the whole model linkage to pipeline/step runs is supposed to work. @avishniakov can you maybe explain that before I continue?

I can configure a pipeline/step to be associated with a certain model by putting it in the decorator/config file

These will be linked to my pipeline run/step run

Are there other ways that we link models and pipeline/step runs?

You nailed it!

If you put it in one of the decos - it will be associated with the corresponding run (and also linked to a pipeline run - this is still a separate entity). With these changes, theoretically, it should be possible to sunset the pipeline run model version links table (to be validated and realigned with the model).

If you put model definitions elsewhere, e.g. in step codes - no link will be created. This is by design as of now. Subject to change though, while it might make sense not only to track the links, but also to keep track of link flavor (read, write, own, etc.).

bcdurak

Adding a few more comments on top of Michael's review.

src/zenml/integrations/gcp/orchestrators/vertex_orchestrator.py

src/zenml/orchestrators/base_orchestrator.py

src/zenml/models/v2/core/pipeline_run.py

…ersions

avishniakov · 2024-08-26T14:23:27Z

CI is not progressing much now, but can you re-review please?

schustmi

Nice, it already seems much less complex now! Just left a few more small suggestions but for the most part looks good

src/zenml/model/model.py

src/zenml/new/steps/step_context.py

src/zenml/zen_stores/schemas/pipeline_run_schemas.py

src/zenml/new/pipelines/pipeline.py

src/zenml/zen_stores/schemas/pipeline_run_schemas.py

src/zenml/zen_stores/schemas/step_run_schemas.py

src/zenml/new/pipelines/pipeline.py

avishniakov added 3 commits August 5, 2024 15:44

util method

737046b

avoid double dot

0a868c7

MV names with template support

cf71425

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Aug 6, 2024

avishniakov changed the title ~~Feature/prd 539 dynamic names for model versions~~ Dynamic (templated) names for model versions Aug 6, 2024

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

50d3da9

…ersions

avishniakov marked this pull request as ready for review August 6, 2024 14:29

avishniakov marked this pull request as draft August 6, 2024 14:30

avishniakov added 2 commits August 8, 2024 13:46

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

ab98623

…ersions

templated model version with tracing

1d5876f

avishniakov changed the title ~~Dynamic (templated) names for model versions~~ [WIP] Dynamic (templated) names for model versions Aug 8, 2024

avishniakov marked this pull request as ready for review August 8, 2024 12:58

avishniakov and others added 8 commits August 8, 2024 15:20

UTC -> timezone.utc

63c0018

fix ongoing issues + add test

d61c19c

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

967c881

…ersions

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

e451477

…ersions

resolve branching

02a8f6c

lint

6a7b111

restore previous behavior and fix tests

a7a507a

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

0383e34

…ersions

avishniakov requested review from schustmi and bcdurak and removed request for schustmi August 9, 2024 09:19

avishniakov added 2 commits August 9, 2024 14:13

fail on conflict of YAML and code pipe config

1ebd20a

revert

ba50fdb

schustmi requested changes Aug 22, 2024

View reviewed changes

remove redundant lc

6f97758

bcdurak requested changes Aug 26, 2024

View reviewed changes

avishniakov removed the run-slow-ci label Aug 26, 2024

avishniakov added 9 commits August 26, 2024 12:13

remove redundant warm-ups

703ff39

fix descs

d12a8a4

fix for cached steps

0ea1d27

Merge branch 'develop' into feature/PRD-539-dynamic-names-for-model-v…

3abbf8c

…ersions

fix introduced caching issues

8e4a021

typos

1150f77

is_schedulable prop

a44464a

move to is_schedulable

28ddf94

fix artifact config linkage on cached

f3c7443

avishniakov requested review from schustmi and bcdurak August 26, 2024 14:22

schustmi requested changes Aug 26, 2024

View reviewed changes

src/zenml/model/model.py Show resolved Hide resolved

src/zenml/new/steps/step_context.py Outdated Show resolved Hide resolved

src/zenml/zen_stores/schemas/pipeline_run_schemas.py Outdated Show resolved Hide resolved

schustmi requested changes Aug 26, 2024

View reviewed changes

src/zenml/new/pipelines/pipeline.py Show resolved Hide resolved

avishniakov added 3 commits August 27, 2024 08:17

simplify

cadf3ee

rename

914a776

bugfix

0152dc4

schustmi requested changes Aug 27, 2024

View reviewed changes

src/zenml/zen_stores/schemas/pipeline_run_schemas.py Outdated Show resolved Hide resolved

src/zenml/zen_stores/schemas/step_run_schemas.py Outdated Show resolved Hide resolved

src/zenml/new/pipelines/pipeline.py Show resolved Hide resolved

rename

feb6028

avishniakov added the run-slow-ci label Aug 27, 2024

avishniakov requested a review from schustmi August 27, 2024 11:48

schustmi approved these changes Aug 27, 2024

View reviewed changes

bcdurak approved these changes Aug 27, 2024

View reviewed changes

avishniakov merged commit 6b012b2 into develop Aug 27, 2024
80 checks passed

avishniakov deleted the feature/PRD-539-dynamic-names-for-model-versions branch August 27, 2024 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dynamic (templated) names for model versions #2909

Dynamic (templated) names for model versions #2909

avishniakov commented Aug 6, 2024 •

edited

Loading

coderabbitai bot commented Aug 6, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

avishniakov commented Aug 6, 2024

coderabbitai bot commented Aug 6, 2024

schustmi left a comment

avishniakov commented Aug 22, 2024

bcdurak left a comment

avishniakov commented Aug 26, 2024

schustmi left a comment

Dynamic (templated) names for model versions #2909

Dynamic (templated) names for model versions #2909

Conversation

avishniakov commented Aug 6, 2024 • edited Loading

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Aug 6, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

avishniakov commented Aug 6, 2024

coderabbitai bot commented Aug 6, 2024

schustmi left a comment

Choose a reason for hiding this comment

avishniakov commented Aug 22, 2024

bcdurak left a comment

Choose a reason for hiding this comment

avishniakov commented Aug 26, 2024

schustmi left a comment

Choose a reason for hiding this comment

avishniakov commented Aug 6, 2024 •

edited

Loading

coderabbitai bot commented Aug 6, 2024 •

edited

Loading