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

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

Merged
merged 22 commits into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/_static/js/custom.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ document.addEventListener("DOMContentLoaded", function() {
// Ray Train
"Ray Train", "Ray Train API",
"Distributed PyTorch", "Advanced Topics", "More Frameworks",
"Ray Train Internals",
"Ray Train Internals", "Getting Started with Other Frameworks",
// Ray Tune
"Ray Tune", "Ray Tune Examples", "Ray Tune API",
// Ray Serve
Expand Down
30 changes: 10 additions & 20 deletions doc/source/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,31 +60,21 @@ 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
- file: train/getting-started-pytorch-lightning
- file: train/more-frameworks
title: Getting Started with Other Frameworks
sections:
- file: train/huggingface-transformers-accelerate
title: HuggingFace Transformers & Accelerate
woshiyyya marked this conversation as resolved.
Show resolved Hide resolved
- 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
Expand Down
5 changes: 0 additions & 5 deletions doc/source/ray-air/api/session.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/source/train/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~
Expand Down
24 changes: 0 additions & 24 deletions doc/source/train/distributed-pytorch.rst

This file was deleted.

2 changes: 0 additions & 2 deletions doc/source/train/distributed-pytorch/advanced.rst

This file was deleted.

Loading
Loading