[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
|
2022-01-27 02:14:25 +01:00
|
|
|
- file: ray-overview/learn-more
|
[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-overview/ray-libraries
|
|
|
|
|
|
2022-02-01 22:56:49 -08:00
|
|
|
- caption: Ray ML
|
[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/user-guide
|
|
|
|
|
- file: data/key-concepts
|
[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: data/examples/big_data_ingestion
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: data/package-ref
|
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:
|
|
|
|
|
- file: train/user_guide
|
|
|
|
|
- file: train/examples
|
|
|
|
|
- file: train/architecture
|
|
|
|
|
- file: train/migration-guide
|
|
|
|
|
- file: raysgd/raysgd
|
|
|
|
|
title: "RaySGD v1: Distributed Training Wrappers"
|
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-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-02-07 16:47:03 +01:00
|
|
|
- file: serve/end_to_end_tutorial
|
[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
|
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
|
|
|
|
|
- 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: 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
|
2022-03-04 16:48:03 +01:00
|
|
|
- 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
|
|
|
- file: ray-more-libs/index
|
|
|
|
|
title: More Ray ML Libraries
|
|
|
|
|
|
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
|
|
|
|
|
- file: ray-core/using-ray
|
|
|
|
|
title: "User Guide"
|
|
|
|
|
- file: ray-core/examples/overview
|
|
|
|
|
title: "Tutorials and Examples"
|
2022-02-19 10:19:07 +01:00
|
|
|
sections:
|
|
|
|
|
- file: ray-core/examples/placement-group
|
|
|
|
|
- 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_lbfgs
|
|
|
|
|
- file: ray-core/examples/plot_newsreader
|
|
|
|
|
- file: ray-core/examples/plot_parameter_server
|
|
|
|
|
- file: ray-core/examples/plot_pong_example
|
|
|
|
|
- file: ray-core/examples/plot_streaming
|
|
|
|
|
- file: ray-core/examples/progress_bar
|
|
|
|
|
- file: ray-core/examples/testing-tips
|
|
|
|
|
- file: ray-core/examples/tips-for-first-time
|
|
|
|
|
- file: ray-core/examples/using-ray-with-pytorch-lightning
|
|
|
|
|
- file: ray-core/examples/dask_xgboost/dask_xgboost
|
|
|
|
|
- file: ray-core/examples/modin_xgboost/modin_xgboost
|
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:
|
|
|
|
|
- file: cluster/quickstart
|
|
|
|
|
- file: cluster/user-guide
|
|
|
|
|
- file: cluster/cloud
|
|
|
|
|
- file: cluster/deploy
|
2022-03-04 16:48:03 +01:00
|
|
|
- file: cluster/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
|
|
|
|
|
|
|
|
- caption: References
|
|
|
|
|
chapters:
|
|
|
|
|
- file: ray-references/api
|
|
|
|
|
|
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:
|
|
|
|
|
- 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
|
|
|
|
|
- file: ray-core/configure
|
|
|
|
|
- file: ray-observability/index
|
|
|
|
|
- file: ray-design-patterns/index
|
|
|
|
|
- file: ray-contribute/whitepaper
|
|
|
|
|
|
2022-02-01 22:56:49 -08:00
|
|
|
# TODO: Add examples section
|
