Note
Click here to download the full example code
Weak Segments Performance#
This notebooks provides an overview for using and understanding the weak segment performance check.
Structure:
What is the purpose of the check?#
The check is designed to help you easily identify the model’s weakest segments in the data provided. In addition, it enables to provide a sublist of the Dataset’s features, thus limiting the check to search in interesting subspaces.
Automatically detecting weak segments#
The check contains several steps:
We calculate loss for each sample in the dataset using the provided model via either log-loss or MSE according to the task type.
Select a subset of features for the weak segment search. This is done by selecting the features with the highest feature importance to the model provided (within the features selected for check, if limited).
We train multiple simple tree based models, each one is trained using exactly two features (out of the ones selected above) to predict the per sample error calculated before.
We convert each of the leafs in each of the trees into a segment and calculate the segment’s performance. For the weakest segments detected we also calculate the model’s performance on data segments surrounding them.
Generate data & model#
from deepchecks.tabular.datasets.classification.phishing import (
load_data, load_fitted_model)
train_dataset, test_dataset = load_data()
model = load_fitted_model()
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,
a heuristic is used to determine which columns to use based solely on their feature importance.
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.
By default, the check uses Neg RMSE for regression tasks and Accuracy for classification tasks.
segment_minimum_size_ratio: Determines the minimum size of segments that are of interest. The check is tuned
to find the weakest segment regardless of the segment size and so 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.
see API reference for more details.
from deepchecks.tabular.datasets.classification import phishing
from deepchecks.tabular.checks import WeakSegmentsPerformance
from sklearn.metrics import make_scorer, f1_score
scorer = {'f1': make_scorer(f1_score, average='micro')}
_, test_ds = phishing.load_data()
model = phishing.load_fitted_model()
check = WeakSegmentsPerformance(columns=['urlLength', 'numTitles', 'ext', 'entropy'],
alternative_scorer=scorer,
segment_minimum_size_ratio=0.03,
categorical_aggregation_threshold=0.05)
result = check.run(test_ds, model)
result.show()
Default parameter min_samples_leaf will change in version 2.6.See https://github.com/scikit-learn-contrib/category_encoders/issues/327
Default parameter smoothing will change in version 2.6.See https://github.com/scikit-learn-contrib/category_encoders/issues/327
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.
result.value['weak_segments_list']
Define a condition#
We can define on our check a condition that will validate that the model performance on the weakest segment detected is greater than a specified ratio of the average model performance of the entire dataset.
# Let's add a condition and re-run the check:
check = WeakSegmentsPerformance(alternative_scorer=scorer, segment_minimum_size_ratio=0.03)
check.add_condition_segments_relative_performance_greater_than(0.1)
result = check.run(test_ds, model)
result.show(show_additional_outputs=False)
Default parameter min_samples_leaf will change in version 2.6.See https://github.com/scikit-learn-contrib/category_encoders/issues/327
Default parameter smoothing will change in version 2.6.See https://github.com/scikit-learn-contrib/category_encoders/issues/327
Total running time of the script: ( 0 minutes 42.504 seconds)