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

guide: Managing Experiments section(s) #816

Closed
dashohoxha opened this issue Nov 24, 2019 · 4 comments · Fixed by #2146
Closed

guide: Managing Experiments section(s) #816

dashohoxha opened this issue Nov 24, 2019 · 4 comments · Fixed by #2146
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@dashohoxha
Copy link
Contributor

dashohoxha commented Nov 24, 2019

UPDATE: Skip to #816 (comment)

Add a User Guide page that explains how to manage experiments:

Documenting first the existing methods may also help the discussions about adding new methods for experiment management (iterative/dvc#2799), because my impression is that most of what is being discussed there can already be accomplished with the existing tools.

Another related issue: #159

@dashohoxha dashohoxha added A: docs Area: user documentation (gatsby-theme-iterative) user-guide labels Nov 24, 2019
@dashohoxha dashohoxha self-assigned this Nov 24, 2019
@shcheklein shcheklein changed the title user-guide: add a page for Managing Experiments add a page for Managing Experiments Nov 24, 2019
@dashohoxha
Copy link
Contributor Author

dashohoxha commented Nov 29, 2019

I started the PR #828 to close this issue, but actually I don't have a very clear idea about how to best explain it, so I would appreciate some help from the @iterative/engineering team.

The first two cases are almost clear, and also there are some examples in the Get Started and the Tutorials, which might be summarized on these pages.

For the case of managing experiments by directories, there is a very simple example at the end of this interactive tutorial: https://katacoda.com/dvc/courses/basics/pipelines
But it does not look like a realistic example. You have much more experience than me with DVC and with helping users to use it in their ML scenarios. If you know some more realistic example (or you can make up one), please let me know.

The last case, where we can mix different kinds of experiment management techniques, is even more difficult for me. Conceptually I know how it should work, but it is not so easy to come up with a convincing example, which is both simple and looks kind of realistic. I have no experience with ML, so it is too difficult for me to make up something. If you can think up something suitable please let me know.

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions and removed user-guide labels Jan 19, 2020
@jorgeorpinel jorgeorpinel changed the title add a page for Managing Experiments user-guide: add a page for Managing Experiments Jan 20, 2020
@jorgeorpinel jorgeorpinel changed the title user-guide: add a page for Managing Experiments how to: add a page for Managing Experiments Jan 20, 2020
@jorgeorpinel

This comment has been minimized.

@shcheklein
Copy link
Member

I think the original intention was more or less correct in this ticket - User Guide page like this makes sense to me.

@jorgeorpinel jorgeorpinel changed the title how to: add a page for Managing Experiments new: Managing Experiments sections Nov 21, 2020
@jorgeorpinel jorgeorpinel changed the title new: Managing Experiments sections new: Managing Experiments section Nov 21, 2020
@jorgeorpinel
Copy link
Contributor

OK but in #72 (comment) you said

section like Managing Experiments should be within Get started, Use Cases, and User Guide at the top level

but I guess it depends on what/how much content we will have for this topic. Could be in UG at first.

@jorgeorpinel jorgeorpinel mentioned this issue Feb 3, 2021
12 tasks
@jorgeorpinel jorgeorpinel changed the title new: Managing Experiments section guide: Managing Experiments section(s) Feb 3, 2021
@iesahin iesahin added the C: guide Content of /doc/user-guide label Oct 21, 2021
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: guide Content of /doc/user-guide type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
4 participants