# evidently.metrics.data\_quality

## Submodules

## column\_correlations\_metric module <a href="#module-evidently.metrics.data_quality.column_correlations_metric" id="module-evidently.metrics.data_quality.column_correlations_metric"></a>

### class ColumnCorrelationsMetric(column\_name: str)

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`ColumnCorrelationsMetricResult`]

Calculates correlations between the selected column and all the other columns. In the current and reference (if presented) datasets

#### Attributes:

&#x20;    **column\_name : str**

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class ColumnCorrelationsMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: ColumnCorrelationsMetric)**

&#x20;    **render\_json(obj: ColumnCorrelationsMetric)**

### class ColumnCorrelationsMetricResult(column\_name: str, current: Dict\[str, [ColumnCorrelations](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.data_quality.ColumnCorrelations)], reference: Optional\[Dict\[str, [ColumnCorrelations](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.data_quality.ColumnCorrelations)]] = None)

Bases: `object`

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **current : Dict\[str,** [**ColumnCorrelations**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.data_quality.ColumnCorrelations)**]**

&#x20;    **reference : Optional\[Dict\[str,** [**ColumnCorrelations**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.data_quality.ColumnCorrelations)**]] = None**

## column\_distribution\_metric module <a href="#module-evidently.metrics.data_quality.column_distribution_metric" id="module-evidently.metrics.data_quality.column_distribution_metric"></a>

### class ColumnDistributionMetric(column\_name: str)

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`ColumnDistributionMetricResult`]

Calculates distribution for the column

#### Attributes:

&#x20;    **column\_name : str**

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class ColumnDistributionMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: ColumnDistributionMetric)**

&#x20;    **render\_json(obj: ColumnDistributionMetric)**

### class ColumnDistributionMetricResult(column\_name: str, current: [Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution), reference: Optional\[[Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)] = None)

Bases: `object`

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **current :** [**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)

&#x20;    **reference : Optional\[**[**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)**] = None**

## column\_quantile\_metric module <a href="#module-evidently.metrics.data_quality.column_quantile_metric" id="module-evidently.metrics.data_quality.column_quantile_metric"></a>

### class ColumnQuantileMetric(column\_name: str, quantile: float)

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`ColumnQuantileMetricResult`]

Calculates quantile with specified range

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **quantile : float**

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class ColumnQuantileMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: ColumnQuantileMetric)**

&#x20;    **render\_json(obj: ColumnQuantileMetric)**

### class ColumnQuantileMetricResult(column\_name: str, quantile: float, current: float, current\_distribution: [Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution), reference: Optional\[float] = None, reference\_distribution: Optional\[[Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)] = None)

Bases: `object`

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **current : float**

&#x20;    **current\_distribution :** [**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)

&#x20;    **quantile : float**

&#x20;    **reference : Optional\[float] = None**

&#x20;    **reference\_distribution : Optional\[**[**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)**] = None**

## column\_value\_list\_metric module <a href="#module-evidently.metrics.data_quality.column_value_list_metric" id="module-evidently.metrics.data_quality.column_value_list_metric"></a>

### class ColumnValueListMetric(column\_name: str, values: Optional\[list] = None)

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`ColumnValueListMetricResult`]

Calculates count and shares of values in the predefined values list

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **values : Optional\[list]**

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class ColumnValueListMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: ColumnValueListMetric)**

&#x20;    **render\_json(obj: ColumnValueListMetric)**

### class ColumnValueListMetricResult(column\_name: str, values: List\[Any], current: ValueListStat, reference: Optional\[ValueListStat] = None)

Bases: `object`

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **current : ValueListStat**

&#x20;    **reference : Optional\[ValueListStat] = None**

&#x20;    **values : List\[Any]**

### class ValueListStat(number\_in\_list: int, number\_not\_in\_list: int, share\_in\_list: float, share\_not\_in\_list: float, values\_in\_list: Dict\[Any, int], values\_not\_in\_list: Dict\[Any, int], rows\_count: int)

Bases: `object`

#### Attributes:

&#x20;    **number\_in\_list : int**

&#x20;    **number\_not\_in\_list : int**

&#x20;    **rows\_count : int**

&#x20;    **share\_in\_list : float**

&#x20;    **share\_not\_in\_list : float**

&#x20;    **values\_in\_list : Dict\[Any, int]**

&#x20;    **values\_not\_in\_list : Dict\[Any, int]**

## column\_value\_range\_metric module <a href="#module-evidently.metrics.data_quality.column_value_range_metric" id="module-evidently.metrics.data_quality.column_value_range_metric"></a>

