-
Notifications
You must be signed in to change notification settings - Fork 394
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Using dvc.yaml
instead of artifacts.yaml
#4516
Merged
Merged
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
15d6827
initial updates
aguschin d919508
Merge branch 'main' into dvc-artifacts
aguschin 55ea764
fix some things
aguschin f0af502
Merge branch 'dvc-artifacts' of github.com:iterative/dvc.org into dvc…
aguschin bc88bb9
Apply suggestions from code review
aguschin ab725df
address feedback in pr
aguschin f8ec662
Merge branch 'main' into dvc-artifacts
aguschin b81a341
fixes from review
aguschin b3eb53b
Merge branch 'main' into dvc-artifacts
aguschin 5fb1501
Update content/docs/start/experiments/experiment-tracking.md
aguschin 38b86d0
Merge branch 'main' into dvc-artifacts
aguschin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Add a model | ||
|
||
You can add models from any ML project to the model registry. To add a model to | ||
your model registry, Iterative Studio creates an annotation for it in an | ||
`artifacts.yaml` file in your Git repository. If you are using the [GTO] command | ||
line tool, you can also add models [from the CLI][gto annotate]. To add models | ||
using Iterative Studio, watch this tutorial video or read on below: | ||
your model registry, Iterative Studio creates an annotation for it in a | ||
`dvc.yaml` file in your Git repository. If you are using the [GTO] command line | ||
tool, you can also add models [from the CLI][gto annotate]. To add models using | ||
Iterative Studio, watch this tutorial video or read on below: | ||
|
||
https://www.youtube.com/watch?v=szzv4ZXmYAs | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to update the video? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, we should. Added that to your comment. |
||
|
||
|
@@ -22,16 +22,10 @@ https://www.youtube.com/watch?v=szzv4ZXmYAs | |
|
||
3. Enter the path of the model file as follows: | ||
|
||
- If the model file is in the Git repository, enter the relative path of the | ||
model (from the repository root). | ||
- If the model file is in remote storage but is DVC-tracked, enter the | ||
project path of the corresponding `.dvc` file. | ||
- If the model file is in remote storage and is not DVC-tracked, enter the | ||
absolute path of the model file. | ||
- If you use [MLEM] to save your model, use the path to the binary file that | ||
MLEM generates. After you have run | ||
[`mlem init`](https://mlem.ai/doc/command-reference/init), Iterative Studio | ||
will be able to parse the `.mlem` file to extract model metadata. | ||
- If the model file is in the Git repository (including if it is saved with | ||
DVC and/or [MLEM]), enter the relative path of the model (from the | ||
repository root). | ||
- Otherwise, enter the URL to the model file in the cloud. | ||
|
||
If the path you entered is a cloud path, Iterative Studio will ask you for | ||
the repository path where the dvc reference to the model should be saved. | ||
|
@@ -54,22 +48,22 @@ https://www.youtube.com/watch?v=szzv4ZXmYAs | |
8. At this point, the new model appears in the models dashboard. | ||
|
||
9. In your Git repository, you will find that an entry for the new model has | ||
been created in the `artifacts.yaml` file in the repository's root. If you | ||
had committed to a new branch, a new pull request (or merge request in the | ||
case of GitLab) will also have been created to merge the new branch into the | ||
base branch. | ||
been created in the `dvc.yaml` file in the repository's root. If you had | ||
committed to a new branch, a new pull request (or merge request in the case | ||
of GitLab) will also have been created to merge the new branch into the base | ||
branch. | ||
10. If you had added a model from a cloud storage, the following will also | ||
happen before the commit is created: | ||
|
||
- If the repository does not contain DVC, Iterative Studio will run `dvc init`. | ||
It is needed to version the model in the git repository. | ||
[Learn more](/doc/command-reference/init). | ||
- If the specified directory does not exist yet, it will be created. | ||
- Iterative Studio will import the model to the repository by executing | ||
`dvc import-url <remote_path> <directory_path>/<filename from remote_path> --no-exec`. | ||
- Iterative Studio annotate the model by executing | ||
`gto annotate <model_name> --path <directory_path>/<filename from remote_path> --type model`. | ||
[Learn more][gto annotate]. | ||
- If the repository does not contain DVC, Iterative Studio will run | ||
`dvc init`. It is needed to version the model in the git repository. | ||
[Learn more](/doc/command-reference/init). | ||
- If the specified directory does not exist yet, it will be created. | ||
- Iterative Studio will import the model to the repository by executing | ||
`dvc import-url <remote_path> <directory_path>/<filename from remote_path> --no-exec`. | ||
- Iterative Studio annotate the model by executing | ||
`gto annotate <model_name> --path <directory_path>/<filename from remote_path> --type model`. | ||
[Learn more][gto annotate]. | ||
|
||
[connected repository]: | ||
/doc/studio/user-guide/projects-and-experiments/create-a-project | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's also add
log_artifact
to the examples in https://dvc.org/doc/dvclive/ml-frameworks.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will take a while since I'm not that familiar with each of them. Adding this to your comment, and let's do this in a follow-up PR.