[docs] new structure (#21776)
This PR consolidates both #21667 and #21759 (look there for features), but improves on them in the following way:
- [x] we reverted renaming of existing projects `tune`, `rllib`, `train`, `cluster`, `serve`, `raysgd` and `data` so that links won't break. I think my consolidation efforts with the `ray-` prefix were a little overeager in that regard. It's better like this. Only the creation of `ray-core` was a necessity, and some files moved into the `rllib` folder, so that should be relatively benign.
- [x] Additionally, we added Algolia `docsearch`, screenshot below. This is _much_ better than our current search. Caveat: there's a sphinx dependency that needs to be replaced (`sphinx-tabs`) by another, newer one (`sphinx-panels`), as the former prevents loading of the `algolia.js` library. Will follow-up in the next PR (hoping this one doesn't get re-re-re-re-reverted).
2022-01-22 00:42:05 +01:00
|
|
|
format: jb-book
|
|
|
|
|
root: index
|
|
|
|
|
parts:
|
|
|
|
|
- caption: Overview
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-overview/index
|
|
|
|
|
- file: ray-overview/installation
|
|
|
|
|
- file: ray-overview/ray-libraries
|
|
|
|
|
|
|
|
|
|
- caption: Ray ML
|
|
|
|
|
chapters:
|
|
|
|
|
- file: data/dataset
|
|
|
|
|
title: Ray Data
|
|
|
|
|
sections:
|
|
|
|
|
- file: data/dataset-pipeline
|
|
|
|
|
- file: data/dataset-ml-preprocessing
|
|
|
|
|
- file: data/dataset-execution-model
|
|
|
|
|
- file: data/dataset-tensor-support
|
|
|
|
|
- file: data/examples/big_data_ingestion
|
|
|
|
|
- file: data/dask-on-ray
|
|
|
|
|
- file: data/mars-on-ray
|
|
|
|
|
- file: data/modin/index
|
|
|
|
|
- file: data/raydp
|
|
|
|
|
- file: train/train
|
|
|
|
|
title: Ray Train
|
|
|
|
|
sections:
|
|
|
|
|
- file: train/user_guide
|
|
|
|
|
- file: train/examples
|
|
|
|
|
- file: train/architecture
|
|
|
|
|
- file: train/migration-guide
|
|
|
|
|
- file: raysgd/raysgd
|
|
|
|
|
title: "RaySGD v1: Distributed Training Wrappers"
|
|
|
|
|
- file: tune/index
|
|
|
|
|
title: Ray Tune
|
|
|
|
|
sections:
|
|
|
|
|
- file: tune/key-concepts
|
|
|
|
|
- file: tune/user-guide
|
|
|
|
|
- file: tune/tutorials/overview
|
|
|
|
|
sections:
|
|
|
|
|
- file: tune/tutorials/tune-tutorial.rst
|
|
|
|
|
- file: tune/tutorials/tune-advanced-tutorial.rst
|
|
|
|
|
- file: tune/tutorials/tune-distributed.rst
|
|
|
|
|
- file: tune/tutorials/tune-lifecycle.rst
|
|
|
|
|
- file: tune/tutorials/tune-mlflow.rst
|
|
|
|
|
- file: tune/tutorials/tune-pytorch-cifar.rst
|
|
|
|
|
- file: tune/tutorials/tune-pytorch-lightning.rst
|
|
|
|
|
- file: tune/tutorials/tune-serve-integration-mnist.rst
|
|
|
|
|
- file: tune/tutorials/tune-sklearn.rst
|
|
|
|
|
- file: tune/tutorials/tune-xgboost.rst
|
|
|
|
|
- file: tune/tutorials/tune-wandb.rst
|
|
|
|
|
- file: tune/examples/index
|
|
|
|
|
- file: tune/contrib
|
|
|
|
|
- file: serve/index
|
|
|
|
|
title: Ray Serve
|
|
|
|
|
sections:
|
2022-01-24 14:36:04 -08:00
|
|
|
- file: serve/end_to_end_tutorial.rst
|
[docs] new structure (#21776)
This PR consolidates both #21667 and #21759 (look there for features), but improves on them in the following way:
- [x] we reverted renaming of existing projects `tune`, `rllib`, `train`, `cluster`, `serve`, `raysgd` and `data` so that links won't break. I think my consolidation efforts with the `ray-` prefix were a little overeager in that regard. It's better like this. Only the creation of `ray-core` was a necessity, and some files moved into the `rllib` folder, so that should be relatively benign.
- [x] Additionally, we added Algolia `docsearch`, screenshot below. This is _much_ better than our current search. Caveat: there's a sphinx dependency that needs to be replaced (`sphinx-tabs`) by another, newer one (`sphinx-panels`), as the former prevents loading of the `algolia.js` library. Will follow-up in the next PR (hoping this one doesn't get re-re-re-re-reverted).
2022-01-22 00:42:05 +01:00
|
|
|
- file: serve/core-apis
|
|
|
|
|
- file: serve/http-servehandle
|
|
|
|
|
- file: serve/deployment
|
|
|
|
|
- file: serve/ml-models
|
|
|
|
|
- file: serve/pipeline
|
|
|
|
|
- file: serve/performance
|
|
|
|
|
- file: serve/architecture
|
|
|
|
|
- file: serve/tutorials/index
|
|
|
|
|
- file: serve/faq
|
|
|
|
|
- file: rllib/index
|
|
|
|
|
title: Ray RLlib
|
|
|
|
|
sections:
|
|
|
|
|
- file: rllib/rllib-toc
|
|
|
|
|
- file: rllib/core-concepts
|
|
|
|
|
- file: rllib/rllib-training
|
|
|
|
|
- file: rllib/rllib-env
|
|
|
|
|
- file: rllib/rllib-models
|
|
|
|
|
- file: rllib/rllib-algorithms
|
|
|
|
|
- file: rllib/rllib-sample-collection
|
|
|
|
|
- file: rllib/rllib-offline
|
|
|
|
|
- file: rllib/rllib-concepts
|
|
|
|
|
- file: rllib/rllib-examples
|
|
|
|
|
- file: rllib/rllib-dev
|
|
|
|
|
- file: workflows/concepts
|
|
|
|
|
title: Ray Workflows
|
|
|
|
|
sections:
|
|
|
|
|
- file: workflows/basics
|
|
|
|
|
- file: workflows/management
|
|
|
|
|
- file: workflows/actors
|
|
|
|
|
- file: workflows/metadata
|
|
|
|
|
- file: workflows/events
|
|
|
|
|
- file: workflows/comparison
|
|
|
|
|
- file: workflows/advanced
|
|
|
|
|
- file: ray-more-libs/index
|
|
|
|
|
title: More Ray ML Libraries
|
|
|
|
|
|
|
|
|
|
- caption: Ray Core
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-core/walkthrough
|
|
|
|
|
title: Getting Started
|
|
|
|
|
- file: ray-core/using-ray
|
|
|
|
|
title: "User Guide"
|
|
|
|
|
- file: ray-core/examples/overview
|
|
|
|
|
title: "Tutorials and Examples"
|
|
|
|
|
|
|
|
|
|
- caption: Deploying Ray Clusters
|
|
|
|
|
chapters:
|
|
|
|
|
- file: cluster/quickstart
|
|
|
|
|
- file: cluster/user-guide
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/index
|
|
|
|
|
- file: cluster/guide
|
|
|
|
|
- file: cluster/job-submission
|
|
|
|
|
title: "Submitting Ray Jobs"
|
|
|
|
|
- file: cluster/ray-client
|
|
|
|
|
- file: cluster/cloud
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/aws-tips
|
|
|
|
|
- file: cluster/deploy
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/kubernetes
|
|
|
|
|
- file: cluster/yarn
|
|
|
|
|
- file: cluster/slurm
|
|
|
|
|
- file: cluster/lsf
|
|
|
|
|
|
|
|
|
|
- caption: References
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-references/api
|
|
|
|
|
- file: ray-references/faq
|
|
|
|
|
|
|
|
|
|
- caption: Developer Guide
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-contribute/getting-involved
|
|
|
|
|
sections:
|
|
|
|
|
- file: ray-contribute/development
|
|
|
|
|
- file: ray-contribute/fake-autoscaler
|
|
|
|
|
- file: ray-core/configure
|
|
|
|
|
- file: ray-observability/index
|
|
|
|
|
- file: ray-design-patterns/index
|
|
|
|
|
- file: ray-contribute/whitepaper
|
|
|
|
|
|
|
|
|
|
# TODO: Add examples section
|
