Model Registry docs #3778

tapadipti · 2022-07-19T05:22:44Z

Changes:

A new section Model Registry has been added within User Guide for Studio.
And some existing files have been updated to incorporate model registry information.

and some link fixes and redirect fixes

Co-authored-by: tapadipti <[email protected]>

per #3621 (comment)

Co-authored-by: Restyled.io <[email protected]>

…udio

Co-authored-by: Restyled.io <[email protected]>

redirects-list.json

content/docs/sidebar.json

content/docs/studio/get-started.md

jorgeorpinel · 2022-07-26T03:30:20Z

content/docs/studio/user-guide/prepare-your-repositories.md

+Iterative Studio creates [projects] by identifying machine learning models,
+datasets, metrics and hyperparameters defined in your Git repositories. These
+values are found in JSON or YAML files in the repository. Additionally, model
+information may be available as Git tags.


Follow up to #3778 (comment)

Suggested change

Iterative Studio creates [projects] by identifying machine learning models,

datasets, metrics and hyperparameters defined in your Git repositories. These

values are found in JSON or YAML files in the repository. Additionally, model

information may be available as Git tags.

Iterative Studio creates [projects] by identifying machine learning models,

datasets, metrics, and hyperparameters defined in your Git repositories. These

values are mainly found in JSON or YAML files in the repository. Additional

model information may also be available in Git tags.

content/docs/studio/user-guide/projects-and-experiments/explore-ml-experiments.md

jorgeorpinel

LGTM! 🚀 thanks for all the work @tapadipti 🙏🏼

There's some minor things unresolved from my previous review and couple more things in #3778 (review) and #3778 (review) above, but these don't block the merge.

Just fixing a link below...

content/docs/studio/user-guide/prepare-your-repositories.md

jorgeorpinel · 2022-07-26T03:37:13Z

src/@dvcorg/gatsby-theme-iterative/components/LayoutHeader/alert.tsx

+        New Release!{' '}
+        <Link href="https://dvc.org/blog/iterative-studio-model-registry">
+          Git-backed Machine Learning Model Registry


The link checker can't find this one but it's OK because it's in a different PR. Review app:

https://dvc-org-mr-blog-post-ztcaladh1.herokuapp.com/blog/iterative-studio-model-registry

content/docs/sidebar.json

Co-authored-by: Restyled.io <[email protected]>

jorgeorpinel

A few more items from a sanity check (of the review app). Some of these need your attention @tapadipti (see check boxes)

content/docs/studio/user-guide/model-registry/what-is-a-model-registry.md

jorgeorpinel · 2022-07-26T03:59:46Z

content/docs/studio/user-guide/model-registry/what-is-a-model-registry.md

+
+**_TODO: Replace the below with the MR release video_**
+
+https://www.youtube.com/watch?v=hKf4twg832g


Replace with the MR release video (I already removed the TODO line).

jorgeorpinel · 2022-07-26T04:00:54Z

content/docs/studio/user-guide/model-registry/add-a-model.md

+line tool, you can also add models from the [CLI][gto]. To add models using
+Iterative Studio, watch this tutorial video or read on below:
+
+https://youtu.be/szzv4ZXmYAs


