swarmauri.core.metrics.IMetricCalculate module

class swarmauri.core.metrics.IMetricCalculate.IMetricCalculate[source]

Bases: ABC

abstract calculate(**kwargs)[source]

Calculate the metric based on the provided data.

Parameters:

  • *args – Variable length argument list that the metric calculation might require.

  • **kwargs – Arbitrary keyword arguments that the metric calculation might require.

Return type:

Any

abstract update(value)[source]

Update the metric value based on new information.

Parameters:

  • value – The new information used to update the metric. This could be a new

  • value. (measurement or data point that affects the metric's current)

Return type:

None

Note

This method is intended for internal use and should not be publicly accessible.