Skip to content
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.

Sign up for GitHub

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

model registry guide follow ups #4561

Merged
merged 4 commits into from
May 23, 2023
Merged

model registry guide follow ups #4561

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0848849
model registry guide follow ups
May 22, 2023
13838b0
Merge branch 'main' into mr-fixes
May 22, 2023
588c58d
update images used, add a note about metrics and params on mdp
aguschin May 23, 2023
63829b9
Merge branch 'main' into mr-fixes
aguschin May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion content/docs/studio/user-guide/model-registry/add-a-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ your model registry, Iterative Studio creates an annotation for it in a
following ways:

1. Log your model during the training process using [dvclive].
2. Edit `dvc.yaml` directly.
2. Edit [`dvc.yaml`](/doc/user-guide/project-structure/dvcyaml-files#artifacts)
directly.
3. Use the Iterative Studio interface (watch this tutorial video or read on
below).

Expand Down
21 changes: 12 additions & 9 deletions content/docs/studio/user-guide/model-registry/assign-stage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ You can write CI/CD actions that can actually deploy the models to the different
deployment environments upon the creation of a new Git tag for stage assignment.
For that, you can leverage any ML model deployment tool, such as MLEM.

You can assign stages using the [`gto` CLI]. To assign stages using Iterative
Studio, watch this tutorial video or read on below:
To assign stages using Iterative Studio, watch this tutorial video or read on
below:

https://www.youtube.com/watch?v=Vrp1O5lkWBo

Expand Down Expand Up @@ -43,13 +43,16 @@ https://www.youtube.com/watch?v=Vrp1O5lkWBo

4. Optionally, provide a Git tag message.
5. Click on `Assign stage`.
6. Once the action is successful, the stage assignment will show up in the
`Stages` column of the models dashboard.
7. If you open the model details page, the stage assignment will be visible in
the model `History` section as well as in the `Stages` section.
8. If you go to your Git repository, you will see that a new Git tag referencing
the selected version and stage has been created, indicating the stage
assignment.

Once the action is successful, the stage assignment will show up in the `Stages`
column of the models dashboard.

If you open the model details page, the stage assignment will be visible in the
model `History` section as well as in the `Stages` section.

If you go to your Git repository, you will see that a new Git tag referencing
the selected version and stage has been created, indicating the stage
assignment.

[gto]: https://mlem.ai/doc/gto
[git tag]: https://git-scm.com/docs/git-tag
Expand Down
28 changes: 15 additions & 13 deletions content/docs/studio/user-guide/model-registry/register-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ To register a new version of a model, Iterative Studio uses [GTO] to create an
annotated [Git tag][git tag] with the specified version number. Refer to the
[GTO docs][gto-format] to see the exact format of the Git tag.

You can register versions using the [`gto` CLI]. To register versions using
Iterative Studio, watch this tutorial video or read on below:
To register versions using Iterative Studio, watch this tutorial video or read
on below:

https://www.youtube.com/watch?v=eA70puzOp1o

Expand All @@ -31,17 +31,19 @@ https://www.youtube.com/watch?v=eA70puzOp1o

4. Optionally, provide a Git tag message.
5. Click on `Register version`.
6. Once the action is successful, the newly registered version will show up in
the `Latest version` column of the models dashboard. Note that this will
happen only if the newly registered version is the greatest semantic version
for your model. For example, if your model already had v3.0.0 registered,
then if you register a smaller version (e.g., v2.0.0), then the new version
will not appear in the `Latest version` column.
7. If you open the model details page, the newly registered version will be
available in the model `History` section as well as in the versions drop
down.
8. If you go to your Git repository, you will see that a new Git tag referencing
the selected commit has been created, representing the new version.

Once the action is successful, the newly registered version will show up in the
`Latest version` column of the models dashboard. Note that this will happen only
if the newly registered version is the greatest semantic version for your model.
For example, if your model already had v3.0.0 registered, then if you register a
smaller version (e.g., v2.0.0), then the new version will not appear in the
`Latest version` column.

If you open the model details page, the newly registered version will be
available in the model `History` section as well as in the versions drop down.

If you go to your Git repository, you will see that a new Git tag referencing
the selected commit has been created, representing the new version.

[gto]: https://mlem.ai/doc/gto
[git tag]: https://git-scm.com/docs/git-tag
Expand Down