whylogs.core.metrics.metric_components

Module Contents

Classes

Registries
MetricComponent	A metric component is the smallest unit for a metric.
IntegralComponent	A metric component is the smallest unit for a metric.
MinIntegralComponent	A metric component is the smallest unit for a metric.
MaxIntegralComponent	A metric component is the smallest unit for a metric.
FractionalComponent	A metric component is the smallest unit for a metric.
KllComponent
HllComponent
FrequentStringsComponent
CustomComponent	Abstract base class for generic types.

Attributes

T
M

whylogs.core.metrics.metric_components.T

whylogs.core.metrics.metric_components.M

class whylogs.core.metrics.metric_components.Registries

aggregatorRegistry: Optional[whylogs.core.metrics.aggregators.AggregatorRegistry]

serializerRegistry: Optional[whylogs.core.metrics.serializers.SerializerRegistry]

deserializerRegistry: Optional[whylogs.core.metrics.deserializers.DeserializerRegistry]

class whylogs.core.metrics.metric_components.MetricComponent(value: T)

Bases: Generic[T]

A metric component is the smallest unit for a metric.

A metric might consist of multiple components. An example is distribution metric, which consists of kll sketch for histogram, mean and m2. The calculation of components could be independent or could be coupled with other components.

Parameters

value (T) –

property value: T

Return type

T

mtype: Optional[Type[T]]

type_id: int = 0

registries: Optional[Registries]

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M

class whylogs.core.metrics.metric_components.IntegralComponent(value: T)

Bases: MetricComponent[int]

A metric component is the smallest unit for a metric.

A metric might consist of multiple components. An example is distribution metric, which consists of kll sketch for histogram, mean and m2. The calculation of components could be independent or could be coupled with other components.

Parameters

value (T) –

property value: T

Return type

T

mtype

type_id: int = 0

registries: Optional[Registries]

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M

class whylogs.core.metrics.metric_components.MinIntegralComponent(value: T)

Bases: MetricComponent[int]

A metric component is the smallest unit for a metric.

A metric might consist of multiple components. An example is distribution metric, which consists of kll sketch for histogram, mean and m2. The calculation of components could be independent or could be coupled with other components.

Parameters

value (T) –

property value: T

Return type

T

mtype

type_id = 1

registries: Optional[Registries]

static min(lhs: int, rhs: int) → int

Parameters

• lhs (int) –

• rhs (int) –

Return type

int

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M

class whylogs.core.metrics.metric_components.MaxIntegralComponent(value: T)

Bases: MetricComponent[int]

A metric component is the smallest unit for a metric.

A metric might consist of multiple components. An example is distribution metric, which consists of kll sketch for histogram, mean and m2. The calculation of components could be independent or could be coupled with other components.

Parameters

value (T) –

property value: T

Return type

T

mtype

type_id = 2

registries: Optional[Registries]

static max(lhs: int, rhs: int) → int

Parameters

• lhs (int) –

• rhs (int) –

Return type

int

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M

class whylogs.core.metrics.metric_components.FractionalComponent(value: T)

Bases: MetricComponent[float]

A metric component is the smallest unit for a metric.

A metric might consist of multiple components. An example is distribution metric, which consists of kll sketch for histogram, mean and m2. The calculation of components could be independent or could be coupled with other components.

Parameters

value (T) –

property value: T

Return type

T

mtype

type_id: int = 0

registries: Optional[Registries]

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M

class whylogs.core.metrics.metric_components.KllComponent

Bases: MetricComponent[whylogs_sketching.kll_doubles_sketch]

mtype

class whylogs.core.metrics.metric_components.HllComponent

Bases: MetricComponent[whylogs_sketching.hll_sketch]

mtype

class whylogs.core.metrics.metric_components.FrequentStringsComponent

Bases: MetricComponent[whylogs_sketching.frequent_strings_sketch]

mtype

class whylogs.core.metrics.metric_components.CustomComponent(value: T)

Bases: Generic[T], MetricComponent[T]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

Parameters

value (T) –

property value: T

Return type

T

type_id

mtype: Optional[Type[T]]

registries: Optional[Registries]

set(value: T) → None

Parameters

value (T) –

Return type

None

to_protobuf() → whylogs.core.proto.MetricComponentMessage

Return type

whylogs.core.proto.MetricComponentMessage

classmethod from_protobuf(msg: whylogs.core.proto.MetricComponentMessage, registries: Optional[Registries] = None) → M

Parameters

• msg (whylogs.core.proto.MetricComponentMessage) –

• registries (Optional[Registries]) –

Return type

M