Note
Click here to download the full example code
Train Test Prediction Drift#
This notebooks provides an overview for using and understanding the vision prediction drift check.
Structure:
What Is Prediction Drift?#
Drift is simply a change in the distribution of data over time, and it is also one of the top reasons why machine learning model’s performance degrades over time.
Prediction drift is when drift occurs in the prediction itself. Calculating prediction drift is especially useful in cases in which labels are not available for the test dataset, and so a drift in the predictions is a direct indication that a change that happened in the data has affected the model’s predictions. If labels are available, it’s also recommended to run the Label Drift check.
For more information on drift, please visit our drift guide
How Deepchecks Detects Prediction Drift#
This check detects prediction drift by using univariate measures on the prediction properties.
Using Prediction Properties to Detect Prediction Drift#
In computer vision specifically, our predictions may be complex, and measuring their drift is not a straightforward task. Therefore, we calculate drift on different properties of the prediction, on which we can directly measure drift.
Which Prediction Properties Are Used?#
Task Type |
Property name |
What is it |
|---|---|---|
Classification |
Samples Per Class |
Number of images per class |
Object Detection |
Samples Per Class |
Number of bounding boxes per class |
Object Detection |
Bounding Box Area |
Area of bounding box (height * width) |
Object Detection |
Number of Bounding Boxes Per Image |
Number of bounding box objects in each image |
Run the Check on a Classification Task (MNIST)#
Imports#
from deepchecks.vision.checks import TrainTestPredictionDrift
from deepchecks.vision.datasets.classification.mnist import (load_dataset,
load_model)
Loading data and model:#
train_ds = load_dataset(train=True, batch_size=64, object_type='VisionData')
test_ds = load_dataset(train=False, batch_size=64, object_type='VisionData')
model = load_model()
Running TrainTestLabelDrift on classification#
check = TrainTestPredictionDrift()
result = check.run(train_ds, test_ds, model)
result
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:00]
Ingesting Batches - Train Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############# | 13/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################9 | 29/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################################ | 76/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################################################ | 92/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################################################################ | 108/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################################################################################ | 124/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################################################################### | 139/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################################################################################### | 155/157 [Time: 00:01]
Ingesting Batches - Train Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################ | 16/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################ | 32/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################ | 48/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################################ | 64/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################################################ | 80/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################################################################ | 96/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|###############################################################################################################9 | 112/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################################################################################################ | 128/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|################################################################################################################################################ | 144/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
If you have a GPU, you can speed up this check by passing it as an argument to .run() as device=<your GPU>
To display the results in an IDE like PyCharm, you can use the following code:
# result.show_in_window()
The result will be displayed in a new window.
Understanding the results#
We can see there is almost no drift between the train & test labels. This means the split to train and test was good (as it is balanced and random). Let’s check the performance of a simple model trained on MNIST.
from deepchecks.vision.checks import ClassPerformance
ClassPerformance().run(train_ds, test_ds, model)
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:00]
Ingesting Batches - Train Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################## | 46/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################# | 61/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################################ | 76/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################### | 91/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################################## | 106/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################################################## | 122/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################################################### | 137/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################################################################## | 152/157 [Time: 00:01]
Ingesting Batches - Train Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
MNIST with label drift#
Now, let’s try to separate the MNIST dataset in a different manner that will result in a prediction drift, and see how it affects the performance. We are going to create a custom collate_fn in the test dataset, that will select samples with class 0 in a 1/10 chances.
import torch
mnist_dataloader_train = load_dataset(train=True, batch_size=64, object_type='DataLoader')
mnist_dataloader_test = load_dataset(train=False, batch_size=64, object_type='DataLoader')
full_mnist = torch.utils.data.ConcatDataset([mnist_dataloader_train.dataset, mnist_dataloader_test.dataset])
train_dataset, test_dataset = torch.utils.data.random_split(full_mnist, [60000,10000], generator=torch.Generator().manual_seed(42))
Inserting drift to the test set#
import numpy as np
from torch.utils.data._utils.collate import default_collate
np.random.seed(42)
images, labels = next(iter(mnist_dataloader_test))
def collate_test(batch):
modified_batch = []
for item in batch:
image, label = item
if label == 0:
if np.random.randint(5) == 0:
modified_batch.append(item)
else:
modified_batch.append((images[0], 1))
else:
modified_batch.append(item)
return default_collate(modified_batch)
mod_train_loader = torch.utils.data.DataLoader(train_dataset, batch_size=64)
mod_test_loader = torch.utils.data.DataLoader(test_dataset, batch_size=64, collate_fn=collate_test)
from deepchecks.vision.datasets.classification.mnist import MNISTData
mod_train_ds = MNISTData(mod_train_loader)
mod_test_ds = MNISTData(mod_test_loader)
Run the check#
check = TrainTestPredictionDrift()
result = check.run(mod_train_ds, mod_test_ds, model)
result
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:00]
Ingesting Batches - Train Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Train Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
Add a condition#
We could also add a condition to the check to alert us to changes in the prediction distribution, such as the one that occurred here.
check = TrainTestPredictionDrift().add_condition_drift_score_less_than()
result = check.run(mod_train_ds, mod_test_ds, model)
result
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:00]
Ingesting Batches - Train Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Train Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
As we can see, the condition alerts us to the present of drift in the prediction.
Results#
We can see the check successfully detects the (expected) drift in class 0 distribution between the train and test sets. It means the the model correctly predicted 0 for those samples and so we’re seeing drift in the predictions as well as the labels. We note that this check enabled us to detect the presence of label drift (in this case) without needing actual labels for the test data.
But how does this affect the performance of the model?#
result = ClassPerformance().run(mod_train_ds, mod_test_ds, model)
result
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:00]
Ingesting Batches - Train Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Train Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Train Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
| | 0/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############### | 15/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################## | 30/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################# | 45/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|############################################################ | 60/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################### | 75/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|########################################################################################## | 90/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################### | 105/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|######################################################################################################################## | 120/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|####################################################################################################################################### | 135/157 [Time: 00:00]
Ingesting Batches - Test Dataset:
|###################################################################################################################################################### | 150/157 [Time: 00:01]
Ingesting Batches - Test Dataset:
|#############################################################################################################################################################| 157/157 [Time: 00:01]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
Inferring the results#
# We can see the drop in the precision of class 0, which was caused by the class
# imbalance indicated earlier by the label drift check.
Run the Check on an Object Detection Task (COCO)#
from deepchecks.vision.datasets.detection.coco import load_dataset, load_model
train_ds = load_dataset(train=True, object_type='VisionData')
test_ds = load_dataset(train=False, object_type='VisionData')
model = load_model(pretrained=True)
check = TrainTestPredictionDrift()
result = check.run(train_ds, test_ds, model)
result
Validating Input:
| | 0/1 [Time: 00:00]
Validating Input:
|#####| 1/1 [Time: 00:09]
Validating Input:
|#####| 1/1 [Time: 00:09]
Ingesting Batches - Train Dataset:
| | 0/2 [Time: 00:00]
Ingesting Batches - Train Dataset:
|##5 | 1/2 [Time: 00:04]
Ingesting Batches - Train Dataset:
|#####| 2/2 [Time: 00:09]
Ingesting Batches - Train Dataset:
|#####| 2/2 [Time: 00:09]
Ingesting Batches - Test Dataset:
| | 0/2 [Time: 00:00]
Ingesting Batches - Test Dataset:
|##5 | 1/2 [Time: 00:04]
Ingesting Batches - Test Dataset:
|#####| 2/2 [Time: 00:09]
Ingesting Batches - Test Dataset:
|#####| 2/2 [Time: 00:09]
Computing Check:
| | 0/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
Computing Check:
|#####| 1/1 [Time: 00:00]
Prediction drift is detected!#
We can see that the COCO128 contains a drift in the out of the box dataset. In addition to the prediction count per class, the prediction drift check for object detection tasks include drift calculation on certain measurements, like the bounding box area and the number of bboxes per image.
Total running time of the script: ( 0 minutes 41.729 seconds)