Metric Class
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.
Constructor
Metric(name, value, extended_properties, schema_version='1.0')Parameters
| Name | Description |
|---|---|
|
name
Required
|
The name of the metric. |
|
value
Required
|
The value of the metric. |
|
extended_properties
Required
|
A dictionary of string to Python primitive type (int, float, str). |
|
schema_version
|
Optional schema version of the metric. Set to METRIC_SCHEMA_VERSION_CUR if no specific value set. Default value: 1.0
|
|
name
Required
|
The name of the metric. |
|
value
Required
|
The value of the metric. |
|
extended_properties
Required
|
A dictionary of string to Python primitive type (int, float, str). |
|
schema_version
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
| Name | Description |
|---|---|
|
ep
Required
|
|
get_extended_properties
get_extended_properties()validate_extended_properties_type
validate_extended_properties_type(key, value)Parameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
value
Required
|
|