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: update experiments guide #4401

Closed
18 of 23 tasks
Tracked by #4513
dberenbaum opened this issue Mar 16, 2023 · 8 comments
Closed
18 of 23 tasks
Tracked by #4513

guide: update experiments guide #4401

dberenbaum opened this issue Mar 16, 2023 · 8 comments
Assignees
Labels
C: guide Content of /doc/user-guide p1-important Active priorities to deal within next sprints

Comments

@dberenbaum
Copy link
Collaborator

dberenbaum commented Mar 16, 2023

Report

Meta-issue to track changes needed for the exp guide:

@dberenbaum dberenbaum added p1-important Active priorities to deal within next sprints C: guide Content of /doc/user-guide labels Mar 16, 2023
@daavoo
Copy link
Contributor

daavoo commented Mar 17, 2023

Add page/section for params and metrics (close
#2572)
Add page/section for artifacts?

🤔 Does it need to be tied to the experiments guide?

At this point, I feel like those concepts are not really worth a user guide but rather a good reference (the user guide always ends ups being a reference anyhow) so maybe individual sections of #4381

Add page/section for advanced experiment configuration?

👍

Combined page for managing experiments (sharing/persisting/cleaning)?

👍

Drop checkpoints guide?

👍

@dberenbaum
Copy link
Collaborator Author

🤔 Does it need to be tied to the experiments guide?

At this point, I feel like those concepts are not really worth a user guide but rather a good reference (the user guide always ends ups being a reference anyhow) so maybe individual sections of #4381

For params and metrics, a page is probably too much, but I was thinking we should somewhere introduce the concept of how to do "advanced" params and metrics that don't use DVCLive. That could then point to the reference for details. WDYT?

For artifacts, I think it depends on what @aguschin is working on and how much we want to incorporate that into the experiments workflow.

@daavoo
Copy link
Contributor

daavoo commented Mar 23, 2023

I think it would be also nice to explicitly mention and link the run cache in the guide

@dberenbaum
Copy link
Collaborator Author

@daavoo Would you make it part of Explain why to use exp run -- pipelines, tuning, queuing, grid search or a separate item somewhere else?

@daavoo
Copy link
Contributor

daavoo commented Mar 23, 2023

@daavoo Would you make it part of Explain why to use exp run -- pipelines, tuning, queuing, grid search or a separate item somewhere else?

An item in that list would make sense

@dberenbaum
Copy link
Collaborator Author

Combined page for managing experiments (sharing/persisting/cleaning)?

@daavoo @omesser We have this in the get started now with https://dvc.org/doc/start/experiments/experiment-collaboration. What do you think we need in the guide? Should we frame it as "collaboration"? Or maybe something like "collaboration with git"? I think a lot of this is about showing how you can use experiments in your git workflows to do more than track and compare them. For example, you can apply/checkout, push/share, or do more advanced git workflows like branch/merge on top of other changes.

@dberenbaum
Copy link
Collaborator Author

* [x]  Add page/section for params and metrics (close [guide: Params, Plots and Metrics #2572](https://github.com/iterative/dvc.org/issues/2572))

* [x]  Add page/section for artifacts?

These are both at least somewhat addressed now in https://dvc.org/doc/user-guide/experiment-management.

@dberenbaum
Copy link
Collaborator Author

  • Add page/section for advanced experiment configuration?

I'd like to revisit this after looking at pipelines since it crosses both areas. Opened #4670.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: guide Content of /doc/user-guide p1-important Active priorities to deal within next sprints
Projects
No open projects
Archived in project
Development

No branches or pull requests

2 participants