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: revisit Checkpoints guide(s?) #2769

Closed
3 of 13 tasks
Tracked by #2911
jorgeorpinel opened this issue Aug 31, 2021 · 8 comments
Closed
3 of 13 tasks
Tracked by #2911

guide: revisit Checkpoints guide(s?) #2769

jorgeorpinel opened this issue Aug 31, 2021 · 8 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide status: stale You've been groomed!

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 31, 2021

Per task in #2548

Trying to make it broader (more general) yet shorter, and cover all the usage details (extract from cmd ref) in a structured way.


Decide on these:

@daavoo
Copy link
Contributor

daavoo commented Sep 3, 2021

It might be worth adding a mention about how to properly Share Checkpoints with dvc exp push.

The current content finishes without sharing the checkpoints and the last section Adding checkpoints to git will squash the checkpoint commits making them not usable later.

We kind of already have the Sharing Experiments guide but it doesn't mention Checkpoints at all.

@iesahin

This comment has been minimized.

@daavoo
Copy link
Contributor

daavoo commented Sep 7, 2021

As new Checkpoint specific issues appear (#2797) I think it would make more sense to have a dedicated Checkpoints section on each individual Experiment guide (Running, Sharing, etc.), like https://dvc.org/doc/user-guide/experiment-management/running-experiments#checkpoint-experiments .

@iesahin
Copy link
Contributor

iesahin commented Sep 7, 2021

I think that's a good idea.

@jorgeorpinel
Copy link
Contributor Author

more sense to have a dedicated Checkpoints section on each individual Experiment guide (Running, Sharing, etc.)

Would probably need both its own guide and a small Checkpoints section in each Exps guide.

@daavoo
Copy link
Contributor

daavoo commented Oct 7, 2021

more sense to have a dedicated Checkpoints section on each individual Experiment guide (Running, Sharing, etc.)

Would probably need both its own guide and a small Checkpoints section in each Exps guide.

For the standalone checkpoints guide, I would recommend replacing the PyTorch code snippets with one of the frameworks that have a dvclive callback integration.

This would reduce the number of unrelated details that are in the current guide.

@jorgeorpinel
Copy link
Contributor Author

Should we merge this issue with #2432?

@iesahin iesahin added A: docs Area: user documentation (gatsby-theme-iterative) and removed dvc labels Oct 14, 2021
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Sep 22, 2022

@daavoo want to repurpose this to include checkpoint charing info for now? Per #2769 (comment)
BTW exp show tables or other code samples may need updating too?

Otherwise this looks stale (see #2432 (comment) and #2568 (comment)) and could be closed (updating the doc in question will be a natural result of updating the core feature anyway).

@jorgeorpinel jorgeorpinel added the status: stale You've been groomed! label Sep 22, 2022
@daavoo daavoo closed this as not planned Won't fix, can't repro, duplicate, stale May 1, 2023
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 status: stale You've been groomed!
Projects
None yet
Development

No branches or pull requests

3 participants