Update has_custom_name for legacy artifacts

[avishniakov]

Describe changes

I fixed the has_custom_name field for artifacts created before the introduction of Artifacts Versioning. For those no has_custom_name value was set during migration, and at the current point, it is not possible to identify which artifact should have the flag based on pure data, so the fix is updating the artifact, if has_custom_name diverges from what is given in the runtime.

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)

Summary by CodeRabbit

• New Features
  • Enhanced artifact management with the ability to specify and update custom names for artifacts.

[coderabbitai]

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.

Walkthrough

The updates involve adding functionality to handle artifacts with custom names in the ZenML framework. Specifically, these changes allow for the checking and updating of a custom name status for artifacts. This is achieved through modifications in utility functions, client methods, and schema conditions, ensuring that the system can recognize and process artifacts that have been assigned custom names.

Changes

File(s)	Change Summary
src/zenml/artifacts/utils.py, src/zenml/client.py	Added logic to handle custom name status for artifacts, including a new parameter in client method.
src/zenml/models/v2/core/artifact.py	Introduced an optional boolean field has_custom_name in ArtifactUpdate class.
src/zenml/zen_stores/schemas/artifact_schemas.py	Updated ArtifactSchema to conditionally handle the has_custom_name attribute.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

[strickvl]

@coderabbitai review

[strickvl]

No way to test this without triggering a migration, right?

Otherwise LGTM.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 67031c8 and 80150f5.

Files selected for processing (4)

• src/zenml/artifacts/utils.py (1 hunks)
• src/zenml/client.py (3 hunks)
• src/zenml/models/v2/core/artifact.py (1 hunks)
• src/zenml/zen_stores/schemas/artifact_schemas.py (1 hunks)

Additional comments: 4

src/zenml/models/v2/core/artifact.py (1)

• 58-58: The addition of the has_custom_name field to the ArtifactUpdate class is correctly implemented, following the optional field pattern with a default value of None. This allows for flexibility in updating artifacts, making it possible to specify or omit the custom name status during updates.

src/zenml/zen_stores/schemas/artifact_schemas.py (1)

• 146-147: The logic to update the has_custom_name attribute in the ArtifactSchema class based on the artifact_update parameter is correctly implemented. This ensures that the has_custom_name status can be dynamically updated, reflecting the current state accurately.

src/zenml/artifacts/utils.py (1)

• 192-195: The conditional check and update logic for the artifact's custom name status within the save_artifact function is correctly implemented. This ensures that if there's a discrepancy between the artifact's current has_custom_name status and the provided status, it will be updated accordingly. This is a crucial step for maintaining consistency in artifact metadata.

src/zenml/client.py (1)

• 2770-2776: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [2764-2783]

The addition of the has_custom_name parameter to the update_artifact method in client.py is a significant change. This parameter allows specifying whether the artifact has a custom name, which is crucial for handling legacy artifacts correctly after the introduction of Artifacts Versioning in ZenML. This change directly addresses the issue with the has_custom_name field for legacy artifacts, ensuring that the field is accurately set and updated according to runtime values. The implementation appears correct and aligns with the PR's objectives to fix the issue with legacy artifacts' has_custom_name field.

[avishniakov]

No way to test this without triggering a migration, right?

Otherwise LGTM.

I think I can write a test for it, let me try.