### class ColumnValueRangeMetric(column\_name: str, left: Optional\[Union\[float, int]] = None, right: Optional\[Union\[float, int]] = None)

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`ColumnValueRangeMetricResult`]

Calculates count and shares of values in the predefined values range

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **left : Optional\[Union\[float, int]]**

&#x20;    **right : Optional\[Union\[float, int]]**

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class ColumnValueRangeMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: ColumnValueRangeMetric)**

&#x20;    **render\_json(obj: ColumnValueRangeMetric)**

### class ColumnValueRangeMetricResult(column\_name: str, left: Union\[float, int], right: Union\[float, int], current: ValuesInRangeStat, current\_distribution: [Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution), reference: Optional\[ValuesInRangeStat] = None, reference\_distribution: Optional\[[Distribution](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)] = None)

Bases: `object`

#### Attributes:

&#x20;    **column\_name : str**

&#x20;    **current : ValuesInRangeStat**

&#x20;    **current\_distribution :** [**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)

&#x20;    **left : Union\[float, int]**

&#x20;    **reference : Optional\[ValuesInRangeStat] = None**

&#x20;    **reference\_distribution : Optional\[**[**Distribution**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.visualizations.Distribution)**] = None**

&#x20;    **right : Union\[float, int]**

### class ValuesInRangeStat(number\_in\_range: int, number\_not\_in\_range: int, share\_in\_range: float, share\_not\_in\_range: float, number\_of\_values: int)

Bases: `object`

#### Attributes:

&#x20;    **number\_in\_range : int**

&#x20;    **number\_not\_in\_range : int**

&#x20;    **number\_of\_values : int**

&#x20;    **share\_in\_range : float**

&#x20;    **share\_not\_in\_range : float**

## dataset\_correlations\_metric module <a href="#module-evidently.metrics.data_quality.dataset_correlations_metric" id="module-evidently.metrics.data_quality.dataset_correlations_metric"></a>

### class CorrelationStats(target\_prediction\_correlation: Optional\[float] = None, abs\_max\_target\_features\_correlation: Optional\[float] = None, abs\_max\_prediction\_features\_correlation: Optional\[float] = None, abs\_max\_correlation: Optional\[float] = None, abs\_max\_features\_correlation: Optional\[float] = None)

Bases: `object`

#### Attributes:

&#x20;    **abs\_max\_correlation : Optional\[float] = None**

&#x20;    **abs\_max\_features\_correlation : Optional\[float] = None**

&#x20;    **abs\_max\_prediction\_features\_correlation : Optional\[float] = None**

&#x20;    **abs\_max\_target\_features\_correlation : Optional\[float] = None**

&#x20;    **target\_prediction\_correlation : Optional\[float] = None**

### class DataQualityCorrelationMetricsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: DatasetCorrelationsMetric)**

&#x20;    **render\_json(obj: DatasetCorrelationsMetric)**

### class DatasetCorrelation(correlation: Dict\[str, pandas.core.frame.DataFrame], stats: Dict\[str, CorrelationStats])

Bases: `object`

#### Attributes:

&#x20;    **correlation : Dict\[str, DataFrame]**

&#x20;    **stats : Dict\[str, CorrelationStats]**

### class DatasetCorrelationsMetric()

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`DatasetCorrelationsMetricResult`]

Calculate different correlations with target, predictions and features

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class DatasetCorrelationsMetricResult(current: DatasetCorrelation, reference: Optional\[DatasetCorrelation])

Bases: `object`

#### Attributes:

&#x20;    **current : DatasetCorrelation**

&#x20;    **reference : Optional\[DatasetCorrelation]**

## stability\_metric module <a href="#module-evidently.metrics.data_quality.stability_metric" id="module-evidently.metrics.data_quality.stability_metric"></a>

### class DataQualityStabilityMetric()

Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`DataQualityStabilityMetricResult`]

Calculates stability by target and prediction

#### Methods:

&#x20;    **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)**

### class DataQualityStabilityMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)

Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer)

#### Attributes:

&#x20;    **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)

#### Methods:

&#x20;    **render\_html(obj: DataQualityStabilityMetric)**

&#x20;    **render\_json(obj: DataQualityStabilityMetric)**

### class DataQualityStabilityMetricResult(number\_not\_stable\_target: Optional\[int] = None, number\_not\_stable\_prediction: Optional\[int] = None)

Bases: `object`

#### Attributes:

&#x20;    **number\_not\_stable\_prediction : Optional\[int] = None**

&#x20;    **number\_not\_stable\_target : Optional\[int] = None**