Metadata Segments Performance#

This notebook provides an overview for using and understanding the metadata segment performance check.


What is the purpose of the check?#

The check is designed to help you easily identify the model’s weakest segments based on the provided metadata. In addition, it enables to provide a sublist of the metadata columns, thus limiting the check to search in interesting subspaces.

Automatically detecting weak segments#

The check contains several steps:

  1. We calculate loss for each sample in the dataset using the provided model via either log-loss or MSE according to the task type.

  2. We train multiple simple tree based models, each one is trained using exactly two metadata columns (out of the ones selected above) to predict the per sample error calculated before.

  3. We extract the corresponding data samples for each of the leaves in each of the trees (data segments) and calculate the model performance on them. For the weakest data segments detected we also calculate the model’s performance on data segments surrounding them.

Generate data & model#

from deepchecks.nlp.datasets.classification.tweet_emotion import load_data, load_precalculated_predictions

_, test_dataset = load_data(data_format='TextData')
_, test_probas = load_precalculated_predictions(pred_format='probabilities')

user_age gender days_on_platform user_region
0 30.73 Male 5614 Americas
1 42.29 Female 4308 Europe
2 35.07 Female 4631 Europe

Run the check#

The check has several key parameters (that are all optional) that affect the behavior of the check and especially its output.

columns / ignore_columns: Controls which columns should be searched for weak segments. By default, uses all columns.

alternative_scorer: Determines the metric to be used as the performance measurement of the model on different segments. It is important to select a metric that is relevant to the data domain and task you are performing. For additional information on scorers and how to use them see Metrics Guide.

segment_minimum_size_ratio: Determines the minimum size of segments that are of interest. The check will return data segments that contain at least this fraction of the total data samples. It is recommended to try different configurations of this parameter as larger segments can be of interest even the model performance on them is superior.

categorical_aggregation_threshold: By default the check will combine rare categories into a single category called “Other”. This parameter determines the frequency threshold for categories to be mapped into to the “other” category.

multiple_segments_per_column: If True, will allow the same metadata column to be a segmenting column in multiple segments, otherwise each metadata column can appear in one segment at most. True by default.

see API reference for more details.

from deepchecks.nlp.checks import MetadataSegmentsPerformance
from sklearn.metrics import make_scorer, f1_score

scorer = {'f1': make_scorer(f1_score, average='micro')}
check = MetadataSegmentsPerformance(alternative_scorer=scorer,
result =, probabilities=test_probas)
Metadata Segments Performance

Observe the check’s output#

We see in the results that the check indeed found several segments on which the model performance is below average. In the heatmap display we can see model performance on the weakest segments and their environment with respect to the two features that are relevant to the segment. In order to get the full list of weak segments found we will inspect the result.value attribute. Shown below are the 3 segments with the worst performance.

f1 Score Feature1 Feature1 Range Feature2 Feature2 Range % of Data Samples in Segment
0 0.305085 user_region [Americas] days_on_platform (-inf, 843.0) 5.97 [37, 57, 77, 86, 108, 111, 121, 123, 135, 146,...
1 0.310345 user_region [Europe] user_age (-inf, 21.420000076293945) 4.40 [5, 24, 113, 160, 177, 220, 230, 275, 285, 292...
2 0.510101 days_on_platform (-inf, 628.5) None 10.01 [25, 37, 47, 58, 77, 86, 92, 111, 121, 123, 13...

Define a condition#

We can add a condition that will validate the model’s performance on the weakest segment detected is above a certain threshold. A scenario where this can be useful is when we want to make sure that the model is not under performing on a subset of the data that is of interest to us, for example for specific age or gender groups.

# Let's add a condition and re-run the check:

result =, probabilities=test_probas)
Metadata Segments Performance

Total running time of the script: (0 minutes 2.790 seconds)

Gallery generated by Sphinx-Gallery