# evidently.metrics.data\_drift
## Submodules
## column\_drift\_metric module
### class ColumnDriftMetric(column\_name: str, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, stattest\_threshold: Optional\[float] = None)
Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnDriftMetricResults`]
Calculate drift metric for a column
#### Attributes:
**column\_name : str**
**stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)**]]**
**stattest\_threshold : Optional\[float]**
#### Methods:
**calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)**
**get\_parameters()**
### class ColumnDriftMetricRenderer(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: ColumnDriftMetric)**
**render\_json(obj: ColumnDriftMetric)**
### class ColumnDriftMetricResults(column\_name: str, column\_type: str, stattest\_name: str, stattest\_threshold: float, drift\_score: Union\[float, int], drift\_detected: bool, current\_distribution: [Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution), reference\_distribution: [Distribution](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution), current\_scatter: Optional\[Dict\[str, list]], x\_name: Optional\[str], plot\_shape: Optional\[Dict\[str, float]])
Bases: `object`
#### Attributes:
**column\_name : str**
**column\_type : str**
**current\_distribution :** [**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)
**current\_scatter : Optional\[Dict\[str, list]]**
**drift\_detected : bool**
**drift\_score : Union\[float, int]**
**plot\_shape : Optional\[Dict\[str, float]]**
**reference\_distribution :** [**Distribution**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.visualizations.Distribution)
**stattest\_name : str**
**stattest\_threshold : float**
**x\_name : Optional\[str]**
## column\_value\_plot module
### class ColumnValuePlot(column\_name: str)
Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`ColumnValuePlotResults`]
#### 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 ColumnValuePlotRenderer(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: ColumnValuePlot)**
**render\_json(obj: ColumnValuePlot)**
### class ColumnValuePlotResults(column\_name: str, datetime\_column\_name: Optional\[str], current\_scatter: pandas.core.frame.DataFrame, reference\_scatter: pandas.core.frame.DataFrame)
Bases: `object`
#### Attributes:
**column\_name : str**
**current\_scatter : DataFrame**
**datetime\_column\_name : Optional\[str]**
**reference\_scatter : DataFrame**
## data\_drift\_table module
### class DataDriftTable(columns: Optional\[List\[str]] = None, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]]] = None, stattest\_threshold: Optional\[float] = None, cat\_stattest\_threshold: Optional\[float] = None, num\_stattest\_threshold: Optional\[float] = None, per\_column\_stattest\_threshold: Optional\[Dict\[str, float]] = None)
Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`DataDriftTableResults`]
#### Attributes:
**columns : Optional\[List\[str]]**
**options :** [**DataDriftOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.data_drift.DataDriftOptions)
#### Methods:
**calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)**
**get\_parameters()**
### class DataDriftTableRenderer(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: DataDriftTable)**
**render\_json(obj: DataDriftTable)**
### class DataDriftTableResults(number\_of\_columns: int, number\_of\_drifted\_columns: int, share\_of\_drifted\_columns: float, dataset\_drift: bool, drift\_by\_columns: Dict\[str, [ColumnDataDriftMetrics](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_drift.ColumnDataDriftMetrics)], dataset\_columns: [DatasetColumns](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.data_operations.DatasetColumns))
Bases: `object`
#### Attributes:
**dataset\_columns :** [**DatasetColumns**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/9O7LQ1v4Gn98SSrnqpix#evidently.utils.data_operations.DatasetColumns)
**dataset\_drift : bool**
**drift\_by\_columns : Dict\[str,** [**ColumnDataDriftMetrics**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.data_drift.ColumnDataDriftMetrics)**]**
**number\_of\_columns : int**
**number\_of\_drifted\_columns : int**
**share\_of\_drifted\_columns : float**
## dataset\_drift\_metric module
### class DataDriftMetricsRenderer(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: DatasetDriftMetric)**
**render\_json(obj: DatasetDriftMetric)**
### class DatasetDriftMetric(columns: Optional\[List\[str]] = None, drift\_share: float = 0.5, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/Rb3BF2Y7DDvjAuK838aV#evidently.calculations.stattests.registry.StatTest)]]] = None, stattest\_threshold: Optional\[float] = None, cat\_stattest\_threshold: Optional\[float] = None, num\_stattest\_threshold: Optional\[float] = None, per\_column\_stattest\_threshold: Optional\[Dict\[str, float]] = None)
Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`DatasetDriftMetricResults`]
#### Attributes:
**columns : Optional\[List\[str]]**
**drift\_share : float**
**options :** [**DataDriftOptions**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ZW3IQh73672cpd3xySyJ#evidently.options.data_drift.DataDriftOptions)
#### Methods:
**calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)**
**get\_parameters()**
### class DatasetDriftMetricResults(drift\_share: float, number\_of\_columns: int, number\_of\_drifted\_columns: int, share\_of\_drifted\_columns: float, dataset\_drift: bool)
Bases: `object`
#### Attributes:
**dataset\_drift : bool**
**drift\_share : float**
**number\_of\_columns : int**
**number\_of\_drifted\_columns : int**
**share\_of\_drifted\_columns : float**
## target\_by\_features\_table module
### class TargetByFeaturesTable(columns: Optional\[List\[str]] = None)
Bases: [`Metric`](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.Metric)\[`TargetByFeaturesTableResults`]
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**calculate(data:** [**InputData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/PNL2TuiArYt5TU085k7F#evidently.metrics.base_metric.InputData)**)**
### class TargetByFeaturesTableRenderer(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: TargetByFeaturesTable)**
**render\_json(obj: TargetByFeaturesTable)**
### class TargetByFeaturesTableResults(current\_plot\_data: pandas.core.frame.DataFrame, reference\_plot\_data: pandas.core.frame.DataFrame, target\_name: Optional\[str], curr\_predictions: Optional\[[PredictionData](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.classification_performance.PredictionData)], ref\_predictions: Optional\[[PredictionData](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.classification_performance.PredictionData)], columns: List\[str], task: str)
Bases: `object`
#### Attributes:
**columns : List\[str]**
**curr\_predictions : Optional\[**[**PredictionData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.classification_performance.PredictionData)**]**
**current\_plot\_data : DataFrame**
**ref\_predictions : Optional\[**[**PredictionData**](https://docs-old.evidentlyai.com/reference/api-reference/evidently.metrics/pages/ICxNS1GschXEUCV60dnZ#evidently.calculations.classification_performance.PredictionData)**]**
**reference\_plot\_data : DataFrame**
**target\_name : Optional\[str]**
**task : str**
---
# 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_drift.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.