Metric Class

  • Reference

Represents a metric returned in a data drift analysis.

The Metric class is for internal usage only. Use the get_output method of a DataDriftDetector object to return metrics.

Metric constructor.

Inheritance
builtins.object
Metric

Constructor

Metric(name, value, extended_properties, schema_version='1.0')

Parameters

name
str
Required

The name of the metric.

value
float
Required

The value of the metric.

extended_properties
dict
Required

A dictionary of string to Python primitive type (int, float, str).

schema_version
str
default value: 1.0

Optional schema version of the metric. Set to METRIC_SCHEMA_VERSION_CUR if no specific value set.

name
str
Required

The name of the metric.

value
float
Required

The value of the metric.

extended_properties
dict
Required

A dictionary of string to Python primitive type (int, float, str).

schema_version
str
Required

Optional schema version of the metric. Set to METRIC_SCHEMA_VERSION_CUR if no specific value set.

Methods

add_extended_properties
get_extended_properties
validate_extended_properties_type

add_extended_properties 

add_extended_properties(ep)

Parameters

ep
Required

get_extended_properties 

get_extended_properties()

validate_extended_properties_type 

validate_extended_properties_type(key, value)

Parameters

key
Required
value
Required