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

[train][doc] Configuring persistent storage user guide #39428

Merged
merged 15 commits into from
Sep 9, 2023

Conversation

justinvyu
Copy link
Contributor

Why are these changes needed?

This PR updates the persistent storage user guide to reflect the improvements in 2.7.

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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
matthewdeng and others added 3 commits September 7, 2023 20:48
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
doc/source/train/user-guides/persistent-storage.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/persistent-storage.rst Outdated Show resolved Hide resolved

If you save checkpoints with :meth:`ray.train.report(..., checkpoint=...) <ray.train.report>`
and run on a multi-node cluster, Ray Train will raise an error if NFS or cloud storage is not setup.
This is because Ray Train expects all workers to be able to write the checkpoint to
Copy link
Member

Choose a reason for hiding this comment

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

I like the idea of Ray Train expects all workers to be able to write the checkpoint to the same persistent storage location., that should be the core concept of persistent story. What about moving it to the very top of this user guide?

But logically using head node as persistent storage is also the same persistent storage location. The reason why we no longer support it is because of network communication bottleneck?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, the deprecation of head node as persistnet storage is described in the issue.

Comment on lines +152 to +153
When providing a custom filesystem, the associated ``storage_path`` is expected
to be a qualified filesystem path *without the protocol prefix*.
Copy link
Member

Choose a reason for hiding this comment

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

Did we check this and raise an error in the code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep, pyarrow will raise an error directly

network device, such as NFS.
.. code-block:: text

s3://bucket-name/sub-path (RunConfig.storage_path)
Copy link
Member

Choose a reason for hiding this comment

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

This is so nice!

…persistence

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
@matthewdeng matthewdeng merged commit 31f9c7c into ray-project:master Sep 9, 2023
13 of 15 checks passed
@justinvyu justinvyu deleted the doc/persistence branch September 9, 2023 05:49
matthewdeng added a commit to matthewdeng/ray that referenced this pull request Sep 9, 2023
…9428)


Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matt@anyscale.com>
GeneDer pushed a commit that referenced this pull request Sep 10, 2023
…39515)

* [docs] update doc links in Use Cases (#39445)

Signed-off-by: Matthew Deng <matt@anyscale.com>

* [train][release] Fix `tune_worker_fault_tolerance` release test node killing (#39233)


Signed-off-by: Justin Yu <justinvyu@anyscale.com>

* [train] Do not raise warning when no results were reported (#39454)

Signed-off-by: Kai Fricke <kai@anyscale.com>

* [train] add diagram in overview page (#39512)

Signed-off-by: Matthew Deng <matt@anyscale.com>

* [train] New persistence mode: Sanity-check release test (#39354)

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Co-authored-by: matthewdeng <matt@anyscale.com>

* [train][doc] Configuring persistent storage user guide (#39428)


Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matt@anyscale.com>

* [train][doc] New checkpointing user guide (#39505)


Signed-off-by: Justin Yu <justinvyu@anyscale.com>

---------

Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: Justin Yu <justinvyu@anyscale.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
jimthompson5802 pushed a commit to jimthompson5802/ray that referenced this pull request Sep 12, 2023
…9428)

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matt@anyscale.com>
Signed-off-by: Jim Thompson <jimthompson5802@gmail.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
…9428)

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: matthewdeng <matt@anyscale.com>
Signed-off-by: Victor <vctr.y.m@example.com>
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.

4 participants