# evidently.metrics.data\_quality ## Submodules ## column\_correlations\_metric module ### class ColumnCorrelationsMetric(column\_name: str) Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#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: **column\_name : str** #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class ColumnCorrelationsMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: ColumnCorrelationsMetric)** **render\_json(obj: ColumnCorrelationsMetric)** ### class ColumnCorrelationsMetricResult(column\_name: str, current: Dict\[str, [ColumnCorrelations](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_quality.ColumnCorrelations)], reference: Optional\[Dict\[str, [ColumnCorrelations](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_quality.ColumnCorrelations)]] = None) Bases: `object` #### Attributes: **column\_name : str** **current : Dict\[str,** [**ColumnCorrelations**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_quality.ColumnCorrelations)**]** **reference : Optional\[Dict\[str,** [**ColumnCorrelations**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_quality.ColumnCorrelations)**]] = None** ## column\_distribution\_metric module ### class ColumnDistributionMetric(column\_name: str) Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnDistributionMetricResult`] Calculates distribution for the column #### Attributes: **column\_name : str** #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class ColumnDistributionMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: ColumnDistributionMetric)** **render\_json(obj: ColumnDistributionMetric)** ### class ColumnDistributionMetricResult(column\_name: str, current: [Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution), reference: Optional\[[Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)] = None) Bases: `object` #### Attributes: **column\_name : str** **current :** [**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution) **reference : Optional\[**[**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)**] = None** ## column\_quantile\_metric module ### class ColumnQuantileMetric(column\_name: str, quantile: float) Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnQuantileMetricResult`] Calculates quantile with specified range #### Attributes: **column\_name : str** **quantile : float** #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class ColumnQuantileMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: ColumnQuantileMetric)** **render\_json(obj: ColumnQuantileMetric)** ### class ColumnQuantileMetricResult(column\_name: str, quantile: float, current: float, current\_distribution: [Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution), reference: Optional\[float] = None, reference\_distribution: Optional\[[Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)] = None) Bases: `object` #### Attributes: **column\_name : str** **current : float** **current\_distribution :** [**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution) **quantile : float** **reference : Optional\[float] = None** **reference\_distribution : Optional\[**[**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)**] = None** ## column\_value\_list\_metric module ### class ColumnValueListMetric(column\_name: str, values: Optional\[list] = None) Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnValueListMetricResult`] Calculates count and shares of values in the predefined values list #### Attributes: **column\_name : str** **values : Optional\[list]** #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class ColumnValueListMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: ColumnValueListMetric)** **render\_json(obj: ColumnValueListMetric)** ### class ColumnValueListMetricResult(column\_name: str, values: List\[Any], current: ValueListStat, reference: Optional\[ValueListStat] = None) Bases: `object` #### Attributes: **column\_name : str** **current : ValueListStat** **reference : Optional\[ValueListStat] = None** **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: **number\_in\_list : int** **number\_not\_in\_list : int** **rows\_count : int** **share\_in\_list : float** **share\_not\_in\_list : float** **values\_in\_list : Dict\[Any, int]** **values\_not\_in\_list : Dict\[Any, int]** ## column\_value\_range\_metric module ### class ColumnValueRangeMetric(column\_name: str, left: Optional\[Union\[float, int]] = None, right: Optional\[Union\[float, int]] = None) Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnValueRangeMetricResult`] Calculates count and shares of values in the predefined values range #### Attributes: **column\_name : str** **left : Optional\[Union\[float, int]]** **right : Optional\[Union\[float, int]]** #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class ColumnValueRangeMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: ColumnValueRangeMetric)** **render\_json(obj: ColumnValueRangeMetric)** ### class ColumnValueRangeMetricResult(column\_name: str, left: Union\[float, int], right: Union\[float, int], current: ValuesInRangeStat, current\_distribution: [Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution), reference: Optional\[ValuesInRangeStat] = None, reference\_distribution: Optional\[[Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)] = None) Bases: `object` #### Attributes: **column\_name : str** **current : ValuesInRangeStat** **current\_distribution :** [**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution) **left : Union\[float, int]** **reference : Optional\[ValuesInRangeStat] = None** **reference\_distribution : Optional\[**[**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)**] = None** **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: **number\_in\_range : int** **number\_not\_in\_range : int** **number\_of\_values : int** **share\_in\_range : float** **share\_not\_in\_range : float** ## dataset\_correlations\_metric module ### 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: **abs\_max\_correlation : Optional\[float] = None** **abs\_max\_features\_correlation : Optional\[float] = None** **abs\_max\_prediction\_features\_correlation : Optional\[float] = None** **abs\_max\_target\_features\_correlation : Optional\[float] = None** **target\_prediction\_correlation : Optional\[float] = None** ### class DataQualityCorrelationMetricsRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: DatasetCorrelationsMetric)** **render\_json(obj: DatasetCorrelationsMetric)** ### class DatasetCorrelation(correlation: Dict\[str, pandas.core.frame.DataFrame], stats: Dict\[str, CorrelationStats]) Bases: `object` #### Attributes: **correlation : Dict\[str, DataFrame]** **stats : Dict\[str, CorrelationStats]** ### class DatasetCorrelationsMetric() Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`DatasetCorrelationsMetricResult`] Calculate different correlations with target, predictions and features #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class DatasetCorrelationsMetricResult(current: DatasetCorrelation, reference: Optional\[DatasetCorrelation]) Bases: `object` #### Attributes: **current : DatasetCorrelation** **reference : Optional\[DatasetCorrelation]** ## stability\_metric module ### class DataQualityStabilityMetric() Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`DataQualityStabilityMetricResult`] Calculates stability by target and prediction #### Methods: **calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)** ### class DataQualityStabilityMetricRenderer(color\_options: Optional\[[ColorOptions](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/M9iMLhGad2yNU1Kd04Dv#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: DataQualityStabilityMetric)** **render\_json(obj: DataQualityStabilityMetric)** ### class DataQualityStabilityMetricResult(number\_not\_stable\_target: Optional\[int] = None, number\_not\_stable\_prediction: Optional\[int] = None) Bases: `object` #### Attributes: **number\_not\_stable\_prediction : Optional\[int] = None** **number\_not\_stable\_target : Optional\[int] = None** --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/evidently.metrics.data_quality.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.