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

[doc] Add documentation around trial/experiment checkpoint. #28303

Merged
merged 9 commits into from
Sep 21, 2022

Conversation

xwjiang2010
Copy link
Contributor

@xwjiang2010 xwjiang2010 commented Sep 6, 2022

As this has been a continuous confustion for both OSS and product.

Signed-off-by: xwjiang2010 xwjiang2010@gmail.com

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

As this has been a continuous confustion for both OSS and product.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Copy link
Member

@Yard1 Yard1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! One nit

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@krfricke krfricke self-assigned this Sep 16, 2022
Signed-off-by: Kai Fricke <kai@anyscale.com>
Copy link
Contributor

@krfricke krfricke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated with wording, please someone else also take a look after my changes!

doc/source/tune/tutorials/tune-checkpoints.rst Outdated Show resolved Hide resolved
can be resumed from if it is interrupted or failed.
It can also be used to analysis tuning results after a Ray Tune finished.

Trial-level checkpoints capture the per-trial state. They are saved by the trainable itself.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention anything about syncing to the driver here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a big section "Checkpointing and synchronization" right below this section, so I think it should be fine.

krfricke and others added 3 commits September 16, 2022 19:19
Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
@amogkam amogkam merged commit 014279b into ray-project:master Sep 21, 2022
@xwjiang2010 xwjiang2010 deleted the ckpt branch July 26, 2023 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants