[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
|
|
|
|
|
|
2022-06-06 15:15:11 -07:00
|
|
|
- caption: Ray AI Runtime
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-air/getting-started
|
|
|
|
|
title: "What is Ray AI Runtime (AIR)?"
|
|
|
|
|
- file: ray-air/key-concepts
|
|
|
|
|
- file: ray-air/user-guides
|
|
|
|
|
sections:
|
|
|
|
|
- file: ray-air/preprocessors
|
2022-08-04 05:59:50 -07:00
|
|
|
- file: ray-air/trainer
|
2022-08-08 16:43:59 -07:00
|
|
|
- file: ray-air/check-ingest
|
2022-08-03 09:43:42 -07:00
|
|
|
- file: ray-air/tuner
|
2022-07-16 21:14:21 -07:00
|
|
|
- file: ray-air/predictors
|
2022-06-07 08:53:10 -07:00
|
|
|
- file: ray-air/examples/serving_guide
|
2022-06-06 16:23:30 -07:00
|
|
|
- file: ray-air/deployment
|
2022-06-06 15:15:11 -07:00
|
|
|
- file: ray-air/examples/index
|
|
|
|
|
sections:
|
|
|
|
|
- file: ray-air/examples/torch_image_example
|
2022-06-15 03:11:32 +02:00
|
|
|
- file: ray-air/examples/convert_existing_pytorch_code_to_ray_air
|
2022-06-06 15:15:11 -07:00
|
|
|
- file: ray-air/examples/tfx_tabular_train_to_serve
|
|
|
|
|
- file: ray-air/examples/huggingface_text_classification
|
|
|
|
|
- file: ray-air/examples/sklearn_example
|
|
|
|
|
- file: ray-air/examples/xgboost_example
|
2022-08-03 09:43:42 -07:00
|
|
|
- file: ray-air/examples/analyze_tuning_results
|
2022-06-06 15:15:11 -07:00
|
|
|
- file: ray-air/examples/lightgbm_example
|
|
|
|
|
- file: ray-air/examples/torch_incremental_learning
|
|
|
|
|
- file: ray-air/examples/rl_serving_example
|
|
|
|
|
- file: ray-air/examples/rl_online_example
|
|
|
|
|
- file: ray-air/examples/rl_offline_example
|
2022-07-16 21:14:21 -07:00
|
|
|
- file: ray-air/examples/upload_to_comet_ml
|
|
|
|
|
- file: ray-air/examples/upload_to_wandb
|
2022-06-07 14:55:42 -07:00
|
|
|
- file: ray-air/examples/feast_example
|
2022-06-06 15:15:11 -07:00
|
|
|
- file: ray-air/package-ref
|
2022-07-16 15:34:31 -07:00
|
|
|
- file: ray-air/benchmarks
|
2022-06-06 15:15:11 -07:00
|
|
|
|
2022-07-12 14:23:36 -07:00
|
|
|
- caption: Ray Libraries
|
[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
|
|
|
chapters:
|
|
|
|
|
- file: data/dataset
|
|
|
|
|
title: Ray Data
|
|
|
|
|
sections:
|
2022-01-27 22:14:36 +01:00
|
|
|
- file: data/getting-started
|
|
|
|
|
- file: data/key-concepts
|
2022-03-18 11:25:43 -07:00
|
|
|
- file: data/user-guide
|
2022-05-19 12:54:25 -07:00
|
|
|
- file: data/examples/index
|
|
|
|
|
sections:
|
|
|
|
|
- file: data/examples/nyc_taxi_basic_processing
|
|
|
|
|
title: Processing the NYC taxi dataset
|
|
|
|
|
- file: data/examples/big_data_ingestion
|
|
|
|
|
title: Large-scale ML Ingest
|
2022-07-06 13:11:26 -07:00
|
|
|
- file: data/examples/ocr_example
|
|
|
|
|
title: Scaling OCR with Ray Datasets
|
2022-07-24 19:48:29 -07:00
|
|
|
- file: data/advanced-pipelines
|
|
|
|
|
- file: data/random-access
|
2022-05-19 15:44:22 -07:00
|
|
|
- file: data/faq
|
2022-08-11 23:10:10 -07:00
|
|
|
- file: data/api/api
|
2022-03-17 11:27:40 -07:00
|
|
|
- file: data/integrations
|
2022-01-27 22:14:36 +01:00
|
|
|
|
[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: train/train
|
|
|
|
|
title: Ray Train
|
|
|
|
|
sections:
|
2022-08-05 11:21:19 -07:00
|
|
|
- file: train/getting-started
|
|
|
|
|
- file: train/key-concepts
|
|
|
|
|
- file: train/user-guides
|
|
|
|
|
sections:
|
|
|
|
|
- file: train/config_guide
|
|
|
|
|
- file: train/dl_guide
|
|
|
|
|
- file: train/gbdt
|
|
|
|
|
- file: train/architecture
|
2022-04-04 16:14:35 -07:00
|
|
|
- file: train/faq
|
2022-08-05 11:21:19 -07:00
|
|
|
- file: train/examples
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: train/api
|
|
|
|
|
|
[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: tune/index
|
|
|
|
|
title: Ray Tune
|
|
|
|
|
sections:
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/getting-started
|
[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: tune/key-concepts
|
|
|
|
|
- file: tune/tutorials/overview
|
|
|
|
|
sections:
|
2022-02-27 08:07:34 +01:00
|
|
|
- file: tune/tutorials/tune-lifecycle
|
|
|
|
|
title: "How Tune Works"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-stopping
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "How to Stop and Resume"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-metrics
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "Using Callbacks and Metrics"
|
|
|
|
|
- file: tune/tutorials/tune-distributed
|
|
|
|
|
title: "Distributed Tuning"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-output
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "Logging Tune Runs"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-resources
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "Managing Resources"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-checkpoints
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "Working with Checkpoints"
|
|
|
|
|
- file: tune/tutorials/tune-search-spaces
|
|
|
|
|
title: "Using Search Spaces"
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/tutorials/tune-advanced-tutorial
|
2022-02-27 08:07:34 +01:00
|
|
|
title: "Understanding PBT"
|
|
|
|
|
- file: tune/tutorials/tune-scalability
|
|
|
|
|
title: "Scalability Benchmarks"
|
[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: tune/examples/index
|
2022-05-13 15:39:18 +02:00
|
|
|
sections:
|
|
|
|
|
- file: tune/examples/tune-sklearn
|
|
|
|
|
title: "Scikit-Learn Example"
|
|
|
|
|
- file: tune/examples/tune_mnist_keras
|
|
|
|
|
title: "Keras Example"
|
|
|
|
|
- file: tune/examples/tune-pytorch-cifar
|
|
|
|
|
title: "PyTorch Example"
|
|
|
|
|
- file: tune/examples/tune-pytorch-lightning
|
|
|
|
|
title: "PyTorch Lightning Example"
|
|
|
|
|
- file: tune/examples/mxnet_example
|
|
|
|
|
title: "MXNet Example"
|
|
|
|
|
- file: tune/examples/tune-serve-integration-mnist
|
|
|
|
|
title: "Ray Serve Example"
|
|
|
|
|
- file: tune/examples/pbt_ppo_example
|
|
|
|
|
title: "Ray RLlib Example"
|
|
|
|
|
- file: tune/examples/tune-xgboost
|
|
|
|
|
title: "XGBoost Example"
|
|
|
|
|
- file: tune/examples/lightgbm_example
|
|
|
|
|
title: "LightGBM Example"
|
|
|
|
|
- file: tune/examples/horovod_simple
|
|
|
|
|
title: "Horovod Example"
|
|
|
|
|
- file: tune/examples/pbt_transformers
|
|
|
|
|
title: "Huggingface Example"
|
|
|
|
|
- file: tune/examples/tune-comet
|
|
|
|
|
title: "Comet Example"
|
|
|
|
|
- file: tune/examples/tune-wandb
|
|
|
|
|
title: "Weights & Biases Example"
|
|
|
|
|
- file: tune/examples/ax_example
|
|
|
|
|
title: "Ax Example"
|
|
|
|
|
- file: tune/examples/dragonfly_example
|
|
|
|
|
title: "Dragonfly Example"
|
|
|
|
|
- file: tune/examples/skopt_example
|
|
|
|
|
title: "Skopt Example"
|
|
|
|
|
- file: tune/examples/hyperopt_example
|
|
|
|
|
title: "HyperOpt Example"
|
|
|
|
|
- file: tune/examples/bayesopt_example
|
|
|
|
|
title: "Bayesopt Example"
|
|
|
|
|
- file: tune/examples/flaml_example
|
|
|
|
|
title: "FLAML Example"
|
|
|
|
|
- file: tune/examples/bohb_example
|
|
|
|
|
title: "BOHB Example"
|
|
|
|
|
- file: tune/examples/nevergrad_example
|
|
|
|
|
title: "Nevergrad Example"
|
|
|
|
|
- file: tune/examples/optuna_example
|
|
|
|
|
title: "Optuna Example"
|
|
|
|
|
- file: tune/examples/zoopt_example
|
|
|
|
|
title: "ZOOpt Example"
|
|
|
|
|
- file: tune/examples/sigopt_example
|
|
|
|
|
title: "SigOpt Example"
|
|
|
|
|
- file: tune/examples/hebo_example
|
|
|
|
|
title: "HEBO Example"
|
|
|
|
|
|
2022-02-07 16:47:03 +01:00
|
|
|
- file: tune/faq
|
|
|
|
|
- file: tune/api_docs/overview.rst
|
2022-03-04 16:48:03 +01:00
|
|
|
|
[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/index
|
|
|
|
|
title: Ray Serve
|
|
|
|
|
sections:
|
2022-05-12 10:44:43 -05:00
|
|
|
- file: serve/getting_started
|
2022-05-20 10:56:34 -07:00
|
|
|
- file: serve/key-concepts
|
|
|
|
|
- file: serve/user-guide
|
2022-05-11 16:24:55 -07:00
|
|
|
sections:
|
2022-05-20 10:56:34 -07:00
|
|
|
- file: serve/managing-deployments
|
|
|
|
|
- file: serve/handling-dependencies
|
2022-08-11 14:34:07 -07:00
|
|
|
- file: serve/scaling-and-resource-allocation
|
2022-05-20 10:56:34 -07:00
|
|
|
- file: serve/http-guide
|
|
|
|
|
- file: serve/handle-guide
|
2022-08-11 13:01:17 -07:00
|
|
|
- file: serve/ray-air-serve-guide
|
2022-05-20 10:56:34 -07:00
|
|
|
- file: serve/ml-models
|
2022-08-11 12:06:27 -07:00
|
|
|
- file: serve/batching-guide
|
2022-08-09 15:06:23 -07:00
|
|
|
- file: serve/model_composition
|
2022-05-20 10:56:34 -07:00
|
|
|
- file: serve/deploying-serve
|
|
|
|
|
- file: serve/monitoring
|
|
|
|
|
- file: serve/performance
|
2022-08-12 09:06:13 -07:00
|
|
|
- file: serve/dev-workflow
|
2022-06-24 14:44:39 -07:00
|
|
|
- file: serve/production
|
2022-08-05 12:28:48 -07:00
|
|
|
- file: serve/migration
|
[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/architecture
|
|
|
|
|
- file: serve/tutorials/index
|
2022-08-09 15:06:23 -07:00
|
|
|
sections:
|
|
|
|
|
- file: serve/tutorials/deployment-graph-patterns
|
|
|
|
|
sections:
|
|
|
|
|
- file: serve/tutorials/deployment-graph-patterns/linear_pipeline
|
|
|
|
|
- file: serve/tutorials/deployment-graph-patterns/branching_input
|
|
|
|
|
- file: serve/tutorials/deployment-graph-patterns/conditional
|
[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/faq
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: serve/package-ref
|
|
|
|
|
|
[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: rllib/index
|
|
|
|
|
title: Ray RLlib
|
|
|
|
|
sections:
|
|
|
|
|
- file: rllib/core-concepts
|
|
|
|
|
- file: rllib/rllib-training
|
|
|
|
|
- file: rllib/rllib-env
|
|
|
|
|
- file: rllib/rllib-algorithms
|
2022-02-18 18:35:20 +01:00
|
|
|
- file: rllib/user-guides
|
|
|
|
|
sections:
|
|
|
|
|
- file: rllib/rllib-models
|
|
|
|
|
- file: rllib/rllib-concepts
|
|
|
|
|
- file: rllib/rllib-sample-collection
|
2022-06-10 16:47:51 +02:00
|
|
|
- file: rllib/rllib-replay-buffers
|
2022-02-18 18:35:20 +01:00
|
|
|
- file: rllib/rllib-offline
|
|
|
|
|
- file: rllib/rllib-dev
|
[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: rllib/rllib-examples
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: rllib/package_ref/index
|
|
|
|
|
|
[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: ray-more-libs/index
|
2022-06-06 15:15:11 -07:00
|
|
|
title: More Libraries
|
2022-05-13 01:29:59 -07:00
|
|
|
sections:
|
|
|
|
|
- file: ray-more-libs/joblib
|
|
|
|
|
- file: ray-more-libs/multiprocessing
|
|
|
|
|
- file: ray-more-libs/ray-collective
|
|
|
|
|
- file: ray-core/examples/using-ray-with-pytorch-lightning
|
2022-06-11 19:47:45 -07:00
|
|
|
- file: workflows/concepts
|
|
|
|
|
title: Ray Workflows
|
|
|
|
|
sections:
|
|
|
|
|
- file: workflows/basics
|
|
|
|
|
- file: workflows/management
|
|
|
|
|
- file: workflows/metadata
|
|
|
|
|
- file: workflows/events
|
|
|
|
|
- file: workflows/comparison
|
|
|
|
|
- file: workflows/advanced
|
|
|
|
|
- file: workflows/package-ref
|
[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
|
|
|
|
2022-02-01 22:56:49 -08:00
|
|
|
- caption: Ray Core
|
[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
|
|
|
chapters:
|
|
|
|
|
- file: ray-core/walkthrough
|
|
|
|
|
title: Getting Started
|
2022-03-17 11:26:17 -07:00
|
|
|
- file: ray-core/key-concepts
|
|
|
|
|
title: "Key Concepts"
|
|
|
|
|
- file: ray-core/user-guide
|
|
|
|
|
title: "User Guides"
|
[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: ray-core/examples/overview
|
2022-03-10 21:17:00 +01:00
|
|
|
title: "Examples"
|
2022-02-19 10:19:07 +01:00
|
|
|
sections:
|
|
|
|
|
- file: ray-core/examples/plot_example-a3c
|
|
|
|
|
- file: ray-core/examples/plot_example-lm
|
|
|
|
|
- file: ray-core/examples/plot_hyperparameter
|
|
|
|
|
- file: ray-core/examples/plot_parameter_server
|
|
|
|
|
- file: ray-core/examples/plot_pong_example
|
2022-06-08 18:10:37 -07:00
|
|
|
- file: ray-core/examples/highly_parallel
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: ray-core/package-ref
|
[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
|
|
|
|
2022-02-01 22:56:49 -08:00
|
|
|
- caption: Ray Clusters
|
[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
|
|
|
chapters:
|
2022-08-10 17:41:56 -07:00
|
|
|
- file: cluster/getting-started
|
|
|
|
|
title: Getting Started
|
2022-05-25 10:23:50 -07:00
|
|
|
- file: cluster/key-concepts
|
2022-08-10 17:41:56 -07:00
|
|
|
title: Key Concepts
|
|
|
|
|
- file: cluster/kubernetes/index
|
2022-08-12 00:15:03 -07:00
|
|
|
title: Deploying on Kubernetes
|
2022-07-26 12:00:20 -07:00
|
|
|
sections:
|
2022-08-10 17:41:56 -07:00
|
|
|
- file: cluster/kubernetes/getting-started
|
|
|
|
|
- file: cluster/kubernetes/user-guides
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/kubernetes/user-guides/k8s-cluster-setup.md
|
|
|
|
|
- file: cluster/kubernetes/user-guides/config.md
|
2022-08-12 00:15:03 -07:00
|
|
|
- file: cluster/kubernetes/user-guides/configuring-autoscaling.md
|
2022-08-10 17:41:56 -07:00
|
|
|
- file: cluster/kubernetes/user-guides/logging.md
|
|
|
|
|
- file: cluster/kubernetes/user-guides/gpu.md
|
|
|
|
|
- file: cluster/kubernetes/examples
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/kubernetes/examples/ml-example.md
|
|
|
|
|
- file: cluster/kubernetes/references
|
|
|
|
|
- file: cluster/vms/index
|
2022-08-12 00:15:03 -07:00
|
|
|
title: Deploying on VMs
|
2022-08-10 17:41:56 -07:00
|
|
|
sections:
|
|
|
|
|
- file: cluster/vms/getting-started
|
|
|
|
|
- file: cluster/vms/user-guides/index
|
|
|
|
|
title: User Guides
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/vms/user-guides/launching-clusters/index
|
|
|
|
|
title: Launching Clusters
|
|
|
|
|
- file: cluster/vms/user-guides/large-cluster-best-practices
|
|
|
|
|
- file: cluster/vms/user-guides/configuring-autoscaling
|
|
|
|
|
- file: cluster/vms/user-guides/community/index
|
|
|
|
|
title: Community-supported Cluster Managers
|
2022-07-26 12:00:20 -07:00
|
|
|
sections:
|
2022-08-10 17:41:56 -07:00
|
|
|
- file: cluster/vms/user-guides/community/yarn
|
|
|
|
|
- file: cluster/vms/user-guides/community/slurm
|
|
|
|
|
- file: cluster/vms/user-guides/community/lsf
|
|
|
|
|
- file: cluster/vms/examples/index
|
|
|
|
|
title: Examples
|
|
|
|
|
sections:
|
|
|
|
|
- file: cluster/vms/examples/ml-example
|
|
|
|
|
- file: cluster/vms/references/index
|
|
|
|
|
- file: cluster/running-applications/index
|
2022-08-12 00:15:03 -07:00
|
|
|
title: Applications Guide
|
2022-08-10 17:41:56 -07:00
|
|
|
|
2022-07-26 12:00:20 -07:00
|
|
|
|
[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
|
|
|
- caption: References
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-references/api
|
2022-08-12 00:15:03 -07:00
|
|
|
- file: cluster/usage-stats
|
[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
|
|
|
|
2022-01-27 02:14:25 +01:00
|
|
|
- caption: Developer Guides
|
[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
|
|
|
chapters:
|
2022-06-10 15:19:21 -07:00
|
|
|
- file: ray-contribute/stability
|
[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: ray-contribute/getting-involved
|
|
|
|
|
sections:
|
|
|
|
|
- file: ray-contribute/development
|
2022-03-10 16:28:07 +01:00
|
|
|
- file: ray-contribute/docs
|
[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: ray-contribute/fake-autoscaler
|
2022-03-10 21:17:00 +01:00
|
|
|
- file: ray-core/examples/testing-tips
|
[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: ray-core/configure
|
|
|
|
|
- file: ray-observability/index
|
|
|
|
|
- file: ray-contribute/whitepaper
|
