[data] documentation for ray data metrics#58610
[data] documentation for ray data metrics#58610richardliaw merged 3 commits intoray-project:masterfrom
Conversation
Signed-off-by: iamjustinhsu <jhsu@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for Ray Data's Prometheus metrics, which will greatly help users in monitoring their data workloads. The structure is clear and the information is comprehensive. I've provided a few suggestions to enhance the accuracy and clarity of some metric descriptions and to remove a redundant note, ensuring the documentation is as precise as possible.
| * - `data_freed_bytes` | ||
| - Bytes freed by dataset operators | ||
| * - `data_current_bytes` | ||
| - Bytes in the memory store used by dataset operators |
There was a problem hiding this comment.
For clarity and consistency with Ray's terminology, it's better to use 'object store memory' instead of 'memory store'.
| - Bytes in the memory store used by dataset operators | |
| - Bytes of object store memory used by dataset operators |
| * - `average_bytes_inputs_per_task` | ||
| - Average size in bytes of ref bundles passed to tasks, or `None` if no tasks submitted | ||
| * - `average_rows_inputs_per_task` | ||
| - Average number of rows passed in to the task, or `None` if no task submitted |
There was a problem hiding this comment.
To be more precise and consistent with the source code documentation, it's better to specify that this is the average number of rows in the input blocks.
| - Average number of rows passed in to the task, or `None` if no task submitted | |
| - Average number of rows in input blocks per task, or `None` if no task submitted |
| * - `rows_task_outputs_generated` | ||
| - Number of output rows generated by tasks | ||
| * - `row_outputs_taken` | ||
| - Number of rows taken by downstream operators |
There was a problem hiding this comment.
Adding 'that are already' makes the description more precise, aligning it better with the source code's description.
| - Number of rows taken by downstream operators | |
| - Number of rows that are already taken by downstream operators |
| * - `row_outputs_taken` | ||
| - Number of rows taken by downstream operators | ||
| * - `block_outputs_taken` | ||
| - Number of blocks taken by downstream operators |
There was a problem hiding this comment.
Adding 'that are already' makes the description more precise, aligning it better with the source code's description.
| - Number of blocks taken by downstream operators | |
| - Number of blocks that are already taken by downstream operators |
| * - `block_outputs_taken` | ||
| - Number of blocks taken by downstream operators | ||
| * - `num_outputs_taken` | ||
| - Number of output blocks taken by downstream operators |
There was a problem hiding this comment.
Adding 'that are already' makes the description more precise, aligning it better with the source code's description.
| - Number of output blocks taken by downstream operators | |
| - Number of output blocks that are already taken by downstream operators |
| * - `num_outputs_taken` | ||
| - Number of output blocks taken by downstream operators | ||
| * - `bytes_outputs_taken` | ||
| - Byte size of output blocks taken by downstream operators |
There was a problem hiding this comment.
Adding 'that are already' makes the description more precise, aligning it better with the source code's description.
| - Byte size of output blocks taken by downstream operators | |
| - Byte size of output blocks that are already taken by downstream operators |
| * - `bytes_outputs_taken` | ||
| - Byte size of output blocks taken by downstream operators | ||
| * - `num_outputs_of_finished_tasks` | ||
| - Number of generated output blocks from finished tasks |
There was a problem hiding this comment.
Adding 'that are' makes the description more precise, aligning it better with the source code's description.
| - Number of generated output blocks from finished tasks | |
| - Number of generated output blocks that are from finished tasks |
| * - `task_completion_time` | ||
| - Histogram of time spent running tasks to completion | ||
| * - `block_completion_time` | ||
| - Histogram of time spent running a single block to completion |
There was a problem hiding this comment.
The source code mentions an important detail about how this metric is approximated when multiple blocks are generated per task. It would be beneficial to include this in the documentation for accuracy.
| - Histogram of time spent running a single block to completion | |
| - Histogram of time spent running a single block to completion. If multiple blocks are generated per task, this is approximated by assuming each block took an equal amount of time to process. |
| .. note:: | ||
| Most metrics are only available for physical operators that use the map operation, such as operators created by :meth:`~ray.data.Dataset.map_batches`, :meth:`~ray.data.Dataset.map`, and :meth:`~ray.data.Dataset.flat_map`. |
There was a problem hiding this comment.
This note is redundant as a similar note is already present at a higher level in the document (line 53), which applies to this section as well. Removing this duplication will improve the document's clarity.
ray-gardener
bot
added
docs
…/ray-data-metrics-documentation
richardliaw
left a comment
richardliaw
left a comment
There was a problem hiding this comment.
I wonder if you can automatically generate this in the future like what we do for all of our API docs
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com> Signed-off-by: Justin Miller <justinrmiller@gmail.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com> Signed-off-by: YK <1811651+ykdojo@users.noreply.github.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
## Description Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics. ## Related issues None ## Additional information None --------- Signed-off-by: iamjustinhsu <jhsu@anyscale.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
2 participants
Description
Adds ray data metrics documentation for visibility. This should be periodically updated with the latest metrics.
Related issues
None
Additional information
None