ray/doc/source/ray-observability/index.rst

Observability
===============

.. toctree::
    :maxdepth: 2
    :caption: Observability, Debugging, and Profiling

    ../ray-core/ray-dashboard.rst
    state/state-api.rst
    ray-debugging.rst
    ray-logging.rst
    ray-metrics.rst
    ray-tracing.rst
    ../ray-contribute/debugging.rst
    ../ray-contribute/profiling.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			`Observability`
			`===============`

			`.. toctree::`
[State Observability] pre-alpha documentation (#26560) Adds Documentation for state APIs API reference 2022-07-26 21:49:28 +09:00			`:maxdepth: 2`
[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: Observability, Debugging, and Profiling`

			`../ray-core/ray-dashboard.rst`
[State Observability] pre-alpha documentation (#26560) Adds Documentation for state APIs API reference 2022-07-26 21:49:28 +09:00			`state/state-api.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			`ray-debugging.rst`
			`ray-logging.rst`
			`ray-metrics.rst`
			`ray-tracing.rst`
			`../ray-contribute/debugging.rst`
[State Observability] pre-alpha documentation (#26560) Adds Documentation for state APIs API reference 2022-07-26 21:49:28 +09:00			`../ray-contribute/profiling.rst`