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

ray-project#49504) Signed-off-by: Roshan Kathawate <roshankathawate@gmail.com>
roshankathawate · Jan 9, 2025 · 05c136c · 05c136c
1 parent c27afb0
commit 05c136c
Show file tree

Hide file tree

Showing 18 changed files with 536 additions and 830 deletions.
diff --git a/.vale/styles/config/vocabularies/RLlib/accept.txt b/.vale/styles/config/vocabularies/RLlib/accept.txt
@@ -5,6 +5,9 @@
 [Aa]utoscal(e|ing)
 boolean
 [Cc]allables?
+[Cc]heckpoints?(ing)?
+[Cc]heckpointable
+classmethods?
 coeff
 config
 (DQN|dqn)
@@ -27,6 +30,7 @@ RLModules?
 rollout
 (SAC|sac)
 SGD
+[Ss]ubcomponents?
 [Tt]ensor[Ff]low
 timesteps?
 vectorizes?
diff --git a/doc/source/rllib/checkpoints.rst b/doc/source/rllib/checkpoints.rst
diff --git a/doc/source/rllib/doc_code/checkpoints.py b/doc/source/rllib/doc_code/checkpoints.py
diff --git a/doc/source/rllib/doc_code/saving_and_loading_algos_and_policies.py b/doc/source/rllib/doc_code/saving_and_loading_algos_and_policies.py
diff --git a/doc/source/rllib/images/checkpointing/from_checkpoint.svg b/doc/source/rllib/images/checkpointing/from_checkpoint.svg
diff --git a/doc/source/rllib/images/checkpointing/save_and_restore.svg b/doc/source/rllib/images/checkpointing/save_and_restore.svg
diff --git a/doc/source/rllib/rllib-algorithms.rst b/doc/source/rllib/rllib-algorithms.rst
@@ -7,9 +7,6 @@
 Algorithms
 ==========
 
-Overview
-~~~~~~~~
-
 The following table is an overview of all available algorithms in RLlib. Note that all of them support
 multi-GPU training on a single (GPU) node in `Ray (open-source) <https://docs.ray.io/en/latest/index.html>`__ (|multi_gpu|)
 as well as multi-GPU training on multi-node (GPU) clusters when using the `Anyscale platform <https://www.anyscale.com/platform>`__