Evidently AI is a library that helps analyze machine learning models during testing or monitoring production.
The tool generates interactive visual reports and JSON profiles from pandas DataFrame or csv files. There are currently 6 reports available:
- Data Drift – detects changes in feature distribution
- Numerical Target Drift – detects numerical target changes and feature behavior
- Categorical Target Drift – detects changes in categorical target and feature behavior
- Regression Model Performance – analyzes regression model performance and model errors
- Classification Model Performance – Analyzes the performance and errors of the classification model. Works for both binary and multiclass models.
- Probabilistic Classification Model Performance – Analyzes the performance of a probabilistic classification model, the quality of model calibration, and model errors. Works for both binary and multiclass models.
A metric is a component that evaluates a specific aspect of data or model quality.
A metrics preset is a pre-built report that aggregates metrics for a specific use case (for example, DataDriftPreset, RegressionPreset, etc.).
How it works?
Generate a report on reference and current datasets
- Reference dataset is the base dataset for comparison. This could be a training set or previous production data.
- Current dataset – the second dataset compared with the base one. It may contain the latest production data.
Implementation of custom metrics
There are times in work when you need to monitor metrics that are not available in Evidently. For example, in telecom they really like the lift metric. Business loves her and understands her very well. You can read more about lift metrics here.
To add a new metric you need to do two things:
- Implement metric
- Add visualization to plotly – optional
The official documentation has an example of implementing a custom metric: https://docs.evidentlyai.com/user-guide/customization/add-custom-metric-or-test
But we will take a more complicated route and implement the metric directly in Evidently in order to then make a pull request
Where to add:
- /src/evidently/calculations – add a metric depending on the task (classification, regression, etc.)
- /src/evidently/metrics — add code for calculating metrics depending on the task
- /src/evidently/renderers/html_widgets.py – visualization of metrics
- /src/evidently/metrics/init.py — initialize metrics
- /src/evidently/metric_results.py – add visualization
The metric code can be viewed in the already accepted pull request
#probabilistic binary classification
classification_report = Report(metrics=[
Course Machine Learning and MLOps