Skip to content

Commit 70a081d

Browse files
committed
[Dashboard] Update the Ray dashboard documentation to explain memory view. (#8945)
1 parent 925e9ac commit 70a081d

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/source/ray-dashboard.rst

+33
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ The logical view shows you:
5656
.. image:: https://raw.githubusercontent.com/ray-project/Images/master/docs/dashboard/Logical-view-basic.png
5757
:align: center
5858

59+
Memory View
60+
~~~~~~~~~~~~
61+
The memory view shows you:
62+
63+
- The state of Ray objects, including their size, reference type, and call site.
64+
- A summary of reference types and object sizes in use.
65+
66+
.. image:: https://raw.githubusercontent.com/ray-project/images/master/docs/dashboard/Memory-view-basic.png
67+
:align: center
68+
5969
Ray Config
6070
~~~~~~~~~~
6171
The ray config tab shows you the current autoscaler configuration.
@@ -124,6 +134,11 @@ As a result, the rest of ``Actor1`` will be pending.
124134
You can also see it is infeasible to create ``Actor2`` because it requires 4 GPUs which
125135
is bigger than the total gpus available in this cluster (2 GPUs).
126136

137+
Debugging ObjectStoreFullError and Memory Leak
138+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139+
You can view information for Ray objects in the memory tab. It is useful to debug memory leaks, especially `ObjectStoreFullError`.
140+
Note that this is the same information as displayed in the `ray memory command <https://docs.ray.io/en/latest/memory-management.html#debugging-using-ray-memory>`_. For details about the information contained in the table, please see the `ray memory` documentation.
141+
127142
Inspect Memory Usage
128143
~~~~~~~~~~~~~~~~~~~~
129144
You can detect local memory anomalies through the Logical View tab. If NumObjectIdsInScope,
@@ -291,6 +306,24 @@ You can see that the dashboard shows the parent/child relationship as expected.
291306
.. image:: https://raw.githubusercontent.com/ray-project/Images/master/docs/dashboard/Logical-view-basic.png
292307
:align: center
293308

309+
Memory
310+
~~~~~~
311+
**Pause Collection**: A button to stop/continue updating Ray memory tables.
312+
313+
**IP Address**: Node IP Address where a Ray object is pinned.
314+
315+
**Pid**: ID of a process where a Ray object is being used.
316+
317+
**Type**: Type of a process. It is either a driver or worker.
318+
319+
**Object ID**: Object ID of a Ray object.
320+
321+
**Object Size** Object Size of a Ray object in bytes.
322+
323+
**Reference Type**: Reference types of Ray objects. Checkout the `ray memory command <https://docs.ray.io/en/latest/memory-management.html#debugging-using-ray-memory>`_ to learn each reference type.
324+
325+
**Call Site**: Call site where this Ray object is referenced.
326+
294327
Ray Config
295328
~~~~~~~~~~~~
296329
If you are using the autoscaler, this Configuration defined at ``cluster.yaml`` is shown.

0 commit comments

Comments
 (0)