diff --git a/doc/examples/plot_hyperparameter.py b/doc/examples/plot_hyperparameter.py index 3ef27360f..6db900af3 100644 --- a/doc/examples/plot_hyperparameter.py +++ b/doc/examples/plot_hyperparameter.py @@ -12,7 +12,7 @@ their results to be ready. .. image:: ../images/hyperparameter.png :align: center -.. important:: For a production-grade implementation of distributed +.. tip:: For a production-grade implementation of distributed hyperparameter tuning, use `Tune`_, a scalable hyperparameter tuning library built using Ray's Actor API. diff --git a/doc/source/actors.rst b/doc/source/actors.rst index 994497a93..928098a35 100644 --- a/doc/source/actors.rst +++ b/doc/source/actors.rst @@ -89,7 +89,7 @@ If you want to use custom resources, make sure your cluster is configured to have these resources (see `configuration instructions `__): -.. important:: +.. note:: * If you specify resource requirements in an actor class's remote decorator, then the actor will acquire those resources for its entire lifetime (if you diff --git a/doc/source/index.rst b/doc/source/index.rst index 68a1bb2e3..e84f60f5a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -25,7 +25,7 @@ Star us on `on GitHub`_. You can also get started by visiting our `Tutorials `_ to discuss Ray! +.. tip:: Join our `community slack `_ to discuss Ray! Quick Start diff --git a/doc/source/installation.rst b/doc/source/installation.rst index a350c23ae..7f232f47b 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,7 +1,7 @@ Installing Ray ============== -.. important:: Join our `community slack `_ to discuss Ray! +.. tip:: Join our `community slack `_ to discuss Ray! Ray currently supports MacOS and Linux. Windows support is planned for the future. diff --git a/doc/source/raysgd/raysgd.rst b/doc/source/raysgd/raysgd.rst index aab67edff..a20a566ba 100644 --- a/doc/source/raysgd/raysgd.rst +++ b/doc/source/raysgd/raysgd.rst @@ -11,7 +11,7 @@ The main features are: - **Composability**: RaySGD is built on top of the Ray Actor API, enabling seamless integration with existing Ray applications such as RLlib, Tune, and Ray.Serve. - **Scale up and down**: Start on single CPU. Scale up to multi-node, multi-CPU, or multi-GPU clusters by changing 2 lines of code. -.. important:: Join our `community slack `_ to discuss Ray! +.. tip:: Join our `community slack `_ to discuss Ray! Getting Started diff --git a/doc/source/rllib.rst b/doc/source/rllib.rst index cf8f440cf..c5ea09792 100644 --- a/doc/source/rllib.rst +++ b/doc/source/rllib.rst @@ -7,7 +7,7 @@ RLlib is an open-source library for reinforcement learning that offers both high To get started, take a look over the `custom env example `__ and the `API documentation `__. If you're looking to develop custom algorithms with RLlib, also check out `concepts and custom algorithms `__. -.. important:: Join our `community slack `_ to discuss Ray/RLlib! +.. tip:: Join our `community slack `_ to discuss Ray/RLlib! RLlib in 60 seconds ------------------- diff --git a/doc/source/tune/_tutorials/tune-tutorial.rst b/doc/source/tune/_tutorials/tune-tutorial.rst index c1b84d206..a17927ddc 100644 --- a/doc/source/tune/_tutorials/tune-tutorial.rst +++ b/doc/source/tune/_tutorials/tune-tutorial.rst @@ -66,7 +66,7 @@ We can then plot the performance of this trial. :start-after: __plot_begin__ :end-before: __plot_end__ -.. important:: Tune will automatically run parallel trials across all available cores/GPUs on your machine or cluster. To limit the number of cores that Tune uses, you can call ``ray.init(num_cpus=, num_gpus=)`` before ``tune.run``. +.. note:: Tune will automatically run parallel trials across all available cores/GPUs on your machine or cluster. To limit the number of cores that Tune uses, you can call ``ray.init(num_cpus=, num_gpus=)`` before ``tune.run``. Early Stopping with ASHA diff --git a/doc/source/walkthrough.rst b/doc/source/walkthrough.rst index 9959f9c20..dc6e7d070 100644 --- a/doc/source/walkthrough.rst +++ b/doc/source/walkthrough.rst @@ -191,7 +191,7 @@ Object IDs can be created in multiple ways. .. autofunction:: ray.put :noindex: -.. important:: +.. note:: Remote objects are immutable. That is, their values cannot be changed after creation. This allows remote objects to be replicated in multiple object