Add save models to registry setting of a model to CLI methods

[avishniakov]

Describe changes

I added save models to registry setting of a model to CLI methods.

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

  • Introduced an option to control saving model artifacts to the registry directly from the CLI and client interfaces.

• Tests

  • Enhanced CLI tests with a new flag to save models to the registry.
  • Improved test coverage to verify the new save_models_to_registry attribute functionality under various scenarios.

[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 recent updates introduce a new feature allowing users to control whether model artifacts are saved to the registry. This is facilitated through the addition of a save_models_to_registry option in relevant functions and classes. The changes span across CLI functionalities, the client interface, and model management, including updates to integration tests to verify the new feature's behavior.

Changes

File(s)	Summary
src/zenml/cli/model.py, src/zenml/client.py	Introduced save_models_to_registry option in register_model and update_model functions to control saving of model artifacts to the registry. Updated _model_to_print to show save status.
src/zenml/models/v2/core/model.py	Added save_models_to_registry boolean attribute to the ModelUpdate class.
tests/integration/functional/cli/test_model.py	Added -s flag for saving models to the registry in CLI tests and updated tests for save_models_to_registry attribute behavior.

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.

[avishniakov]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 3

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 5ab2c47 and e752627.

Files selected for processing (4)

• src/zenml/cli/model.py (8 hunks)
• src/zenml/client.py (3 hunks)
• src/zenml/models/v2/core/model.py (1 hunks)
• tests/integration/functional/cli/test_model.py (6 hunks)

Additional comments: 9

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

• 108-108: The addition of the save_models_to_registry attribute to the ModelUpdate class is a welcome change that supports the new feature's functionality. Ensure that this attribute is well-documented in the user-facing documentation to clarify its usage and implications.

tests/integration/functional/cli/test_model.py (3)

• 62-69: > 📝 NOTE

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

The addition of the -s flag in CLI tests to verify the save_models_to_registry attribute's behavior is well-implemented. It's important to ensure that these tests cover a wide range of scenarios to fully validate the feature's functionality.

• 111-118: > 📝 NOTE

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

The test for explicitly setting --save-models-to-registry to false is a good practice to verify that the feature can be disabled as expected. This helps ensure that users have full control over their model registration behavior.

• 174-182: The update test that includes changing the save_models_to_registry attribute to false is crucial for ensuring that updates to existing models can correctly modify this setting. This test is well-placed and necessary for comprehensive coverage.

src/zenml/cli/model.py (2)

• 202-226: > 📝 NOTE

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

The handling of the save_models_to_registry parameter in the register_model function is correctly implemented. It's passed to the Client().create_model method after removing none values, which is a good practice to ensure that only provided values are sent to the backend. However, ensure that the backend (Client().create_model method) is prepared to handle this new parameter appropriately, including any necessary validation or default handling.

• 335-342: > 📝 NOTE

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

The handling of the save_models_to_registry parameter in the update_model function is consistent with the register_model function, which is good for maintaining code consistency. Again, ensure that the backend (Client().update_model method) is prepared to handle this new parameter appropriately. Additionally, it's important to verify that the update operation correctly applies this setting without unintended side effects on model artifacts already in the registry.

src/zenml/client.py (3)

• 4748-4748: The addition of the save_models_to_registry parameter to the update_model method allows for controlling whether models should be saved to the registry during updates. This aligns with the PR's objective to enhance model management capabilities.
• 4764-4765: The save_models_to_registry parameter is correctly added to the update_model method signature, enabling users to specify if model artifacts should be saved to the registry when updating models. This is a key feature introduced by the PR.
• 4785-4785: The inclusion of save_models_to_registry in the ModelUpdate class instantiation within the update_model method is crucial for implementing the new feature. It ensures that the user's choice regarding saving models to the registry is respected during model updates.

[strickvl]

LGTM, pending passing tests. You might also want to update the CLI docs with this option?

[avishniakov]

LGTM, pending passing tests. You might also want to update the CLI docs with this option?

Thanks, not really - this feature is not yet having any effect, just a placeholder, so I would not advertise it more than needed (and needed is - not at all 🙂 )