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.

Sign up for GitHub

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

Jump to bottom

[RLlib] Docs do-over (new API stack): Re-write checkpointing rst page. #49504

Merged
merged 45 commits into from
Jan 7, 2025
Merged

[RLlib] Docs do-over (new API stack): Re-write checkpointing rst page. #49504

merged 45 commits into from
Jan 7, 2025

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 30, 2024 •
edited
Loading

Docs do-over (new API stack):

  • Re-write RLlib's checkpointing rst page.
  • Cleanup old API stuff, images, py-files. Most code moved to ..testcode blocks directly inside the new rst.

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 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 :(

@sven1977
wip
c90be66
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
0b3870c 
…_redo_checkpointing
@sven1977
wip
e2a156c
@sven1977
wip
e520678
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
3c05f4a 
…_redo_checkpointing
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
c6a18b2 
…_redo_checkpointing
@sven1977
wip
266f894
@sven1977
wip
5401b6d
@sven1977
wip
6edef91 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
merge
fd66605 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
f939ee7 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fix
0a3e79e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
dadd964 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
896c1a2 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
d76edfd 
…_redo_checkpointing
@sven1977
wip
44acf78 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
a8bdbac 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
fdddd9f 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'checkpointing_enhancements_msgpack_and_separation_of_st…
e8fec77 
…ate_and_architecture' into docs_redo_checkpointing

# Conflicts:
#	rllib/utils/checkpoints.py
@sven1977
wip
a42ff1e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 added rllib RLlib related issues rllib-checkpointing-or-recovery An issue related to checkpointing/recovering RLlib Trainers. rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack labels Dec 30, 2024
sven1977 and others added 6 commits January 6, 2025 10:10
@sven1977
wip
2f04106 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 @angelinalg
Apply suggestions from code review
2f9925f 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977
Merge branch 'docs_redo_checkpointing' of https://github.com/sven1977…
5333255 
…/ray into docs_redo_checkpointing

# Conflicts:
#	doc/source/rllib/checkpoints.rst
@sven1977
fixes
d6e186f 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
da727c3 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fix
00f5a4b 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
simonsays1980
simonsays1980 approved these changes Jan 6, 2025
View reviewed changes
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

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

LGTM. A note to mention checkpointing to cloud storage is helpful here for users. Using the PyArrow filesystems.

doc/source/rllib/checkpoints.rst Outdated

RLlib offers a powerful checkpointing system for all its major classes, allowing you to save the
states of :py:class:`~ray.rllib.algorithms.algorithm.Algorithm` instances and their subcomponents
to disk, and load previously run experiment states and individual subcomponents back from disk.
Copy link
Collaborator

Choose a reason for hiding this comment

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

disk (local disk or cloud storage)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great point. Wasn't thinking about this feature at all. Let me add ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

doc/source/rllib/checkpoints.rst

.. code-block:: shell

algorithm/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Very nice!

@sven1977 sven1977 enabled auto-merge (squash) January 6, 2025 15:49
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jan 6, 2025
@sven1977
fix
ecf631d 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 6, 2025 16:30
@sven1977 sven1977 enabled auto-merge (squash) January 6, 2025 16:30
@sven1977
fixes
7979dbf 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 6, 2025 17:15
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
62736f9 
…_redo_checkpointing
@sven1977
fixes
64d47bc 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) January 7, 2025 10:18
@sven1977
wip
d9b769c 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 7, 2025 10:22
@sven1977
wip
f63afc3 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
dcd4663 
…_redo_checkpointing
@sven1977 sven1977 enabled auto-merge (squash) January 7, 2025 18:01
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
b59401b 
…_redo_checkpointing
@sven1977
wip
998a544 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 7, 2025 20:30
@sven1977 sven1977 enabled auto-merge (squash) January 7, 2025 20:31
@sven1977 sven1977 merged commit 0f60dad into ray-project:master Jan 7, 2025
6 checks passed
@sven1977 sven1977 deleted the docs_redo_checkpointing branch January 8, 2025 08:28
roshankathawate pushed a commit to roshankathawate/ray that referenced this pull request Jan 9, 2025
@sven1977 @roshankathawate
[RLlib] Docs do-over (new API stack): Re-write checkpointing rst page. (
05c136c 
ray-project#49504)

Signed-off-by: Roshan Kathawate <roshankathawate@gmail.com>
HYLcool pushed a commit to HYLcool/ray that referenced this pull request Jan 13, 2025
@sven1977 @HYLcool
[RLlib] Docs do-over (new API stack): Re-write checkpointing rst page. (
fe94ce2 
ray-project#49504)

Signed-off-by: lielin.hyl <lielin.hyl@alibaba-inc.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angelinalg angelinalg angelinalg approved these changes

@simonsays1980 simonsays1980 simonsays1980 approved these changes

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

Assignees

@simonsays1980 simonsays1980

@angelinalg angelinalg

Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-checkpointing-or-recovery An issue related to checkpointing/recovering RLlib Trainers. rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack rllib-oldstack-cleanup Issues related to cleaning up classes, utilities on the old API stack
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sven1977 @simonsays1980 @angelinalg