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

Add a "Use Cases" page to the Kubeflow docs #1596

Closed
sarahmaddox opened this issue Feb 3, 2020 · 5 comments · Fixed by #1644
Closed

Add a "Use Cases" page to the Kubeflow docs #1596

sarahmaddox opened this issue Feb 3, 2020 · 5 comments · Fixed by #1644
Assignees
Labels
doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature

Comments

@sarahmaddox
Copy link
Contributor

From the January user survey, this is the type of information people expect to see in a "Use Cases" section of the docs:

Why/when to use Kubeflow - this is the purpose of a doc that describes use cases. The doc helps people decide whether Kubeflow is the right solution for their ML workload.

Use cases to list - these are the use cases that Kubeflow enables. For each use case, we should provide a short description of (a) what we mean by this particular use case, and (b) how Kubeflow enables the use case, and a link to a relevant doc within the doc set:

  • Deploying and managing a complex ML system at scale
  • Experimentation with training an ML model
  • Setting up a platform for ML applications
  • Tuning the model hyperparameters during training,
  • Data versioning
  • CI/CD for ML
  • End to end hybrid and multi-clouds ML workloads

Note: This issue is a follow-on from issue #1422, which described how the existing use cases section was much visited, but people were not finding what they needed in that section. We therefore deleted the section. We now want to replace it with a single page, as described above.

Suggested location for the page: A new page in the About section.

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the labels:

Label Probability
kind/feature 0.91

Please mark this comment with 👍 or 👎 to give our bot feedback!
Links: app homepage, dashboard and code for this bot.

@sarahmaddox sarahmaddox added the doc-sprint Issues to work on during the Kubeflow Doc Sprint label Feb 3, 2020
@sarahmaddox
Copy link
Contributor Author

/cc @theadactyl

@jbottum
Copy link
Contributor

jbottum commented Feb 10, 2020

@sarahmaddox I will start to work on some content for this

@elviraux elviraux self-assigned this Feb 10, 2020
@sarahmaddox
Copy link
Contributor Author

Thanks @jbottum - @elviraux is working on this one too. The two of you should chat. I'm looking forward to seeing this page as it's high-value to Kubeflow users, especially people exploring and evaluating Kubeflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants