mirror of
https://github.com/vale981/ray
synced 2025-03-06 18:41:40 -05:00
f9b71a8bf6
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).
29 lines
1,011 B
ReStructuredText
29 lines
1,011 B
ReStructuredText
Using Ray
|
||
=========
|
||
|
||
If you’re brand new to Ray, we recommend starting with our `tutorials <https://github.com/ray-project/tutorial>`_.
|
||
|
||
Below, you'll find information ranging from how to `start Ray <starting-ray.html>`_ to `advanced usage <advanced.html>`_. There are also detailed instructions on how to work with Ray concepts such as Actors and managing GPUs.
|
||
|
||
Finally, we've also included some content on using core Ray APIs with `Tensorflow <using-ray-with-tensorflow.html>`_, `PyTorch <using-ray-with-pytorch.html>`_ and `Jupyter Notebook <using-ray-with-jupyter.rst>`_.
|
||
|
||
.. toctree::
|
||
:maxdepth: -1
|
||
|
||
starting-ray.rst
|
||
actors.rst
|
||
namespaces.rst
|
||
handling-dependencies.rst
|
||
async_api.rst
|
||
concurrency_group_api.rst
|
||
using-ray-with-gpus.rst
|
||
serialization.rst
|
||
memory-management.rst
|
||
placement-group.rst
|
||
troubleshooting.rst
|
||
fault-tolerance.rst
|
||
advanced.rst
|
||
cross-language.rst
|
||
using-ray-with-tensorflow.rst
|
||
using-ray-with-pytorch.rst
|
||
using-ray-with-jupyter.rst
|