Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Use Cases: refactor #192

Open
2 of 6 tasks
aguschin opened this issue Oct 13, 2022 · 2 comments
Open
2 of 6 tasks

Use Cases: refactor #192

aguschin opened this issue Oct 13, 2022 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: use-cases Content of /doc/use-cases p1-important Active priorities to deal within next sprints

Comments

@aguschin
Copy link
Contributor

aguschin commented Oct 13, 2022

From discussion with @shcheklein. TLDR:

Overall, since the team is small and docs are big, we need to thing what we can throw away - it slows us down. We need to work on simple things and GS adoption instead of covering extra/corner scenarios in docs.

@aguschin aguschin added A: docs Area: user documentation (gatsby-theme-iterative) C: use-cases Content of /doc/use-cases labels Oct 13, 2022
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 19, 2022

use cases should high-level and answer to common scenarios users have in mind

Yup. Think problem/solution stories for ML team leads or even managers who don't want to see code or command line yet. We tend to use basic diagrams instead, and general language in the text (as little technical as possible).

From the existing pages:

  • Versioning MLEM objects with DVC: this is more of a general guide (DVC integration). Versioning itself is not really a use case of MLEM, I think.

  • Machine Learning Model Registry & Pure Mlem Model Registry: The former is a proper use case but non-MLEM specific. The latter could be somehow merged in (without all the instructions) so it belongs better in mlem.ai .

    We could even remove it from dvc.org at that point (it's a bit stretched to say that its a UC of DVC).

  • CI/CD for Machine Learning: the intro is good although I don't think this is really about CI/CD (more about distribution?) -- we can work on it 🙂

MR, Productionization, or Deployment to preview environments

I think def. productization is the highest priority one we should work on next, although maybe in parallel with doing some of the changes we've outlined above.

cover "five patterns to put the ML model in production

Sounds more like a blog post to me.

CI/CD should be moved to User Guide (probably)

Yes, for the bottom sections with instructions. Or maybe to a blog as well, since it's mostly about Github actions (we don't want to document 3rd party tools).

@jorgeorpinel jorgeorpinel added the p1-important Active priorities to deal within next sprints label Oct 19, 2022
@jorgeorpinel
Copy link
Contributor

Marking p1 since good UCs are expected to help drive traffic and adoption to the tool. Note that however I still think the GS is a higher priority atm.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: use-cases Content of /doc/use-cases p1-important Active priorities to deal within next sprints
Projects
None yet
Development

No branches or pull requests

2 participants