Files
ray-project--ray/python/ray/util/iter_metrics.py
T
2026-07-13 13:17:40 +08:00

70 lines
2.2 KiB
Python

import collections
from typing import List
from ray.util.annotations import Deprecated
from ray.util.timer import _Timer
@Deprecated
class MetricsContext:
"""Metrics context object for a local iterator.
This object is accessible by all operators of a local iterator. It can be
used to store and retrieve global execution metrics for the iterator.
It can be accessed by calling LocalIterator.get_metrics(), which is only
allowable inside iterator functions.
Attributes:
counters: dict storing increasing metrics.
timers: dict storing latency timers.
info: dict storing misc metric values.
current_actor: reference to the actor handle that
produced the current iterator output. This is automatically set
for gather_async().
"""
def __init__(self):
self.counters = collections.defaultdict(int)
self.timers = collections.defaultdict(_Timer)
self.info = {}
self.current_actor = None
def save(self):
"""Return a serializable copy of this context."""
return {
"counters": dict(self.counters),
"info": dict(self.info),
"timers": None, # TODO(ekl) consider persisting timers too
}
def restore(self, values):
"""Restores state given the output of save()."""
self.counters.clear()
self.counters.update(values["counters"])
self.timers.clear()
self.info = values["info"]
@Deprecated
class SharedMetrics:
"""Holds an indirect reference to a (shared) metrics context.
This is used by LocalIterator.union() to point the metrics contexts of
entirely separate iterator chains to the same underlying context."""
def __init__(
self, metrics: MetricsContext = None, parents: List["SharedMetrics"] = None
):
self.metrics = metrics or MetricsContext()
self.parents = parents or []
self.set(self.metrics)
def set(self, metrics):
"""Recursively set self and parents to point to the same metrics."""
self.metrics = metrics
for parent in self.parents:
parent.set(metrics)
def get(self):
return self.metrics