[docs] [core] link to file in repo with list of accelerator types (ra…

…y-project#40504) In the docs for ray remote, I see: accelerator_type – If specified, requires that the task or actor run on a node with the specified type of accelerator. See ray.util.accelerators for accelerator types. It will be nice to have a link for ray.util.accelerators (https://github.com/ray-project/ray/blob/master/python/ray/util/accelerators/accelerators.py) Request from @sriram-anyscale. Signed-off-by: angelinalg <[email protected]>
takabayashi · Nov 2, 2023 · 0f74bc8 · 0f74bc8
1 parent 99f7671
commit 0f74bc8
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/doc/source/ray-core/accelerator-types.rst b/doc/source/ray-core/accelerator-types.rst
@@ -0,0 +1,11 @@
+:orphan:
+
+.. _accelerator_types:
+
+Accelerator Types
+=================
+
+Ray supports the following accelerator types:
+
+.. literalinclude:: ../../../python/ray/util/accelerators/accelerators.py
+    :language: python
diff --git a/python/ray/_private/worker.py b/python/ray/_private/worker.py
@@ -3281,7 +3281,7 @@ def method(self):
             By default it is empty.
         accelerator_type: If specified, requires that the task or actor run
             on a node with the specified type of accelerator.
-            See `ray.util.accelerators` for accelerator types.
+            See :ref:`accelerator types <accelerator_types>`.
         memory: The heap memory request in bytes for this task/actor,
             rounded down to the nearest integer.
         max_calls: Only for *remote functions*. This specifies the

diff --git a/python/ray/actor.py b/python/ray/actor.py
@@ -353,6 +353,7 @@ class _ActorClassMetadata:
         resources: The default resources required by the actor creation task.
         accelerator_type: The specified type of accelerator required for the
             node on which this actor runs.
+            See :ref:`accelerator types <accelerator_types>`.
         runtime_env: The runtime environment for this actor.
         scheduling_strategy: Strategy about how to schedule this actor.
         last_export_session_and_job: A pair of the last exported session
@@ -591,7 +592,7 @@ def options(self, **actor_options):
                 This is a dictionary mapping strings (resource names) to floats.
             accelerator_type: If specified, requires that the task or actor run
                 on a node with the specified type of accelerator.
-                See `ray.util.accelerators` for accelerator types.
+                See :ref:`accelerator types <accelerator_types>`.
             memory: The heap memory request in bytes for this task/actor,
                 rounded down to the nearest integer.
             object_store_memory: The object store memory request for actors only.

diff --git a/python/ray/remote_function.py b/python/ray/remote_function.py
@@ -174,7 +174,7 @@ def options(self, **task_options):
                 This is a dictionary mapping strings (resource names) to floats.
             accelerator_type: If specified, requires that the task or actor run
                 on a node with the specified type of accelerator.
-                See `ray.util.accelerators` for accelerator types.
+                See :ref:`accelerator types <accelerator_types>`.
             memory: The heap memory request in bytes for this task/actor,
                 rounded down to the nearest integer.
             object_store_memory: The object store memory request for actors only.

diff --git a/python/ray/serve/schema.py b/python/ray/serve/schema.py
@@ -185,6 +185,7 @@ class RayActorOptionsSchema(BaseModel):
         default=None,
         description=(
             "Forces replicas to run on nodes with the specified accelerator type."
+            "See :ref:`accelerator types <accelerator_types>`."
         ),
     )