Make video public (and I think the link should be https://www.youtube.com/watch?v=szzv4ZXmYAs)

jorgeorpinel · 2022-07-26T04:03:08Z

content/docs/studio/user-guide/model-registry/add-a-model.md

+     MLEM generates. After you have run `mlem init`, Iterative Studio will be
+     able to parse the `.mlem` file to extract model metadata.


Shoot, this is a problem... mlem init is linking to the dvc init ref...

I guess it's a docs engine bug (we should fix separately). For now this should do the trick (committing):

Suggested change

MLEM generates. After you have run `mlem init`, Iterative Studio will be

able to parse the `.mlem` file to extract model metadata.

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.

docs engine bug (we should fix separately)

Extracted to #3809

this should do the trick

Yep! It works now 👍🏼

jorgeorpinel · 2022-07-26T04:07:35Z

content/docs/studio/user-guide/model-registry/register-version.md

+register versions using Iterative Studio, watch this tutorial video or read on
+below:
+
+https://youtu.be/eA70puzOp1o


Make video public (and change link to https://www.youtube.com/watch?v=eA70puzOp1o ?)

jorgeorpinel · 2022-07-26T04:07:47Z

content/docs/studio/user-guide/model-registry/assign-stage.md

+You can assign stages using the [GTO] CLI. To assign stages using Iterative
+Studio, watch this tutorial video or read on below:
+
+https://youtu.be/Vrp1O5lkWBo


Make video public (and change link to https://www.youtube.com/watch?v=Vrp1O5lkWBo ?)

Co-authored-by: Restyled.io <[email protected]>

jorgeorpinel and others added 20 commits June 4, 2022 16:12

nav: clean up and rename files + remove UG index

2804073

studio: misc. edits

f2632bc

studio: redirects per sidebar changes

983beaa

nav: viz exps (Studio UG)

b38a94f

links: changes studio URLs

c997215

studio: remove how-it-works info from overview

6523ebf

Merge branch 'master' into nav/studio

f7cb138

Merge branch 'main' into nav/studio and

87cb4c5

and some link fixes and redirect fixes

Update content/docs/studio/user-guide/prepare-your-repositories.md

8eea458

Update content/docs/studio/get-started.md

ac16eea

Co-authored-by: tapadipti <[email protected]>

Update content/docs/studio/get-started.md

6da2aaf

Co-authored-by: tapadipti <[email protected]>

guide: better md ref link

e58b61d

per #3621 (comment)

Restyled by prettier (#3775)

184fe6a

Co-authored-by: Restyled.io <[email protected]>

guide: better titles for Change Team Plan and Size

7ce6eca

Merge branch 'nav/studio' of github.com:iterative/dvc.org into nav/st…

16d2db9

…udio

guide: GH App title

fad68e8

guide: Connect GL Server title

2a60ad1

Update content/docs/studio/user-guide/billing-and-payment.md

3d08d3e

Restyled by prettier (#3777)

a6c78b6

Co-authored-by: Restyled.io <[email protected]>

Draft of Model Registry docs

1cd6935

shcheklein temporarily deployed to dvc-org-mr-docs-metrhl925hnq6n July 19, 2022 05:23 Inactive

Deleted package-lock.json which was committed by mistake

9c0fc68

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 19, 2022 06:22 Inactive

Further work on MR docs

f64f209

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 19, 2022 07:49 Inactive

Removed unnecessary gifs

42ed930

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 19, 2022 12:22 Inactive

Further work on MR docs

6bbf5d9

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 19, 2022 12:54 Inactive

Further work on MR docs

f29f216

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

redirects-list.json Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

content/docs/sidebar.json Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

content/docs/studio/get-started.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

content/docs/studio/user-guide/projects-and-experiments/explore-ml-experiments.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

content/docs/studio/user-guide/projects-and-experiments/explore-ml-experiments.md Outdated Show resolved Hide resolved

Revert unrelated changes (wrong merge)

8f8298d

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 03:33 Inactive

Other small fixes

1b398c1

shcheklein had a problem deploying to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 03:35 Failure

jorgeorpinel approved these changes Jul 26, 2022

View reviewed changes

Update content/docs/studio/user-guide/prepare-your-repositories.md

3b70aad

shcheklein had a problem deploying to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 03:39 Failure

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

content/docs/sidebar.json Outdated Show resolved Hide resolved

Update content/docs/sidebar.json

19f9577

restyled-io bot mentioned this pull request Jul 26, 2022

Restyle Model Registry docs #3807

Merged

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 03:44 Inactive

Restyled by prettier (#3807)

4e7e5da

Co-authored-by: Restyled.io <[email protected]>

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 03:47 Inactive

jorgeorpinel reviewed Jul 26, 2022

View reviewed changes

Apply suggestions from code review

0091ac8

restyled-io bot mentioned this pull request Jul 26, 2022

Restyle Model Registry docs #3808

Merged

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 04:09 Inactive

jorgeorpinel mentioned this pull request Jul 26, 2022

link: mlem init links to dvc init #3809

Closed

Restyled by prettier (#3808)

a3ffb84

Co-authored-by: Restyled.io <[email protected]>

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 04:16 Inactive

Correct MR video links

6e1eb21

shcheklein temporarily deployed to dvc-org-mr-docs-ezydbpywaed4ti July 26, 2022 04:26 Inactive

tapadipti merged commit 74f2422 into main Jul 26, 2022

tapadipti deleted the mr-docs branch July 26, 2022 12:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Model Registry docs #3778

Model Registry docs #3778

tapadipti commented Jul 19, 2022 •

edited

Loading

jorgeorpinel Jul 26, 2022

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Jul 26, 2022

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022

jorgeorpinel Jul 26, 2022

jorgeorpinel Jul 26, 2022

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading


		_TODO: Replace the below with the MR release video_

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

		MLEM generates. After you have run `mlem init`, Iterative Studio will be
		able to parse the `.mlem` file to extract model metadata.

Model Registry docs #3778

Model Registry docs #3778

Conversation

tapadipti commented Jul 19, 2022 • edited Loading

jorgeorpinel Jul 26, 2022

Choose a reason for hiding this comment

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022

Choose a reason for hiding this comment

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022 • edited by tapadipti Loading

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022 • edited by tapadipti Loading

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022 • edited by tapadipti Loading

Choose a reason for hiding this comment

jorgeorpinel Jul 26, 2022 • edited by tapadipti Loading

Choose a reason for hiding this comment

tapadipti commented Jul 19, 2022 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading

jorgeorpinel Jul 26, 2022 •

edited by tapadipti

Loading