Skip to content

Commit

Permalink
[docs][serve][tune] Remove serve/tutorial/rllib and tune-sklearn exam…
Browse files Browse the repository at this point in the history
…ples (ray-project#41758)

Purging outdated or low-value examples from the Example Gallery.
@pcmoritz @richardliaw

---------

Signed-off-by: angelinalg <[email protected]>
angelinalg authored Dec 12, 2023
1 parent 1a090a0 commit e8273ea
Showing 12 changed files with 3 additions and 575 deletions.
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ make doctest

You can now add [executable notebooks](https://myst-nb.readthedocs.io/en/latest/use/markdown.html) to this project,
which will get built into the documentation.
An [example can be found here](./source/serve/tutorials/rllib.md).
<!--An [example can be found here](./source/serve/tutorials/rllib.md).-->
By default, building the docs with `make develop` will not run those notebooks.
If you set the `RUN_NOTEBOOKS` environment variable to `"cache"`, each notebook cell will be run when you build the
documentation, and outputs will be cached into `_build/.jupyter_cache`.
21 changes: 0 additions & 21 deletions doc/source/ray-overview/examples.rst
Original file line number Diff line number Diff line change
@@ -201,13 +201,6 @@ Ray Examples

Batching tutorial for Ray Serve

.. grid-item-card:: :bdg-secondary:`Code example`
:class-item: gallery-item reinforcement-learning serving
:link: /serve/tutorials/rllib
:link-type: doc

Serving RLlib Models with Ray Serve

.. grid-item-card:: :bdg-secondary:`Code example`
:class-item: gallery-item serving
:link: /serve/tutorials/gradio-integration
@@ -694,13 +687,6 @@ Ray Examples

Example showing how to run an offline RL training job using a historic-data json file.

.. grid-item-card:: :bdg-secondary:`Code example`
:class-item: gallery-item reinforcement-learning rllib serving
:link: serve-rllib-tutorial
:link-type: ref

Example of using Ray Serve to serve RLlib models with HTTP and JSON interface

.. grid-item-card:: :bdg-secondary:`Code example`
:class-item: gallery-item reinforcement-learning rllib serving
:link: https://github.com/ray-project/ray/tree/master/rllib/examples/inference_and_serving/serve_and_rllib.py
@@ -1036,13 +1022,6 @@ Ray Examples

Running a Simple MapReduce Example with Ray Core

.. grid-item-card:: :bdg-success:`Tutorial`
:class-item: gallery-item tune
:link: /tune/examples/tune-sklearn
:link-type: doc

How To Use Tune's Scikit-Learn Adapters?

.. grid-item-card:: :bdg-secondary:`Code example`
:class-item: gallery-item tune
:link: /tune/examples/includes/tune_basic_example
2 changes: 0 additions & 2 deletions doc/source/rllib/rllib-examples.rst
Original file line number Diff line number Diff line change
@@ -93,8 +93,6 @@ Serving and Offline
-------------------
- `Offline RL with CQL <https://github.com/ray-project/ray/tree/master/rllib/examples/offline_rl.py>`__:
Example showing how to run an offline RL training job using a historic-data json file.
- :ref:`Serving RLlib models with Ray Serve <serve-rllib-tutorial>`: Example of using Ray Serve to serve RLlib models
with HTTP and JSON interface. **This is the recommended way to expose RLlib for online serving use case**.
- `Another example for using RLlib with Ray Serve <https://github.com/ray-project/ray/tree/master/rllib/examples/inference_and_serving/serve_and_rllib.py>`__
This script offers a simple workflow for 1) training a policy with RLlib first, 2) creating a new policy 3) restoring its weights from the trained
one and serving the new policy via Ray Serve.
2 changes: 1 addition & 1 deletion doc/source/serve/index.md
Original file line number Diff line number Diff line change
@@ -280,7 +280,7 @@ or head over to the {doc}`tutorials/index` to get started building your Ray Serv
**Examples**
^^^
Follow the tutorials to learn how to integrate Ray Serve with :ref:`TensorFlow <serve-ml-models-tutorial>`, :ref:`Scikit-Learn <serve-ml-models-tutorial>`, and :ref:`RLlib <serve-rllib-tutorial>`.
Follow the tutorials to learn how to integrate Ray Serve with :ref:`TensorFlow <serve-ml-models-tutorial>`, and :ref:`Scikit-Learn <serve-ml-models-tutorial>`.
+++
.. button-ref:: serve-examples
1 change: 0 additions & 1 deletion doc/source/serve/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -14,7 +14,6 @@ stable-diffusion
text-classification
object-detection
aws-neuron-core-inference
rllib
gradio-integration
batch
streaming
172 changes: 0 additions & 172 deletions doc/source/serve/tutorials/rllib.md

This file was deleted.

9 changes: 0 additions & 9 deletions doc/source/tune/examples/ml-frameworks.rst
Original file line number Diff line number Diff line change
@@ -4,7 +4,6 @@ Examples using Ray Tune with ML Frameworks
.. toctree::
:hidden:

Scikit-Learn Example <tune-sklearn>
Keras Example <tune_mnist_keras>
PyTorch Example <tune-pytorch-cifar>
PyTorch Lightning Example <tune-pytorch-lightning>
@@ -23,14 +22,6 @@ At the end of these guides you will often find links to even more examples.
:gutter: 1
:class-container: container pb-3

.. grid-item-card::
:img-top: /images/tune-sklearn.png
:class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

.. button-ref:: tune-sklearn

How To Use Tune's Scikit-Learn Adapters?

.. grid-item-card::
:img-top: /images/keras.png
:class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img
Loading

0 comments on commit e8273ea

Please sign in to comment.