# evidently.tests
Available tests for TestSuite reports. Tests grouped into modules. For detailed information see module documentation.
## Submodules
## base\_test module
### class BaseCheckValueTest(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseConditionsTest`
Base class for all tests with checking a value condition
#### Attributes:
**value : Union\[float, int]**
#### Methods:
**abstract calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**check()**
**get\_condition()**
**abstract get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**groups()**
### class BaseConditionsTest(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `Test`, `ABC`
Base class for all tests with a condition
#### Attributes:
**condition : TestValueCondition**
### class GroupData(id: str, title: str, description: str, sort\_index: int = 0, severity: Optional\[str] = None)
Bases: `object`
#### Attributes:
**description : str**
**id : str**
**severity : Optional\[str] = None**
**sort\_index : int = 0**
**title : str**
### class GroupTypeData(id: str, title: str, values: List\[evidently.tests.base\_test.GroupData] = )
Bases: `object`
#### Attributes:
**id : str**
**title : str**
**values : List\[GroupData]**
#### Methods:
**add\_value(data: GroupData)**
### class GroupingTypes()
Bases: `object`
#### Attributes:
**ByClass = GroupTypeData(id='by\_class', title='By class', values=\[])**
**ByFeature = GroupTypeData(id='by\_feature', title='By feature', values=\[GroupData(id='no group', title='Dataset-level tests', description='Some tests cannot be grouped by feature', sort\_index=0, severity=None)])**
**TestGroup = GroupTypeData(id='test\_group', title='By test group', values=\[GroupData(id='no group', title='Ungrouped', description='Some tests don’t belong to any group under the selected condition', sort\_index=0, severity=None), GroupData(id='classification', title='Classification', description='', sort\_index=0, severity=None), GroupData(id='data\_drift', title='Data Drift', description='', sort\_index=0, severity=None), GroupData(id='data\_integrity', title='Data Integrity', description='', sort\_index=0, severity=None), GroupData(id='data\_quality', title='Data Quality', description='', sort\_index=0, severity=None), GroupData(id='regression', title='Regression', description='', sort\_index=0, severity=None)])**
**TestType = GroupTypeData(id='test\_type', title='By test type', values=\[])**
### class Test()
Bases: `object`
all fields in test class with type that is subclass of Metric would be used as dependencies of test.
#### Attributes:
**context = None**
**group : str**
**name : str**
#### Methods:
**abstract check()**
**get\_result()**
**set\_context(context)**
### class TestResult(name: str, description: str, status: str, groups: Dict\[str, str] = )
Bases: `object`
#### Attributes:
**ERROR = 'ERROR'**
**FAIL = 'FAIL'**
**SKIPPED = 'SKIPPED'**
**SUCCESS = 'SUCCESS'**
**WARNING = 'WARNING'**
**description : str**
**groups : Dict\[str, str]**
**name : str**
**status : str**
#### Methods:
**is\_passed()**
**mark\_as\_error(description: Optional\[str] = None)**
**mark\_as\_fail(description: Optional\[str] = None)**
**mark\_as\_success(description: Optional\[str] = None)**
**mark\_as\_warning(description: Optional\[str] = None)**
**set\_status(status: str, description: Optional\[str] = None)**
### class TestValueCondition(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `object`
Class for processing a value conditions - should it be less, greater than, equals and so on.
An object of the class stores specified conditions and can be used for checking a value by them.
#### Attributes:
**eq : Optional\[Union\[float, int]] = None**
**gt : Optional\[Union\[float, int]] = None**
**gte : Optional\[Union\[float, int]] = None**
**is\_in : Optional\[List\[Union\[float, int, str, bool]]] = None**
**lt : Optional\[Union\[float, int]] = None**
**lte : Optional\[Union\[float, int]] = None**
**not\_eq : Optional\[Union\[float, int]] = None**
**not\_in : Optional\[List\[Union\[float, int, str, bool]]] = None**
#### Methods:
**as\_dict()**
**check\_value(value: Union\[float, int])**
**has\_condition()**
Checks if we have a condition in the object and returns True in this case. If we have no conditions - returns False.
### generate\_column\_tests(test\_class: Type\[Test], columns: Optional\[Union\[str, list]] = None, parameters: Optional\[Dict] = None)
Function for generating tests for columns
## classification\_performance\_tests module
### class ByClassClassificationTest(label: str, probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**by\_class\_metric :** [**ClassificationQualityByClass**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.quality_by_class_metric.ClassificationQualityByClass)
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**group : str = 'classification'**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**abstract get\_value(result: dict)**
### class SimpleClassificationTest(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`
#### Attributes:
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**group : str = 'classification'**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**abstract get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class SimpleClassificationTestTopK(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTest`, `ABC`
#### Attributes:
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**probas\_threshold : Optional\[float]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
### class TestAccuracyScore(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'Accuracy Score'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestAccuracyScoreRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestAccuracyScore)**
**render\_json(obj: TestAccuracyScore)**
### class TestF1ByClass(label: str, probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `ByClassClassificationTest`
#### Attributes:
**name : str = 'F1 Score by Class'**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result: dict)**
### class TestF1ByClassRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1ByClass)**
**render\_json(obj: TestF1ByClass)**
### class TestF1Score(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'F1 Score'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestF1ScoreRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1Score)**
**render\_json(obj: TestF1Score)**
### class TestFNR(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'False Negative Rate'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestFNRRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1Score)**
**render\_json(obj: TestFNR)**
### class TestFPR(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'False Positive Rate'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestFPRRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1Score)**
**render\_json(obj: TestFPR)**
### class TestLogLoss(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'Logarithmic Loss'**
**value : Union\[float, int]**
#### Methods:
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestLogLossRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestLogLoss)**
**render\_json(obj: TestLogLoss)**
### class TestPrecisionByClass(label: str, probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `ByClassClassificationTest`
#### Attributes:
**name : str = 'Precision Score by Class'**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result: dict)**
### class TestPrecisionByClassRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestPrecisionByClass)**
**render\_json(obj: TestPrecisionByClass)**
### class TestPrecisionScore(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'Precision Score'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestPrecisionScoreRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestPrecisionScore)**
**render\_json(obj: TestPrecisionScore)**
### class TestRecallByClass(label: str, probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `ByClassClassificationTest`
#### Attributes:
**name : str = 'Recall Score by Class'**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result: dict)**
### class TestRecallByClassRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestRecallByClass)**
**render\_json(obj: TestRecallByClass)**
### class TestRecallScore(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'Recall Score'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestRecallScoreRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestRecallScore)**
**render\_json(obj: TestRecallScore)**
### class TestRocAuc(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTest`
#### Attributes:
**name : str = 'ROC AUC Score'**
**roc\_curve :** [**ClassificationRocCurve**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.roc_curve_metric.ClassificationRocCurve)
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestRocAucRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestRocAuc)**
**render\_json(obj: TestRocAuc)**
### class TestTNR(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'True Negative Rate'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestTNRRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1Score)**
**render\_json(obj: TestTNR)**
### class TestTPR(probas\_threshold: Optional\[float] = None, k: Optional\[Union\[float, int]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `SimpleClassificationTestTopK`
#### Attributes:
**condition : TestValueCondition**
**conf\_matrix :** [**ClassificationConfusionMatrix**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.confusion_matrix_metric.ClassificationConfusionMatrix)
**dummy\_metric :** [**ClassificationDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_dummy_metric.ClassificationDummyMetric)
**k : Optional\[Union\[float, int]]**
**metric :** [**ClassificationQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.classification_performance#evidently.metrics.classification_performance.classification_quality_metric.ClassificationQualityMetric)
**name : str = 'True Positive Rate'**
**probas\_threshold : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**get\_value(result:** [**DatasetClassificationQuality**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations#evidently.calculations.classification_performance.DatasetClassificationQuality)**)**
### class TestTPRRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestF1Score)**
**render\_json(obj: TestTPR)**
## data\_drift\_tests module
### class BaseDataDriftMetricsTest(columns: Optional\[List\[str]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#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: `BaseCheckValueTest`, `ABC`
#### Attributes:
**group : str = 'data\_drift'**
**metric :** [**DataDriftTable**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_drift#evidently.metrics.data_drift.data_drift_table.DataDriftTable)
#### Methods:
**check()**
### class TestAllFeaturesValueDrift(columns: Optional\[List\[str]] = None, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#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: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Create value drift tests for numeric and category features
#### Attributes:
**cat\_stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]]**
**cat\_stattest\_threshold : Optional\[float]**
**columns : Optional\[List\[str]]**
**num\_stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]]**
**num\_stattest\_threshold : Optional\[float]**
**per\_column\_stattest : Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]]]**
**per\_column\_stattest\_threshold : Optional\[Dict\[str, float]]**
**stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]]**
**stattest\_threshold : Optional\[float]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestColumnDrift(column\_name: str, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, stattest\_threshold: Optional\[float] = None)
Bases: `Test`
#### Attributes:
**column\_name : str**
**group : str = 'data\_drift'**
**metric :** [**ColumnDriftMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_drift#evidently.metrics.data_drift.column_drift_metric.ColumnDriftMetric)
**name : str = 'Drift per Column'**
#### Methods:
**check()**
### class TestColumnDriftRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnDrift)**
**render\_json(obj: TestColumnDrift)**
### class TestCustomFeaturesValueDrift(features: List\[str], stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#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: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Create value drift tests for specified features
#### Attributes:
**cat\_stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]] = None**
**cat\_stattest\_threshold : Optional\[float] = None**
**features : List\[str]**
**num\_stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]] = None**
**num\_stattest\_threshold : Optional\[float] = None**
**per\_column\_stattest : Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]]] = None**
**per\_column\_stattest\_threshold : Optional\[Dict\[str, float]] = None**
**stattest : Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]],** [**StatTest**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)**]] = None**
**stattest\_threshold : Optional\[float] = None**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestDataDriftResult(name: str, description: str, status: str, groups: Dict\[str, str] = , features: Dict\[str, Tuple\[str, float, float]] = )
Bases: `TestResult`
#### Attributes:
**features : Dict\[str, Tuple\[str, float, float]]**
### class TestNumberOfDriftedColumns(columns: Optional\[List\[str]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#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: `BaseDataDriftMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DataDriftTable**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_drift#evidently.metrics.data_drift.data_drift_table.DataDriftTable)
**name : str = 'Number of Drifted Features'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfDriftedColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfDriftedColumns)**
**render\_json(obj: TestNumberOfDriftedColumns)**
### class TestShareOfDriftedColumns(columns: Optional\[List\[str]] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, cat\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, num\_stattest: Optional\[Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#evidently.calculations.stattests.registry.StatTest)]] = None, per\_column\_stattest: Optional\[Dict\[str, Union\[str, Callable\[\[Series, Series, str, float], Tuple\[float, bool]], [StatTest](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.calculations/evidently.calculations.stattests#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: `BaseDataDriftMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DataDriftTable**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_drift#evidently.metrics.data_drift.data_drift_table.DataDriftTable)
**name : str = 'Share of Drifted Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfDriftedColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestShareOfDriftedColumns)**
**render\_json(obj: TestShareOfDriftedColumns)**
## data\_integrity\_tests module
### class BaseIntegrityByColumnsConditionTest(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**column\_name : str**
**data\_integrity\_metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**group : str = 'data\_integrity'**
#### Methods:
**groups()**
### class BaseIntegrityColumnMissingValuesTest(column\_name: str, missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**column\_name : str**
**group : str = 'data\_integrity'**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
### class BaseIntegrityMissingValuesValuesTest(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**group : str = 'data\_integrity'**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
### class BaseIntegrityOneColumnTest(column\_name: str)
Bases: `Test`, `ABC`
#### Attributes:
**column\_name : str**
**group : str = 'data\_integrity'**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
#### Methods:
**groups()**
### class BaseIntegrityValueTest(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**group : str = 'data\_integrity'**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
### class BaseTestMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
Common class for tests of missing values. Some tests have the same details visualizations.
#### Attributes:
**MISSING\_VALUES\_NAMING\_MAPPING = {None: 'Pandas nulls (None, NAN, etc.)', '': '"" (empty string)', inf: 'Numpy "inf" value', -inf: 'Numpy "-inf" value'}**
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**get\_table\_with\_missing\_values\_and\_percents\_by\_column(info:** [**TestHtmlInfo**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestHtmlInfo)**, metric\_result:** [**DatasetMissingValuesMetricResult**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetricResult)**, name: str)**
Get a table with missing values number and percents
**get\_table\_with\_number\_of\_missing\_values\_by\_one\_missing\_value(info:** [**TestHtmlInfo**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestHtmlInfo)**, current\_missing\_values: dict, reference\_missing\_values: Optional\[dict], name: str)**
### class TestAllColumnsShareOfMissingValues(columns: Optional\[List\[str]] = None)
Bases: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestColumnAllConstantValues(column\_name: str)
Bases: `BaseIntegrityOneColumnTest`
Test that there is only one unique value in a column
#### Attributes:
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'All Constant Values in a Column'**
#### Methods:
**check()**
### class TestColumnAllConstantValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnAllConstantValues)**
### class TestColumnAllUniqueValues(column\_name: str)
Bases: `BaseIntegrityOneColumnTest`
Test that there is only uniques values in a column
#### Attributes:
**column\_name : str**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'All Unique Values in a Column'**
#### Methods:
**check()**
### class TestColumnAllUniqueValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnAllUniqueValues)**
### class TestColumnNumberOfDifferentMissingValues(column\_name: str, missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityColumnMissingValuesTest`
Check a number of differently encoded missing values in one column.
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'Different Types of Missing Values in a Column'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnNumberOfDifferentMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnNumberOfDifferentMissingValues)**
Get a table with a missing value and number of the value in the dataset
**render\_json(obj: TestColumnNumberOfDifferentMissingValues)**
### class TestColumnNumberOfMissingValues(column\_name: str, missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityColumnMissingValuesTest`
Check a number of missing values in one column.
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Number of Missing Values in a Column'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnNumberOfMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestColumnNumberOfMissingValues)**
### class TestColumnRegExp(column\_name: str, reg\_exp: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**column\_name : str**
**group : str = 'data\_integrity'**
**metric :** [**ColumnRegExpMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_regexp_metric.ColumnRegExpMetric)
**name : str = 'RegExp Match'**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**groups()**
### class TestColumnRegExpRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnRegExp)**
### class TestColumnShareOfMissingValues(column\_name: str, missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityColumnMissingValuesTest`
Check a share of missing values in one column.
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Share of Missing Values in a Column'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnShareOfMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestColumnShareOfMissingValues)**
### class TestColumnsType(columns\_type: Optional\[dict] = None)
Bases: `Test`
This test compares columns type against the specified ones or a reference dataframe
**class Result name: str, description: str, status: str, groups: Dict\[str, str] = , columns\_types: Dict\[str, Tuple\[str, str]] =**
Bases: `TestResult`
#### Attributes:
**columns\_types : Dict\[str, Tuple\[str, str]]**
**check()**
**columns\_type : Optional\[dict]**
**group : str = 'data\_integrity'**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Column Types'**
### class TestColumnsTypeRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnsType)**
**render\_json(obj: TestColumnsType)**
### class TestNumberOfColumns(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
Number of all columns in the data, including utility columns (id/index, datetime, target, predictions)
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfColumns)**
**render\_json(obj: TestNumberOfColumns)**
### class TestNumberOfColumnsWithMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a number of columns with a missing value.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Number of Columns With Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfColumnsWithMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfMissingValues)**
**render\_json(obj: TestNumberOfColumnsWithMissingValues)**
### class TestNumberOfConstantColumns(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
Number of columns contained only one unique value
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Constant Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfConstantColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfConstantColumns)**
**render\_json(obj: TestNumberOfConstantColumns)**
### class TestNumberOfDifferentMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a number of different encoded missing values.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'Different Types of Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfDifferentMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfDifferentMissingValues)**
Get a table with a missing value and number of the value in the dataset
**render\_json(obj: TestNumberOfDifferentMissingValues)**
### class TestNumberOfDuplicatedColumns(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
How many columns have duplicates in the dataset
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Duplicate Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfDuplicatedColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestNumberOfDuplicatedColumns)**
### class TestNumberOfDuplicatedRows(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
How many rows have duplicates in the dataset
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Duplicate Rows'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfDuplicatedRowsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestNumberOfDuplicatedRows)**
### class TestNumberOfEmptyColumns(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
Number of columns contained all NAN values
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Empty Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfEmptyColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfEmptyColumns)**
### class TestNumberOfEmptyRows(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
Number of rows contained all NAN values
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Empty Rows'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a number of missing values.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Number of Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfMissingValues)**
**render\_json(obj: TestNumberOfMissingValues)**
### class TestNumberOfRows(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityValueTest`
Number of rows in the data
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_summary_metric.DatasetSummaryMetric)
**name : str = 'Number of Rows'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfRowsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestNumberOfRows)**
### class TestNumberOfRowsWithMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a number of rows with a missing value.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Number Of Rows With Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfRowsWithMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestNumberOfRowsWithMissingValues)**
### class TestShareOfColumnsWithMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a share of columns with a missing value.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Share of Columns With Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfColumnsWithMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfMissingValues)**
**render\_json(obj: TestShareOfColumnsWithMissingValues)**
### class TestShareOfMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a share of missing values.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'Share of Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfMissingValues)**
**render\_json(obj: TestShareOfMissingValues)**
### class TestShareOfRowsWithMissingValues(missing\_values: Optional\[list] = None, replace: bool = True, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseIntegrityMissingValuesValuesTest`
Check a share of rows with a missing value.
#### Attributes:
**condition : TestValueCondition**
**metric :** [**DatasetMissingValuesMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.dataset_missing_values_metric.DatasetMissingValuesMetric)
**name : str = 'The Share of Rows With Missing Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfRowsWithMissingValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: `BaseTestMissingValuesRenderer`
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_json(obj: TestShareOfRowsWithMissingValues)**
## data\_quality\_tests module
### class BaseDataQualityCorrelationsMetricsValueTest(method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**group : str = 'data\_quality'**
**method : str**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
### class BaseDataQualityMetricsValueTest(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**group : str = 'data\_quality'**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
### class BaseDataQualityValueListMetricsTest(column\_name: str, values: Optional\[list] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**column\_name : str**
**group : str = 'data\_quality'**
**metric :** [**ColumnValueListMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_list_metric.ColumnValueListMetric)
**values : Optional\[list]**
#### Methods:
**groups()**
### class BaseDataQualityValueRangeMetricsTest(column\_name: str, left: Optional\[float] = None, right: Optional\[float] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**column : str**
**group : str = 'data\_quality'**
**left : Optional\[float]**
**metric :** [**ColumnValueRangeMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_range_metric.ColumnValueRangeMetric)
**right : Optional\[float]**
#### Methods:
**groups()**
### class BaseFeatureDataQualityMetricsTest(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityMetricsValueTest`, `ABC`
#### Attributes:
**column\_name : str**
#### Methods:
**check()**
**groups()**
### class TestAllColumnsMostCommonValueShare(columns: Optional\[List\[str]] = None)
Bases: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Creates most common value share tests for each column in the dataset
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestCatColumnsOutOfListValues(columns: Optional\[List\[str]] = None)
Bases: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Create share of out of list values tests for category columns
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestColumnQuantile(column\_name: str, quantile: float, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`
#### Attributes:
**column\_name : str**
**group : str = 'data\_quality'**
**metric :** [**ColumnQuantileMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_quantile_metric.ColumnQuantileMetric)
**name : str = 'Quantile Value'**
**quantile : float**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
**groups()**
### class TestColumnQuantileRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnQuantile)**
### class TestColumnValueMax(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Max Value'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnValueMaxRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnValueMax)**
### class TestColumnValueMean(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Mean Value'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnValueMeanRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnValueMean)**
### class TestColumnValueMedian(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Median Value'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnValueMedianRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnValueMedian)**
### class TestColumnValueMin(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Min Value'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnValueMinRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnValueMin)**
### class TestColumnValueStd(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Standard Deviation (SD)'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestColumnValueStdRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestColumnValueStd)**
### class TestConflictPrediction()
Bases: `Test`
#### Attributes:
**group : str = 'data\_quality'**
**metric : ConflictPredictionMetric**
**name : str = 'Test number of conflicts in prediction'**
#### Methods:
**check()**
### class TestConflictTarget()
Bases: `Test`
#### Attributes:
**group : str = 'data\_quality'**
**metric : ConflictTargetMetric**
**name : str = 'Test number of conflicts in target'**
#### Methods:
**check()**
### class TestCorrelationChanges(corr\_diff: float = 0.25, method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityCorrelationsMetricsValueTest`
#### Attributes:
**corr\_diff : float**
**group : str = 'data\_quality'**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
**name : str = 'Change in Correlation'**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestCorrelationChangesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestCorrelationChanges)**
### class TestHighlyCorrelatedColumns(method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityCorrelationsMetricsValueTest`
#### Attributes:
**condition : TestValueCondition**
**method : str**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
**name : str = 'Highly Correlated Columns'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestHighlyCorrelatedColumnsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestHighlyCorrelatedColumns)**
**render\_json(obj: TestHighlyCorrelatedColumns)**
### class TestMeanInNSigmas(column\_name: str, n\_sigmas: int = 2)
Bases: `Test`
#### Attributes:
**column\_name : str**
**group : str = 'data\_quality'**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**n\_sigmas : int**
**name : str = 'Mean Value Stability'**
#### Methods:
**check()**
### class TestMeanInNSigmasRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestMeanInNSigmas)**
**render\_json(obj: TestMeanInNSigmas)**
### class TestMostCommonValueShare(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Share of the Most Common Value'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestMostCommonValueShareRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestMostCommonValueShare)**
**render\_json(obj: TestMostCommonValueShare)**
### class TestNumColumnsMeanInNSigmas(columns: Optional\[List\[str]] = None)
Bases: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Create tests of mean for all numeric columns
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestNumColumnsOutOfRangeValues(columns: Optional\[List\[str]] = None)
Bases: [`BaseGenerator`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.generators.BaseGenerator)
Creates share of out of range values tests for all numeric columns
#### Attributes:
**columns : Optional\[List\[str]]**
#### Methods:
**generate(columns\_info:** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns)**)**
### class TestNumberOfOutListValues(column\_name: str, values: Optional\[list] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityValueListMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnValueListMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_list_metric.ColumnValueListMetric)
**name : str = 'Number Out-of-List Values'**
**value : Union\[float, int]**
**values : Optional\[list]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfOutListValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfOutListValues)**
### class TestNumberOfOutRangeValues(column\_name: str, left: Optional\[float] = None, right: Optional\[float] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityValueRangeMetricsTest`
#### Attributes:
**column : str**
**condition : TestValueCondition**
**left : Optional\[float]**
**metric :** [**ColumnValueRangeMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_range_metric.ColumnValueRangeMetric)
**name : str = 'Number of Out-of-Range Values '**
**right : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfOutRangeValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfOutRangeValues)**
### class TestNumberOfUniqueValues(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Number of Unique Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestNumberOfUniqueValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestNumberOfUniqueValues)**
### class TestPredictionFeaturesCorrelations(method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityCorrelationsMetricsValueTest`
#### Attributes:
**condition : TestValueCondition**
**method : str**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
**name : str = 'Correlation between Prediction and Features'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestPredictionFeaturesCorrelationsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestTargetFeaturesCorrelations)**
**render\_json(obj: TestPredictionFeaturesCorrelations)**
### class TestShareOfOutListValues(column\_name: str, values: Optional\[list] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityValueListMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnValueListMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_list_metric.ColumnValueListMetric)
**name : str = 'Share of Out-of-List Values'**
**value : Union\[float, int]**
**values : Optional\[list]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfOutListValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestShareOfOutListValues)**
**render\_json(obj: TestShareOfOutListValues)**
### class TestShareOfOutRangeValues(column\_name: str, left: Optional\[float] = None, right: Optional\[float] = None, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityValueRangeMetricsTest`
#### Attributes:
**column : str**
**condition : TestValueCondition**
**left : Optional\[float]**
**metric :** [**ColumnValueRangeMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_range_metric.ColumnValueRangeMetric)
**name : str = 'Share of Out-of-Range Values'**
**right : Optional\[float]**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestShareOfOutRangeValuesRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestShareOfOutRangeValues)**
**render\_json(obj: TestShareOfOutRangeValues)**
### class TestTargetFeaturesCorrelations(method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityCorrelationsMetricsValueTest`
#### Attributes:
**condition : TestValueCondition**
**method : str**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
**name : str = 'Correlation between Target and Features'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestTargetFeaturesCorrelationsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestTargetFeaturesCorrelations)**
**render\_json(obj: TestTargetFeaturesCorrelations)**
### class TestTargetPredictionCorrelation(method: str = 'pearson', eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseDataQualityCorrelationsMetricsValueTest`
#### Attributes:
**condition : TestValueCondition**
**method : str**
**metric :** [**DatasetCorrelationsMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.dataset_correlations_metric.DatasetCorrelationsMetric)
**name : str = 'Correlation between Target and Prediction'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestUniqueValuesShare(column\_name: str, eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseFeatureDataQualityMetricsTest`
#### Attributes:
**column\_name : str**
**condition : TestValueCondition**
**metric :** [**ColumnSummaryMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_integrity#evidently.metrics.data_integrity.column_summary_metric.ColumnSummaryMetric)
**name : str = 'Share of Unique Values'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestUniqueValuesShareRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestUniqueValuesShare)**
### class TestValueList(column\_name: str, values: Optional\[list] = None)
Bases: `Test`
#### Attributes:
**column\_name : str**
**group : str = 'data\_quality'**
**metric :** [**ColumnValueListMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_list_metric.ColumnValueListMetric)
**name : str = 'Out-of-List Values'**
**values : Optional\[list]**
#### Methods:
**check()**
### class TestValueListRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueList)**
**render\_json(obj: TestValueList)**
### class TestValueRange(column\_name: str, left: Optional\[float] = None, right: Optional\[float] = None)
Bases: `Test`
#### Attributes:
**column : str**
**group : str = 'data\_quality'**
**left : Optional\[float]**
**metric :** [**ColumnValueRangeMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.data_quality#evidently.metrics.data_quality.column_value_range_metric.ColumnValueRangeMetric)
**name : str = 'Value Range'**
**right : Optional\[float]**
#### Methods:
**check()**
### class TestValueRangeRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueRange)**
## regression\_performance\_tests module
### class BaseRegressionPerformanceMetricsTest(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseCheckValueTest`, `ABC`
#### Attributes:
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**group : str = 'regression'**
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
### class TestValueAbsMaxError(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'Max Absolute Error'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueAbsMaxErrorRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueAbsMaxError)**
**render\_json(obj: TestValueAbsMaxError)**
### class TestValueMAE(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'Mean Absolute Error (MAE)'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueMAERenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueMAE)**
**render\_json(obj: TestValueMAE)**
### class TestValueMAPE(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'Mean Absolute Percentage Error (MAPE)'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueMAPERenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueMAPE)**
**render\_json(obj: TestValueMAPE)**
### class TestValueMeanError(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'Mean Error (ME)'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueMeanErrorRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueMeanError)**
**render\_json(obj: TestValueMeanError)**
### class TestValueR2Score(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'R2 Score'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueR2ScoreRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueR2Score)**
**render\_json(obj: TestValueAbsMaxError)**
### class TestValueRMSE(eq: Optional\[Union\[float, int]] = None, gt: Optional\[Union\[float, int]] = None, gte: Optional\[Union\[float, int]] = None, is\_in: Optional\[List\[Union\[float, int, str, bool]]] = None, lt: Optional\[Union\[float, int]] = None, lte: Optional\[Union\[float, int]] = None, not\_eq: Optional\[Union\[float, int]] = None, not\_in: Optional\[List\[Union\[float, int, str, bool]]] = None)
Bases: `BaseRegressionPerformanceMetricsTest`
#### Attributes:
**condition : TestValueCondition**
**dummy\_metric :** [**RegressionDummyMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_dummy_metric.RegressionDummyMetric)
**metric :** [**RegressionQualityMetric**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.metrics/evidently.metrics.regression_performance#evidently.metrics.regression_performance.regression_quality.RegressionQualityMetric)
**name : str = 'Root Mean Square Error (RMSE)'**
**value : Union\[float, int]**
#### Methods:
**calculate\_value\_for\_test()**
Method for getting the checking value. Define it in a child class
**get\_condition()**
**get\_description(value: Union\[float, int])**
Method for getting a description that we can use. The description can use the checked value. Define it in a child class
### class TestValueRMSERenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None)
Bases: [`TestRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.TestRenderer)
#### Attributes:
**color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)
#### Methods:
**render\_html(obj: TestValueRMSE)**
**render\_json(obj: TestValueRMSE)**
## utils module
### approx(value, relative=None, absolute=None)
Get approximate value for checking a value is equal to other within some tolerance
### dataframes\_to\_table(current: DataFrame, reference: Optional\[DataFrame], columns: List\[str], table\_id: str, sort\_by: str = 'curr', na\_position: str = 'first', asc: bool = False)
### plot\_boxes(\*, curr\_for\_plots: dict, ref\_for\_plots: Optional\[dict], color\_options: [ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions))
### plot\_check(fig, condition, color\_options: [ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions))
### plot\_conf\_mtrx(curr\_mtrx, ref\_mtrx)
### plot\_correlations(current\_correlations, reference\_correlations)
### plot\_dicts\_to\_table(dict\_curr: dict, dict\_ref: Optional\[dict], columns: list, id\_prfx: str, sort\_by: str = 'curr', asc: bool = False)
### plot\_metric\_value(fig, metric\_val: float, metric\_name: str)
### plot\_rates(\*, curr\_rate\_plots\_data: dict, ref\_rate\_plots\_data: Optional\[dict] = None, color\_options: [ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions))
### plot\_roc\_auc(\*, curr\_roc\_curve: dict, ref\_roc\_curve: Optional\[dict], color\_options: [ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions))
### plot\_value\_counts\_tables(feature\_name, values, curr\_df, ref\_df, id\_prfx)
### plot\_value\_counts\_tables\_ref\_curr(feature\_name, curr\_df, ref\_df, id\_prfx)
### regression\_perf\_plot(\*, val\_for\_plot: Dict\[str, Series], hist\_for\_plot: Dict\[str, Series], name: str, curr\_metric: float, ref\_metric: Optional\[float] = None, is\_ref\_data: bool = False, color\_options: [ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions))