[wip][train] update Ray Train documentation (quickstart, user guides) (…

…#38287)
ray-project · Aug 11, 2023 · 1409c96 · 1409c96
1 parent 903899d
commit 1409c96
Show file tree

Hide file tree

Showing 30 changed files with 917 additions and 559 deletions.
diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml
@@ -60,31 +60,22 @@ parts:
         title: Ray Train
         sections:
           - file: train/key-concepts
-            title: "Key Concepts"
-          - file: train/distributed-pytorch
-            sections:
-              - file: train/distributed-pytorch/converting-existing-training-loop
-              - file: train/distributed-pytorch/data-loading-preprocessing
-              - file: train/distributed-pytorch/using-gpus
-              - file: train/distributed-pytorch/persistent-storage
-                title: Configuring Persistent Storage
-              - file: train/distributed-pytorch/monitoring-logging
-              - file: train/distributed-pytorch/checkpoints
-              - file: train/distributed-pytorch/experiment-tracking
-              - file: train/distributed-pytorch/fault-tolerance
-              - file: train/distributed-pytorch/migration-guides
-                title: Migration Guides
-              - file: train/distributed-pytorch/advanced
-                sections:
-                    - file: train/distributed-pytorch/reproducibility
-                    - file: train/distributed-pytorch/automatic-mixed-precision
-                    - file: train/distributed-pytorch/hyperparameter-optimization
-                      title: Hyperparameter optimization
+            title: Key Concepts
+          - file: train/getting-started-pytorch
+            title: PyTorch
+          - file: train/getting-started-pytorch-lightning
+            title: PyTorch Lightning
           - file: train/more-frameworks
             sections:
+              - file: train/huggingface-transformers-accelerate
+                title: HuggingFace Transformers & Accelerate
               - file: train/distributed-tensorflow-keras
+                title: TensorFlow & Keras
               - file: train/distributed-xgboost-lightgbm
+                title: XGBoost & LightGBM
               - file: train/horovod
+          - file: train/user-guides
+            title: User Guides
           - file: train/internals/index
             sections:
               - file: train/internals/architecture

diff --git a/doc/source/ray-air/api/session.rst b/doc/source/ray-air/api/session.rst
@@ -5,11 +5,6 @@ Ray AIR Session
 
 .. currentmodule:: ray.air
 
-.. seealso::
-    See this :ref:`Ray Train user guide <train-monitoring>` and
-    this :ref:`Ray Tune user guide <tune-function-api>` for usage examples
-    of ``ray.air.session`` in the respective libraries.
-
 
 Report Metrics and Save Checkpoints
 -----------------------------------

diff --git a/doc/source/train/api/api.rst b/doc/source/train/api/api.rst
@@ -148,7 +148,7 @@ PyTorch Lightning
 
     We will deprecate `LightningTrainer`, `LightningConfigBuilder`,
     `LightningCheckpoint`, and `LightningPredictor` in Ray 2.8. Please 
-    refer to the :ref:`migration guides <migration-guide>` for more info.
+    refer to the :ref:`migration guide <lightning-trainer-migration-guide>` for more info.
 
 Tensorflow/Keras
 ~~~~~~~~~~~~~~~~

diff --git a/doc/source/train/distributed-pytorch.rst b/doc/source/train/distributed-pytorch.rst
diff --git a/doc/source/train/distributed-pytorch/advanced.rst b/doc/source/train/distributed-pytorch/advanced.rst