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: all the ways to use checkpoints #2432

Closed
dberenbaum opened this issue Apr 29, 2021 · 5 comments
Closed

guide: all the ways to use checkpoints #2432

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

Comments

@dberenbaum
Copy link
Contributor

As shown in https://github.com/iterative/dvc-checkpoints-mnist under "Switch between scenarios," there are multiple different ways to integrate checkpoints into a project:

  • Using dvclive
  • Using make_checkpoint
  • Using a manually created signal file
  • Only including checkpoints: true in dvc.yaml without any in-code checkpoints (but this seems like an unlikely scenario that might be unnecessary or useful just to show the basics of how checkpoints work - see Document checkpoints without make_checkpoint() #2292)

There is already a link in https://dvc.org/doc/user-guide/experiment-management to that example repo. Is this sufficient for now? Should the user guide provide more explanation rather than leave it in the readme of the example repo?

@jorgeorpinel jorgeorpinel changed the title User guide: all ways to use checkpoints guide: all the ways to use checkpoints Apr 30, 2021
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) 2.0 release labels Apr 30, 2021
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Apr 30, 2021

There is already a link in https://dvc.org/doc/user-guide/experiment-management to that example repo. Is this sufficient for now?

And soon #2373

I think it's sufficient for now. But ideally we should have an Experiments guide sub section with better separated pages (each shorter but covering more things as a whole), IMO.

p.s. basically #2269

@jorgeorpinel jorgeorpinel added content-dvc C: guide Content of /doc/user-guide and removed content-dvc-2.0 A: docs Area: user documentation (gatsby-theme-iterative) labels Oct 4, 2021
@jorgeorpinel
Copy link
Contributor

Should we merge this issue with #2769?

@iesahin
Copy link
Contributor

iesahin commented Oct 11, 2021

It looks #2769 itself is becoming too big to manage. In this issue, the goal was to demonstrate how to use (1) DVCLive, (2) Python API (make_checkpoint) and (3) Signal File. These three ways need a dedicated checkpoints guide.

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

Need to improve checkpoints in core before spending time improving docs.

@jorgeorpinel jorgeorpinel added the status: stale You've been groomed! label Jul 5, 2022
@jorgeorpinel

This comment was marked as off-topic.

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