kd.metrics.EmptyState

kd.metrics.EmptyState#

class kauldron.metrics.EmptyState(
*,
parent: kauldron.metrics.base_state._MetricT = _EMPTY_TYPE.EMPTY,
)[source]

Bases: kauldron.metrics.base_state.State[kauldron.metrics.base_state._MetricT]

Empty state.

classmethod empty() kauldron.metrics.base_state.EmptyState[source]

Returns an empty instance (i.e. .merge(State.empty()) is a no-op).

merge(
other: kauldron.metrics.base_state.EmptyState,
) kauldron.metrics.base_state.EmptyState[source]

Returns a new state that is the accumulation of self and other.

Parameters:

other – A State whose intermediate values should be accumulated onto the values of self.

Returns:

A new State that accumulates the value from both self and other.

compute() dict[Any, Any][source]

Computes final metrics from intermediate values.

replace(**updates)

Returns a new object replacing the specified fields with new values.