[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
|
|
|
More Ray ML Libraries
|
|
|
|
|
=====================
|
|
|
|
|
|
2022-03-10 21:17:00 +01:00
|
|
|
.. TODO: we added the three Ray Core examples below, since they don't really belong there.
|
|
|
|
|
Going forward, make sure that all "Ray Lightning" and XGBoost topics are in one document or group,
|
|
|
|
|
and not next to each other.
|
|
|
|
|
|
[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
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Other Libraries
|
|
|
|
|
|
2022-03-10 21:17:00 +01:00
|
|
|
joblib
|
|
|
|
|
lightgbm-ray
|
|
|
|
|
multiprocessing
|
|
|
|
|
ray-collective
|
|
|
|
|
ray-lightning
|
|
|
|
|
../ray-core/examples/using-ray-with-pytorch-lightning
|
|
|
|
|
xgboost-ray
|
|
|
|
|
../ray-core/examples/dask_xgboost/dask_xgboost
|
|
|
|
|
../ray-core/examples/modin_xgboost/modin_xgboost
|
