Installation
User Guide
Examples
API Reference
GitHub
Slack
PyPI
Report a problem
Show Source
API Reference
Base
check
CheckResult
CheckResult.priority
CheckResult.value
CheckResult.header
CheckResult.display
CheckResult.conditions_results
CheckResult.check
CheckResult.display_check
CheckResult.display_from_json
CheckResult.get_header
CheckResult.have_conditions
CheckResult.have_display
CheckResult.passed_conditions
CheckResult.process_conditions
CheckResult.show
CheckResult.to_json
CheckResult.to_wandb
BaseCheck
BaseCheck.add_condition
BaseCheck.clean_conditions
BaseCheck.conditions_decision
BaseCheck.name
BaseCheck.params
BaseCheck.remove_condition
SingleDatasetBaseCheck
SingleDatasetBaseCheck.add_condition
SingleDatasetBaseCheck.clean_conditions
SingleDatasetBaseCheck.conditions_decision
SingleDatasetBaseCheck.name
SingleDatasetBaseCheck.params
SingleDatasetBaseCheck.remove_condition
SingleDatasetBaseCheck.run
SingleDatasetBaseCheck.run_logic
TrainTestBaseCheck
TrainTestBaseCheck.add_condition
TrainTestBaseCheck.clean_conditions
TrainTestBaseCheck.conditions_decision
TrainTestBaseCheck.name
TrainTestBaseCheck.params
TrainTestBaseCheck.remove_condition
TrainTestBaseCheck.run
TrainTestBaseCheck.run_logic
ModelOnlyBaseCheck
ModelOnlyBaseCheck.add_condition
ModelOnlyBaseCheck.clean_conditions
ModelOnlyBaseCheck.conditions_decision
ModelOnlyBaseCheck.name
ModelOnlyBaseCheck.params
ModelOnlyBaseCheck.remove_condition
ModelOnlyBaseCheck.run
ModelOnlyBaseCheck.run_logic
CheckFailure
CheckFailure.to_json
CheckFailure.to_wandb
ConditionResult
ConditionResult.priority
ConditionResult.is_pass
ConditionResult.category
ConditionResult.details
ConditionResult.name
ConditionResult.get_icon
ConditionResult.get_icon_char
ConditionResult.set_name
ModelComparisonContext
ModelComparisonBaseCheck
ModelComparisonBaseCheck.add_condition
ModelComparisonBaseCheck.clean_conditions
ModelComparisonBaseCheck.conditions_decision
ModelComparisonBaseCheck.name
ModelComparisonBaseCheck.params
ModelComparisonBaseCheck.remove_condition
ModelComparisonBaseCheck.run
ModelComparisonBaseCheck.run_logic
ConditionCategory
dataset
Dataset
Dataset.cat_features
Dataset.classes
Dataset.columns_info
Dataset.data
Dataset.datetime_col
Dataset.datetime_name
Dataset.features
Dataset.index_col
Dataset.index_name
Dataset.label_name
Dataset.label_type
Dataset.n_samples
Dataset.copy
Dataset.datasets_share_categorical_features
Dataset.datasets_share_date
Dataset.datasets_share_features
Dataset.datasets_share_index
Dataset.datasets_share_label
Dataset.datetime_exist
Dataset.ensure_not_empty_dataset
Dataset.from_numpy
Dataset.get_datetime_column_from_index
Dataset.index_exist
Dataset.is_categorical
Dataset.sample
Dataset.select
Dataset.train_test_split
suite
BaseSuite
BaseSuite.checks
BaseSuite.name
BaseSuite.add
BaseSuite.remove
BaseSuite.supported_checks
Suite
Suite.add
Suite.remove
Suite.run
Suite.supported_checks
ModelComparisonSuite
ModelComparisonSuite.add
ModelComparisonSuite.remove
ModelComparisonSuite.run
ModelComparisonSuite.supported_checks
SuiteResult
SuiteResult.name
SuiteResult.results
SuiteResult.save_as_html
SuiteResult.show
SuiteResult.to_json
SuiteResult.to_wandb
Checks
Distribution
TrustScoreComparison
TrustScoreComparison.add_condition
TrustScoreComparison.add_condition_mean_score_percent_decline_not_greater_than
TrustScoreComparison.clean_conditions
TrustScoreComparison.conditions_decision
TrustScoreComparison.name
TrustScoreComparison.params
TrustScoreComparison.remove_condition
TrustScoreComparison.run
TrustScoreComparison.run_logic
TrustScoreComparison Example Notebook
TrainTestFeatureDrift
TrainTestFeatureDrift.add_condition
TrainTestFeatureDrift.add_condition_drift_score_not_greater_than
TrainTestFeatureDrift.clean_conditions
TrainTestFeatureDrift.conditions_decision
TrainTestFeatureDrift.name
TrainTestFeatureDrift.params
TrainTestFeatureDrift.remove_condition
TrainTestFeatureDrift.run
TrainTestFeatureDrift.run_logic
TrainTestFeatureDrift Example Notebook
WholeDatasetDrift
WholeDatasetDrift.add_condition
WholeDatasetDrift.add_condition_overall_drift_value_not_greater_than
WholeDatasetDrift.auc_to_drift_score
WholeDatasetDrift.clean_conditions
WholeDatasetDrift.conditions_decision
WholeDatasetDrift.name
WholeDatasetDrift.params
WholeDatasetDrift.remove_condition
WholeDatasetDrift.run
WholeDatasetDrift.run_logic
WholeDatasetDrift Example Notebook
TrainTestLabelDrift
TrainTestLabelDrift.add_condition
TrainTestLabelDrift.add_condition_drift_score_not_greater_than
TrainTestLabelDrift.clean_conditions
TrainTestLabelDrift.conditions_decision
TrainTestLabelDrift.name
TrainTestLabelDrift.params
TrainTestLabelDrift.remove_condition
TrainTestLabelDrift.run
TrainTestLabelDrift.run_logic
TrainTestLabelDrift Example Notebook
Integrity
MixedNulls
MixedNulls.add_condition
MixedNulls.add_condition_different_nulls_not_more_than
MixedNulls.clean_conditions
MixedNulls.conditions_decision
MixedNulls.name
MixedNulls.params
MixedNulls.remove_condition
MixedNulls.run
MixedNulls.run_logic
MixedNulls Example Notebook
StringMismatch
StringMismatch.add_condition
StringMismatch.add_condition_no_variants
StringMismatch.add_condition_not_more_variants_than
StringMismatch.add_condition_ratio_variants_not_greater_than
StringMismatch.clean_conditions
StringMismatch.conditions_decision
StringMismatch.name
StringMismatch.params
StringMismatch.remove_condition
StringMismatch.run
StringMismatch.run_logic
StringMismatch Example Notebook
MixedDataTypes
MixedDataTypes.add_condition
MixedDataTypes.add_condition_rare_type_ratio_not_in_range
MixedDataTypes.clean_conditions
MixedDataTypes.conditions_decision
MixedDataTypes.name
MixedDataTypes.params
MixedDataTypes.remove_condition
MixedDataTypes.run
MixedDataTypes.run_logic
MixedDataTypes Example Notebook
IsSingleValue
IsSingleValue.add_condition
IsSingleValue.add_condition_not_single_value
IsSingleValue.clean_conditions
IsSingleValue.conditions_decision
IsSingleValue.name
IsSingleValue.params
IsSingleValue.remove_condition
IsSingleValue.run
IsSingleValue.run_logic
IsSingleValue Example Notebook
SpecialCharacters
SpecialCharacters.add_condition
SpecialCharacters.add_condition_ratio_of_special_characters_not_grater_than
SpecialCharacters.clean_conditions
SpecialCharacters.conditions_decision
SpecialCharacters.name
SpecialCharacters.params
SpecialCharacters.remove_condition
SpecialCharacters.run
SpecialCharacters.run_logic
SpecialCharacters Example Notebook
StringLengthOutOfBounds
StringLengthOutOfBounds.add_condition
StringLengthOutOfBounds.add_condition_number_of_outliers_not_greater_than
StringLengthOutOfBounds.add_condition_ratio_of_outliers_not_greater_than
StringLengthOutOfBounds.clean_conditions
StringLengthOutOfBounds.conditions_decision
StringLengthOutOfBounds.name
StringLengthOutOfBounds.params
StringLengthOutOfBounds.remove_condition
StringLengthOutOfBounds.run
StringLengthOutOfBounds.run_logic
StringLengthOutOfBounds Example Notebook
StringMismatchComparison
StringMismatchComparison.add_condition
StringMismatchComparison.add_condition_no_new_variants
StringMismatchComparison.add_condition_ratio_new_variants_not_greater_than
StringMismatchComparison.clean_conditions
StringMismatchComparison.conditions_decision
StringMismatchComparison.name
StringMismatchComparison.params
StringMismatchComparison.remove_condition
StringMismatchComparison.run
StringMismatchComparison.run_logic
StringMismatchComparison Example Notebook
DominantFrequencyChange
DominantFrequencyChange.add_condition
DominantFrequencyChange.add_condition_p_value_not_less_than
DominantFrequencyChange.add_condition_ratio_of_change_not_greater_than
DominantFrequencyChange.clean_conditions
DominantFrequencyChange.conditions_decision
DominantFrequencyChange.name
DominantFrequencyChange.params
DominantFrequencyChange.remove_condition
DominantFrequencyChange.run
DominantFrequencyChange.run_logic
DominantFrequencyChange Example Notebook
DataDuplicates
DataDuplicates.add_condition
DataDuplicates.add_condition_ratio_not_greater_than
DataDuplicates.clean_conditions
DataDuplicates.conditions_decision
DataDuplicates.name
DataDuplicates.params
DataDuplicates.remove_condition
DataDuplicates.run
DataDuplicates.run_logic
DataDuplicates Example Notebook
CategoryMismatchTrainTest
CategoryMismatchTrainTest.add_condition
CategoryMismatchTrainTest.add_condition_new_categories_not_greater_than
CategoryMismatchTrainTest.add_condition_new_category_ratio_not_greater_than
CategoryMismatchTrainTest.clean_conditions
CategoryMismatchTrainTest.conditions_decision
CategoryMismatchTrainTest.name
CategoryMismatchTrainTest.params
CategoryMismatchTrainTest.remove_condition
CategoryMismatchTrainTest.run
CategoryMismatchTrainTest.run_logic
CategoryMismatchTrainTest Example Notebook
NewLabelTrainTest
NewLabelTrainTest.add_condition
NewLabelTrainTest.add_condition_new_label_ratio_not_greater_than
NewLabelTrainTest.add_condition_new_labels_not_greater_than
NewLabelTrainTest.clean_conditions
NewLabelTrainTest.conditions_decision
NewLabelTrainTest.name
NewLabelTrainTest.params
NewLabelTrainTest.remove_condition
NewLabelTrainTest.run
NewLabelTrainTest.run_logic
NewLabelTrainTest Example Notebook
LabelAmbiguity
LabelAmbiguity.add_condition
LabelAmbiguity.add_condition_ambiguous_sample_ratio_not_greater_than
LabelAmbiguity.clean_conditions
LabelAmbiguity.conditions_decision
LabelAmbiguity.name
LabelAmbiguity.params
LabelAmbiguity.remove_condition
LabelAmbiguity.run
LabelAmbiguity.run_logic
LabelAmbiguity Example Notebook
Methodology
BoostingOverfit
BoostingOverfit.add_condition
BoostingOverfit.add_condition_test_score_percent_decline_not_greater_than
BoostingOverfit.clean_conditions
BoostingOverfit.conditions_decision
BoostingOverfit.name
BoostingOverfit.params
BoostingOverfit.remove_condition
BoostingOverfit.run
BoostingOverfit.run_logic
BoostingOverfit Example Notebook
UnusedFeatures
UnusedFeatures.add_condition
UnusedFeatures.add_condition_number_of_high_variance_unused_features_not_greater_than
UnusedFeatures.clean_conditions
UnusedFeatures.conditions_decision
UnusedFeatures.name
UnusedFeatures.params
UnusedFeatures.remove_condition
UnusedFeatures.run
UnusedFeatures.run_logic
UnusedFeatures Example Notebook
SingleFeatureContribution
SingleFeatureContribution.add_condition
SingleFeatureContribution.add_condition_feature_pps_not_greater_than
SingleFeatureContribution.clean_conditions
SingleFeatureContribution.conditions_decision
SingleFeatureContribution.name
SingleFeatureContribution.params
SingleFeatureContribution.remove_condition
SingleFeatureContribution.run
SingleFeatureContribution.run_logic
SingleFeatureContribution Example Notebook
SingleFeatureContributionTrainTest
SingleFeatureContributionTrainTest.add_condition
SingleFeatureContributionTrainTest.add_condition_feature_pps_difference_not_greater_than
SingleFeatureContributionTrainTest.add_condition_feature_pps_in_train_not_greater_than
SingleFeatureContributionTrainTest.clean_conditions
SingleFeatureContributionTrainTest.conditions_decision
SingleFeatureContributionTrainTest.name
SingleFeatureContributionTrainTest.params
SingleFeatureContributionTrainTest.remove_condition
SingleFeatureContributionTrainTest.run
SingleFeatureContributionTrainTest.run_logic
SingleFeatureContributionTrainTest Example Notebook
IndexTrainTestLeakage
IndexTrainTestLeakage.add_condition
IndexTrainTestLeakage.add_condition_ratio_not_greater_than
IndexTrainTestLeakage.clean_conditions
IndexTrainTestLeakage.conditions_decision
IndexTrainTestLeakage.name
IndexTrainTestLeakage.params
IndexTrainTestLeakage.remove_condition
IndexTrainTestLeakage.run
IndexTrainTestLeakage.run_logic
IndexTrainTestLeakage Example Notebook
TrainTestSamplesMix
TrainTestSamplesMix.add_condition
TrainTestSamplesMix.add_condition_duplicates_ratio_not_greater_than
TrainTestSamplesMix.clean_conditions
TrainTestSamplesMix.conditions_decision
TrainTestSamplesMix.name
TrainTestSamplesMix.params
TrainTestSamplesMix.remove_condition
TrainTestSamplesMix.run
TrainTestSamplesMix.run_logic
TrainTestSamplesMix Example Notebook
DateTrainTestLeakageDuplicates
DateTrainTestLeakageDuplicates.add_condition
DateTrainTestLeakageDuplicates.add_condition_leakage_ratio_not_greater_than
DateTrainTestLeakageDuplicates.clean_conditions
DateTrainTestLeakageDuplicates.conditions_decision
DateTrainTestLeakageDuplicates.name
DateTrainTestLeakageDuplicates.params
DateTrainTestLeakageDuplicates.remove_condition
DateTrainTestLeakageDuplicates.run
DateTrainTestLeakageDuplicates.run_logic
DateTrainTestLeakageDuplicates Example Notebook
DateTrainTestLeakageOverlap
DateTrainTestLeakageOverlap.add_condition
DateTrainTestLeakageOverlap.add_condition_leakage_ratio_not_greater_than
DateTrainTestLeakageOverlap.clean_conditions
DateTrainTestLeakageOverlap.conditions_decision
DateTrainTestLeakageOverlap.name
DateTrainTestLeakageOverlap.params
DateTrainTestLeakageOverlap.remove_condition
DateTrainTestLeakageOverlap.run
DateTrainTestLeakageOverlap.run_logic
DateTrainTestLeakageOverlap Example Notebook
IdentifierLeakage
IdentifierLeakage.add_condition
IdentifierLeakage.add_condition_pps_not_greater_than
IdentifierLeakage.clean_conditions
IdentifierLeakage.conditions_decision
IdentifierLeakage.name
IdentifierLeakage.params
IdentifierLeakage.remove_condition
IdentifierLeakage.run
IdentifierLeakage.run_logic
IdentifierLeakage Example Notebook
ModelInferenceTime
ModelInferenceTime.add_condition
ModelInferenceTime.add_condition_inference_time_is_not_greater_than
ModelInferenceTime.clean_conditions
ModelInferenceTime.conditions_decision
ModelInferenceTime.name
ModelInferenceTime.params
ModelInferenceTime.remove_condition
ModelInferenceTime.run
ModelInferenceTime.run_logic
ModelInferenceTime Example Notebook
DatasetsSizeComparison
DatasetsSizeComparison.add_condition
DatasetsSizeComparison.add_condition_test_size_not_smaller_than
DatasetsSizeComparison.add_condition_test_train_size_ratio_not_smaller_than
DatasetsSizeComparison.add_condition_train_dataset_not_smaller_than_test
DatasetsSizeComparison.clean_conditions
DatasetsSizeComparison.conditions_decision
DatasetsSizeComparison.name
DatasetsSizeComparison.params
DatasetsSizeComparison.remove_condition
DatasetsSizeComparison.run
DatasetsSizeComparison.run_logic
DatasetsSizeComparison Example Notebook
Overview
ModelInfo
ModelInfo.add_condition
ModelInfo.clean_conditions
ModelInfo.conditions_decision
ModelInfo.name
ModelInfo.params
ModelInfo.remove_condition
ModelInfo.run
ModelInfo.run_logic
ModelInfo Example Notebook
ColumnsInfo
ColumnsInfo.add_condition
ColumnsInfo.clean_conditions
ColumnsInfo.conditions_decision
ColumnsInfo.name
ColumnsInfo.params
ColumnsInfo.remove_condition
ColumnsInfo.run
ColumnsInfo.run_logic
ColumnsInfo Example Notebook
Performance
PerformanceReport
PerformanceReport.add_condition
PerformanceReport.add_condition_class_performance_imbalance_ratio_not_greater_than
PerformanceReport.add_condition_test_performance_not_less_than
PerformanceReport.add_condition_train_test_relative_degradation_not_greater_than
PerformanceReport.clean_conditions
PerformanceReport.conditions_decision
PerformanceReport.name
PerformanceReport.params
PerformanceReport.remove_condition
PerformanceReport.run
PerformanceReport.run_logic
PerformanceReport Example Notebook
ConfusionMatrixReport
ConfusionMatrixReport.add_condition
ConfusionMatrixReport.clean_conditions
ConfusionMatrixReport.conditions_decision
ConfusionMatrixReport.name
ConfusionMatrixReport.params
ConfusionMatrixReport.remove_condition
ConfusionMatrixReport.run
ConfusionMatrixReport.run_logic
ConfusionMatrixReport Example Notebook
RocReport
RocReport.add_condition
RocReport.add_condition_auc_not_less_than
RocReport.clean_conditions
RocReport.conditions_decision
RocReport.name
RocReport.params
RocReport.remove_condition
RocReport.run
RocReport.run_logic
RocReport Example Notebook
SimpleModelComparison
SimpleModelComparison.add_condition
SimpleModelComparison.add_condition_gain_not_less_than
SimpleModelComparison.clean_conditions
SimpleModelComparison.conditions_decision
SimpleModelComparison.name
SimpleModelComparison.params
SimpleModelComparison.remove_condition
SimpleModelComparison.run
SimpleModelComparison.run_logic
SimpleModelComparison Example Notebook
CalibrationScore
CalibrationScore.add_condition
CalibrationScore.clean_conditions
CalibrationScore.conditions_decision
CalibrationScore.name
CalibrationScore.params
CalibrationScore.remove_condition
CalibrationScore.run
CalibrationScore.run_logic
CalibrationScore Example Notebook
SegmentPerformance
SegmentPerformance.feature_1
SegmentPerformance.feature_2
SegmentPerformance.scorer
SegmentPerformance.max_segments
SegmentPerformance.add_condition
SegmentPerformance.clean_conditions
SegmentPerformance.conditions_decision
SegmentPerformance.name
SegmentPerformance.params
SegmentPerformance.remove_condition
SegmentPerformance.run
SegmentPerformance.run_logic
SegmentPerformance Example Notebook
RegressionSystematicError
RegressionSystematicError.add_condition
RegressionSystematicError.add_condition_systematic_error_ratio_to_rmse_not_greater_than
RegressionSystematicError.clean_conditions
RegressionSystematicError.conditions_decision
RegressionSystematicError.name
RegressionSystematicError.params
RegressionSystematicError.remove_condition
RegressionSystematicError.run
RegressionSystematicError.run_logic
RegressionSystematicError Example Notebook
RegressionErrorDistribution
RegressionErrorDistribution.add_condition
RegressionErrorDistribution.add_condition_kurtosis_not_less_than
RegressionErrorDistribution.clean_conditions
RegressionErrorDistribution.conditions_decision
RegressionErrorDistribution.name
RegressionErrorDistribution.params
RegressionErrorDistribution.remove_condition
RegressionErrorDistribution.run
RegressionErrorDistribution.run_logic
RegressionErrorDistribution Example Notebook
MultiModelPerformanceReport
MultiModelPerformanceReport.add_condition
MultiModelPerformanceReport.clean_conditions
MultiModelPerformanceReport.conditions_decision
MultiModelPerformanceReport.name
MultiModelPerformanceReport.params
MultiModelPerformanceReport.remove_condition
MultiModelPerformanceReport.run
MultiModelPerformanceReport.run_logic
MultiModelPerformanceReport Example Notebook
ModelErrorAnalysis
ModelErrorAnalysis.add_condition
ModelErrorAnalysis.add_condition_segments_performance_relative_difference_not_greater_than
ModelErrorAnalysis.clean_conditions
ModelErrorAnalysis.conditions_decision
ModelErrorAnalysis.name
ModelErrorAnalysis.params
ModelErrorAnalysis.remove_condition
ModelErrorAnalysis.run
ModelErrorAnalysis.run_logic
Model Error Analysis
Datasets
classification
breast_cancer
load_data
load_fitted_model
iris
load_data
load_fitted_model
phishing
load_data
load_fitted_model
regression
avocado
load_data
load_fitted_model
Suites
default_suites
single_dataset_integrity
train_test_leakage
train_test_validation
model_evaluation
full_suite
Utils
dataframes
validate_columns_exist
select_from_dataframe
un_numpy
features
calculate_feature_importance
calculate_feature_importance_or_none
column_importance_sorter_dict
column_importance_sorter_df
infer_categorical_features
is_categorical
ipython
is_notebook
is_widgets_enabled
metrics
task_type_check
get_gain
init_validate_scorers
get_default_scorers
ModelType
DeepcheckScorer
DeepcheckScorer.filter_nulls
DeepcheckScorer.is_negative_scorer
DeepcheckScorer.score_perfect
DeepcheckScorer.validate_fitting
plot
create_colorbar_barchart_for_check
shifted_color_map
strings
string_baseform
get_base_form_to_variants_dict
split_camel_case
split_and_keep
split_by_order
is_string_column
format_percent
format_number
format_list
get_random_string
format_datetime
get_docs_summary
get_ellipsis
to_snake_case
typing
Hashable
BasicModel
BasicModel.predict
ClassificationModel
ClassificationModel.predict
ClassificationModel.predict_proba
validation
model_type_validation
ensure_hashable_or_mutable_sequence
validate_model
ensure_dataframe_type
Errors
DeepchecksValueError
DeepchecksNotSupportedError
DeepchecksProcessError
NumberOfFeaturesLimitError
DatasetValidationError
ModelValidationError
CheckResult.check
¶
CheckResult.
check
:
BaseCheck
[source]
¶
previous
CheckResult.conditions_results
next
CheckResult.display_check