Prune of unused artifacts links via client #2192

avishniakov · 2023-12-22T11:59:13Z

Describe changes

I implemented pruning of unused artifacts and their versions via Client to bring it in sync with CLI.

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 artifact cleanup tool to remove unused artifacts and their versions, helping maintain a clutter-free environment.
Tests
- Added new tests to ensure the artifact pruning functionality works as expected.

coderabbitai · 2023-12-22T11:59:18Z

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 ZenML library has introduced a new feature for artifact management. A method called prune_artifacts has been added, enabling the deletion of unused artifacts and their versions from the system. This includes the removal of associated metadata when necessary. Additionally, a new integration test ensures that this functionality works as expected. The update focuses on maintaining a clean and efficient artifact storage system.

Changes

File Path	Change Summary
`src/zenml/client.py`	Added `prune_artifacts` method for deleting unused artifacts.
`tests/.../test_client.py`	Added a new test class `TestArtifact` with a `test_prune` method.

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.

avishniakov · 2023-12-22T11:59:32Z

@coderabbitai review

coderabbitai

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 8c2e1cc and 895d9fd.

Files selected for processing (2)

src/zenml/client.py (1 hunks)
tests/integration/functional/test_client.py (2 hunks)

Additional comments: 1

tests/integration/functional/test_client.py (1)

30-30: Verify that the newly imported ExternalArtifact is used appropriately in the tests and that there are no unused imports.

src/zenml/client.py

tests/integration/functional/test_client.py

src/zenml/client.py

tests/integration/functional/test_client.py

…s-links-via-client

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

strickvl

LGTM, but two tiny nits to make it a bit more readable

tests/integration/functional/test_client.py

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

…s-links-via-client

stefannica

Just my usual performance related suggestions, but good to merge otherwise.

stefannica · 2024-01-08T12:03:02Z

src/zenml/client.py

+        for unused_artifact_version in unused_artifact_versions:
+            try:
+                self.delete_artifact_version(
+                    name_id_or_prefix=unused_artifact_version.id,
+                    delete_metadata=not only_artifact,
+                    delete_from_artifact_store=not only_metadata,
+                )
+                unused_artifact = unused_artifact_version.artifact
+                if not unused_artifact.versions and not only_artifact:
+                    self.delete_artifact(unused_artifact.id)


Similar to the PR where you implemented the "delete all model version artifacts", there is a performance hit with this type of loop that ends up calling the REST API multiple times. You should consider implementing this as a REST API endpoint and looping in the SQL zen store instead (perhaps even deleting entities en-masse through a single SQL query, if possible). This opens the possibility of using this functionality through the dashboard.

Hey, I'm half way through implementing this change, but stuck at the verify_permissions_and_delete_entity. It was rather clear what to check on single entry deletion, but here I prune Artifact, Artifact Version and Data at scale. Any thoughts? Shall I check for Admin permissions to do so?

I only have a half-baked idea about how to get around this: maybe we need a new prune permission that you check globally at server level, as opposed to checking against every resource. But that requires more work, not only here, but probably also at Cloud API level.

@schustmi what do you think ?

…s-links-via-client

prune artifacts in client

895d9fd

avishniakov requested review from strickvl and stefannica December 22, 2023 11:59

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

coderabbitai bot reviewed Dec 22, 2023

View reviewed changes

src/zenml/client.py Outdated Show resolved Hide resolved

tests/integration/functional/test_client.py Outdated Show resolved Hide resolved

strickvl requested changes Dec 22, 2023

View reviewed changes

src/zenml/client.py Outdated Show resolved Hide resolved

src/zenml/client.py Outdated Show resolved Hide resolved

tests/integration/functional/test_client.py Outdated Show resolved Hide resolved

avishniakov and others added 4 commits December 22, 2023 15:21

more tests

69fb821

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

f9ba6ca

…s-links-via-client

remove branching

1f604d4

Update src/zenml/client.py

ca11807

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

strickvl reviewed Dec 22, 2023

View reviewed changes

tests/integration/functional/test_client.py Outdated Show resolved Hide resolved

tests/integration/functional/test_client.py Outdated Show resolved Hide resolved

avishniakov and others added 3 commits December 22, 2023 15:48

Update tests/integration/functional/test_client.py

0b1c8ea

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update tests/integration/functional/test_client.py

133dd9f

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

nits

313f479

avishniakov requested a review from strickvl December 22, 2023 14:49

strickvl approved these changes Dec 22, 2023

View reviewed changes

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

6943853

…s-links-via-client

stefannica approved these changes Jan 8, 2024

View reviewed changes

strickvl and others added 9 commits January 8, 2024 20:28

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

1ccdc47

…s-links-via-client

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

b46b00d

…s-links-via-client

resolve branching

65c5e25

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

f0f2d37

…s-links-via-client

prune_artifact_versions in SQLStore

3d03d59

Merge branch 'develop' into feature/OSS-2718-prune-of-unused-artifact…

5d1538f

…s-links-via-client

lint

8d3cff5

wandb lint

a5dbf15

skip yamlfix on windows

64f93af

avishniakov merged commit f3a9838 into develop Jan 11, 2024
33 checks passed

avishniakov deleted the feature/OSS-2718-prune-of-unused-artifacts-links-via-client branch January 11, 2024 07:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prune of unused artifacts links via client #2192

Prune of unused artifacts links via client #2192

avishniakov commented Dec 22, 2023 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 22, 2023 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

avishniakov commented Dec 22, 2023

coderabbitai bot left a comment

strickvl left a comment

stefannica left a comment

stefannica Jan 8, 2024

avishniakov Jan 9, 2024

stefannica Jan 9, 2024

Prune of unused artifacts links via client #2192

Prune of unused artifacts links via client #2192

Conversation

avishniakov commented Dec 22, 2023 • edited by coderabbitai bot Loading

Describe changes

Pre-requisites

Types of changes

Summary by CodeRabbit

coderabbitai bot commented Dec 22, 2023 • edited Loading

Auto Review Skipped

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

avishniakov commented Dec 22, 2023

coderabbitai bot left a comment

Choose a reason for hiding this comment

strickvl left a comment

Choose a reason for hiding this comment

stefannica left a comment

Choose a reason for hiding this comment

stefannica Jan 8, 2024

Choose a reason for hiding this comment

avishniakov Jan 9, 2024

Choose a reason for hiding this comment

stefannica Jan 9, 2024

Choose a reason for hiding this comment

avishniakov commented Dec 22, 2023 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 22, 2023 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)