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.

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

Getting Started - Model registry and deployment #4841

Closed
tibor-mach opened this issue Sep 7, 2023 · 3 comments
Closed

Getting Started - Model registry and deployment #4841

tibor-mach opened this issue Sep 7, 2023 · 3 comments
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start p1-important Active priorities to deal within next sprints

Comments

@tibor-mach
Copy link
Contributor

Report

We have been discussing with @daavoo and also with @shcheklein that it might be a good idea to add the model registry and model deployment to the getting started guides in Docs as well.

On one hand, very little of that is actually about using DVC from a technical standpoint, it is mostly using DVC with other tools (the only thing DVC in the MR and in deployment is the artifacts entry in dvc.yaml).

On the other hand, I think that Getting started should take the users through an E2E MLOps pipeline and even if DVC is not used much in the latter stages, other tools from Iterative are (GTO, potentially CML). If we want to centralize "branding" around DVC, then I think it fits well and also it does not give an impression that we can only help with data management and experiment tracking.

I would try to do the getting started MR and deployment guide (guides?) as simples as possible, probably focused on DVCLive and a minimal usage of the CLI...these should be simple and easy to understand examples after all (and we could have more advanced ones under the User Guide part of the docs).

My plan is to first finish a DVCLive MR demo and then to adapt it to the getting started guide (via a generated repo) as well.

I will appreciate your comments on that @shcheklein @daavoo @dberenbaum @dmpetrov .

Related to #4789

@tibor-mach tibor-mach self-assigned this Sep 7, 2023
@dberenbaum
Copy link
Collaborator

Thanks for opening the issue @tibor-mach! Agree with your plan. Makes sense to me to do it in get started. Since we already have deployment in https://github.com/iterative/example-get-started-experiments/, do you think it makes sense to start with that? Or you think that is too complex and we need a simpler example?

@tibor-mach
Copy link
Contributor Author

@dberenbaum I think it makes sense to keep it all in that repo. I would use the notebook-based pipeline though and start the model registry tutorial at this tag.

That way, someone who is mostly interested in the MR capabilities can understand the repo faster and doesn't really need to understand dvc pipelines. I would just note in the tutorial that with pipelines the workflow is basically identical anyway.

I would show it with Studio first (by adding very short videos to the getting started docs, I guess), but also note that the GUI commands can be done with gto (they are all just one-liners so I don't think it complicates things too much).

@dberenbaum dberenbaum added p1-important Active priorities to deal within next sprints A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start labels Sep 8, 2023
@tibor-mach
Copy link
Contributor Author

This was resolved by #4883, closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start p1-important Active priorities to deal within next sprints
Projects
No open projects
Archived in project
Development

No branches or pull requests

2 participants