kd.metrics.NoopMetric

kd.metrics.NoopMetric#

class kauldron.metrics.NoopMetric[source]

Bases: kauldron.metrics.base.Metric

Metric that does nothing. Can be used in sweeps to remove a metric.

class State(
*,
parent: '_MetricT' = <_EMPTY_TYPE.EMPTY: 1>,
)[source]

Bases: kauldron.metrics.base_state.EmptyState

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.

replace(**updates)

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

get_state(
**kwargs: Any,
) kauldron.metrics.base.NoopMetric.State[source]
empty() kauldron.metrics.base.Metric.State[source]