general
logo
  • Getting Started
  • User Guide
  • Tabular Checks
  • Vision Checks
  • API Reference
Report a problem Show Source

API Reference

  • deepchecks.core
    • errors
      • DeepchecksValueError
      • DeepchecksNotSupportedError
      • DeepchecksProcessError
      • NumberOfFeaturesLimitError
      • DatasetValidationError
      • ModelValidationError
      • DeepchecksNotImplementedError
      • ValidationError
      • DeepchecksBaseError
      • NotEnoughSamplesError
      • DeepchecksTimeoutError
    • BaseCheck
      • BaseCheck.add_condition
      • BaseCheck.clean_conditions
      • BaseCheck.conditions_decision
      • BaseCheck.finalize_check_result
      • BaseCheck.metadata
      • BaseCheck.name
      • BaseCheck.params
      • BaseCheck.remove_condition
      • BaseCheck.run
    • CheckResult
      • CheckResult.priority
      • CheckResult.value
      • CheckResult.header
      • CheckResult.display
      • CheckResult.conditions_results
      • CheckResult.display_check
      • CheckResult.from_json
      • CheckResult.get_check_id
      • CheckResult.get_header
      • CheckResult.get_metadata
      • CheckResult.have_conditions
      • CheckResult.have_display
      • CheckResult.passed_conditions
      • CheckResult.process_conditions
      • CheckResult.save_as_html
      • CheckResult.show
      • CheckResult.to_json
      • CheckResult.to_wandb
      • CheckResult.to_widget
    • CheckFailure
      • CheckFailure.display_check
      • CheckFailure.from_json
      • CheckFailure.get_check_id
      • CheckFailure.get_header
      • CheckFailure.get_metadata
      • CheckFailure.print_traceback
      • CheckFailure.save_as_html
      • CheckFailure.show
      • CheckFailure.to_json
      • CheckFailure.to_wandb
      • CheckFailure.to_widget
    • Condition
      • Condition.name
      • Condition.function
      • Condition.params
    • ConditionResult
      • ConditionResult.is_pass
      • ConditionResult.priority
      • ConditionResult.category
      • ConditionResult.details
      • ConditionResult.name
      • ConditionResult.get_icon
      • ConditionResult.set_name
    • ConditionCategory
    • BaseSuite
      • BaseSuite.checks
      • BaseSuite.name
      • BaseSuite.add
      • BaseSuite.remove
      • BaseSuite.supported_checks
    • SuiteResult
      • SuiteResult.name
      • SuiteResult.extra_info
      • SuiteResult.results
      • SuiteResult.from_json
      • SuiteResult.get_failures
      • SuiteResult.save_as_html
      • SuiteResult.select_results
      • SuiteResult.show
      • SuiteResult.to_json
      • SuiteResult.to_wandb
      • SuiteResult.to_widget
  • deepchecks.tabular
    • checks
      • data_integrity
        • ColumnsInfo
          • ColumnsInfo.add_condition
          • ColumnsInfo.clean_conditions
          • ColumnsInfo.conditions_decision
          • ColumnsInfo.finalize_check_result
          • ColumnsInfo.metadata
          • ColumnsInfo.name
          • ColumnsInfo.params
          • ColumnsInfo.remove_condition
          • ColumnsInfo.run
          • ColumnsInfo.run_logic
        • MixedNulls
          • MixedNulls.add_condition
          • MixedNulls.add_condition_different_nulls_not_more_than
          • MixedNulls.clean_conditions
          • MixedNulls.conditions_decision
          • MixedNulls.finalize_check_result
          • MixedNulls.metadata
          • MixedNulls.name
          • MixedNulls.params
          • MixedNulls.remove_condition
          • MixedNulls.run
          • MixedNulls.run_logic
        • 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.finalize_check_result
          • StringMismatch.metadata
          • StringMismatch.name
          • StringMismatch.params
          • StringMismatch.remove_condition
          • StringMismatch.run
          • StringMismatch.run_logic
        • MixedDataTypes
          • MixedDataTypes.add_condition
          • MixedDataTypes.add_condition_rare_type_ratio_not_in_range
          • MixedDataTypes.clean_conditions
          • MixedDataTypes.conditions_decision
          • MixedDataTypes.finalize_check_result
          • MixedDataTypes.metadata
          • MixedDataTypes.name
          • MixedDataTypes.params
          • MixedDataTypes.remove_condition
          • MixedDataTypes.run
          • MixedDataTypes.run_logic
        • IsSingleValue
          • IsSingleValue.add_condition
          • IsSingleValue.add_condition_not_single_value
          • IsSingleValue.clean_conditions
          • IsSingleValue.conditions_decision
          • IsSingleValue.finalize_check_result
          • IsSingleValue.metadata
          • IsSingleValue.name
          • IsSingleValue.params
          • IsSingleValue.remove_condition
          • IsSingleValue.run
          • IsSingleValue.run_logic
        • SpecialCharacters
          • SpecialCharacters.add_condition
          • SpecialCharacters.add_condition_ratio_of_special_characters_not_grater_than
          • SpecialCharacters.clean_conditions
          • SpecialCharacters.conditions_decision
          • SpecialCharacters.finalize_check_result
          • SpecialCharacters.metadata
          • SpecialCharacters.name
          • SpecialCharacters.params
          • SpecialCharacters.remove_condition
          • SpecialCharacters.run
          • SpecialCharacters.run_logic
        • 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.finalize_check_result
          • StringLengthOutOfBounds.metadata
          • StringLengthOutOfBounds.name
          • StringLengthOutOfBounds.params
          • StringLengthOutOfBounds.remove_condition
          • StringLengthOutOfBounds.run
          • StringLengthOutOfBounds.run_logic
        • DataDuplicates
          • DataDuplicates.add_condition
          • DataDuplicates.add_condition_ratio_not_greater_than
          • DataDuplicates.clean_conditions
          • DataDuplicates.conditions_decision
          • DataDuplicates.finalize_check_result
          • DataDuplicates.metadata
          • DataDuplicates.name
          • DataDuplicates.params
          • DataDuplicates.remove_condition
          • DataDuplicates.run
          • DataDuplicates.run_logic
        • ConflictingLabels
          • ConflictingLabels.add_condition
          • ConflictingLabels.add_condition_ratio_of_conflicting_labels_not_greater_than
          • ConflictingLabels.clean_conditions
          • ConflictingLabels.conditions_decision
          • ConflictingLabels.finalize_check_result
          • ConflictingLabels.metadata
          • ConflictingLabels.name
          • ConflictingLabels.params
          • ConflictingLabels.remove_condition
          • ConflictingLabels.run
          • ConflictingLabels.run_logic
        • OutlierSampleDetection
          • OutlierSampleDetection.add_condition
          • OutlierSampleDetection.add_condition_no_outliers
          • OutlierSampleDetection.add_condition_outlier_ratio_not_greater_than
          • OutlierSampleDetection.clean_conditions
          • OutlierSampleDetection.conditions_decision
          • OutlierSampleDetection.finalize_check_result
          • OutlierSampleDetection.metadata
          • OutlierSampleDetection.name
          • OutlierSampleDetection.params
          • OutlierSampleDetection.remove_condition
          • OutlierSampleDetection.run
          • OutlierSampleDetection.run_logic
        • FeatureLabelCorrelation
          • FeatureLabelCorrelation.add_condition
          • FeatureLabelCorrelation.add_condition_feature_pps_not_greater_than
          • FeatureLabelCorrelation.clean_conditions
          • FeatureLabelCorrelation.conditions_decision
          • FeatureLabelCorrelation.finalize_check_result
          • FeatureLabelCorrelation.metadata
          • FeatureLabelCorrelation.name
          • FeatureLabelCorrelation.params
          • FeatureLabelCorrelation.remove_condition
          • FeatureLabelCorrelation.run
          • FeatureLabelCorrelation.run_logic
      • train_test_validation
        • 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.finalize_check_result
          • CategoryMismatchTrainTest.metadata
          • CategoryMismatchTrainTest.name
          • CategoryMismatchTrainTest.params
          • CategoryMismatchTrainTest.remove_condition
          • CategoryMismatchTrainTest.run
          • CategoryMismatchTrainTest.run_logic
        • 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.finalize_check_result
          • DatasetsSizeComparison.metadata
          • DatasetsSizeComparison.name
          • DatasetsSizeComparison.params
          • DatasetsSizeComparison.remove_condition
          • DatasetsSizeComparison.run
          • DatasetsSizeComparison.run_logic
        • DateTrainTestLeakageDuplicates
          • DateTrainTestLeakageDuplicates.add_condition
          • DateTrainTestLeakageDuplicates.add_condition_leakage_ratio_not_greater_than
          • DateTrainTestLeakageDuplicates.clean_conditions
          • DateTrainTestLeakageDuplicates.conditions_decision
          • DateTrainTestLeakageDuplicates.finalize_check_result
          • DateTrainTestLeakageDuplicates.metadata
          • DateTrainTestLeakageDuplicates.name
          • DateTrainTestLeakageDuplicates.params
          • DateTrainTestLeakageDuplicates.remove_condition
          • DateTrainTestLeakageDuplicates.run
          • DateTrainTestLeakageDuplicates.run_logic
        • DateTrainTestLeakageOverlap
          • DateTrainTestLeakageOverlap.add_condition
          • DateTrainTestLeakageOverlap.add_condition_leakage_ratio_not_greater_than
          • DateTrainTestLeakageOverlap.clean_conditions
          • DateTrainTestLeakageOverlap.conditions_decision
          • DateTrainTestLeakageOverlap.finalize_check_result
          • DateTrainTestLeakageOverlap.metadata
          • DateTrainTestLeakageOverlap.name
          • DateTrainTestLeakageOverlap.params
          • DateTrainTestLeakageOverlap.remove_condition
          • DateTrainTestLeakageOverlap.run
          • DateTrainTestLeakageOverlap.run_logic
        • 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.finalize_check_result
          • DominantFrequencyChange.metadata
          • DominantFrequencyChange.name
          • DominantFrequencyChange.params
          • DominantFrequencyChange.remove_condition
          • DominantFrequencyChange.run
          • DominantFrequencyChange.run_logic
        • IdentifierLeakage
          • IdentifierLeakage.add_condition
          • IdentifierLeakage.add_condition_pps_not_greater_than
          • IdentifierLeakage.clean_conditions
          • IdentifierLeakage.conditions_decision
          • IdentifierLeakage.finalize_check_result
          • IdentifierLeakage.metadata
          • IdentifierLeakage.name
          • IdentifierLeakage.params
          • IdentifierLeakage.remove_condition
          • IdentifierLeakage.run
          • IdentifierLeakage.run_logic
        • IndexTrainTestLeakage
          • IndexTrainTestLeakage.add_condition
          • IndexTrainTestLeakage.add_condition_ratio_not_greater_than
          • IndexTrainTestLeakage.clean_conditions
          • IndexTrainTestLeakage.conditions_decision
          • IndexTrainTestLeakage.finalize_check_result
          • IndexTrainTestLeakage.metadata
          • IndexTrainTestLeakage.name
          • IndexTrainTestLeakage.params
          • IndexTrainTestLeakage.remove_condition
          • IndexTrainTestLeakage.run
          • IndexTrainTestLeakage.run_logic
        • 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.finalize_check_result
          • NewLabelTrainTest.metadata
          • NewLabelTrainTest.name
          • NewLabelTrainTest.params
          • NewLabelTrainTest.remove_condition
          • NewLabelTrainTest.run
          • NewLabelTrainTest.run_logic
        • FeatureLabelCorrelationChange
          • FeatureLabelCorrelationChange.add_condition
          • FeatureLabelCorrelationChange.add_condition_feature_pps_difference_not_greater_than
          • FeatureLabelCorrelationChange.add_condition_feature_pps_in_train_not_greater_than
          • FeatureLabelCorrelationChange.clean_conditions
          • FeatureLabelCorrelationChange.conditions_decision
          • FeatureLabelCorrelationChange.finalize_check_result
          • FeatureLabelCorrelationChange.metadata
          • FeatureLabelCorrelationChange.name
          • FeatureLabelCorrelationChange.params
          • FeatureLabelCorrelationChange.remove_condition
          • FeatureLabelCorrelationChange.run
          • FeatureLabelCorrelationChange.run_logic
        • 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.finalize_check_result
          • StringMismatchComparison.metadata
          • StringMismatchComparison.name
          • StringMismatchComparison.params
          • StringMismatchComparison.remove_condition
          • StringMismatchComparison.run
          • StringMismatchComparison.run_logic
        • TrainTestFeatureDrift
          • TrainTestFeatureDrift.add_condition
          • TrainTestFeatureDrift.add_condition_drift_score_not_greater_than
          • TrainTestFeatureDrift.clean_conditions
          • TrainTestFeatureDrift.conditions_decision
          • TrainTestFeatureDrift.finalize_check_result
          • TrainTestFeatureDrift.metadata
          • TrainTestFeatureDrift.name
          • TrainTestFeatureDrift.params
          • TrainTestFeatureDrift.remove_condition
          • TrainTestFeatureDrift.run
          • TrainTestFeatureDrift.run_logic
        • TrainTestLabelDrift
          • TrainTestLabelDrift.add_condition
          • TrainTestLabelDrift.add_condition_drift_score_not_greater_than
          • TrainTestLabelDrift.clean_conditions
          • TrainTestLabelDrift.conditions_decision
          • TrainTestLabelDrift.finalize_check_result
          • TrainTestLabelDrift.metadata
          • TrainTestLabelDrift.name
          • TrainTestLabelDrift.params
          • TrainTestLabelDrift.remove_condition
          • TrainTestLabelDrift.run
          • TrainTestLabelDrift.run_logic
        • TrainTestSamplesMix
          • TrainTestSamplesMix.add_condition
          • TrainTestSamplesMix.add_condition_duplicates_ratio_not_greater_than
          • TrainTestSamplesMix.clean_conditions
          • TrainTestSamplesMix.conditions_decision
          • TrainTestSamplesMix.finalize_check_result
          • TrainTestSamplesMix.metadata
          • TrainTestSamplesMix.name
          • TrainTestSamplesMix.params
          • TrainTestSamplesMix.remove_condition
          • TrainTestSamplesMix.run
          • TrainTestSamplesMix.run_logic
        • WholeDatasetDrift
          • WholeDatasetDrift.add_condition
          • WholeDatasetDrift.add_condition_overall_drift_value_not_greater_than
          • WholeDatasetDrift.clean_conditions
          • WholeDatasetDrift.conditions_decision
          • WholeDatasetDrift.finalize_check_result
          • WholeDatasetDrift.metadata
          • WholeDatasetDrift.name
          • WholeDatasetDrift.params
          • WholeDatasetDrift.remove_condition
          • WholeDatasetDrift.run
          • WholeDatasetDrift.run_logic
      • model_evaluation
        • BoostingOverfit
          • BoostingOverfit.add_condition
          • BoostingOverfit.add_condition_test_score_percent_decline_not_greater_than
          • BoostingOverfit.clean_conditions
          • BoostingOverfit.conditions_decision
          • BoostingOverfit.finalize_check_result
          • BoostingOverfit.metadata
          • BoostingOverfit.name
          • BoostingOverfit.params
          • BoostingOverfit.remove_condition
          • BoostingOverfit.run
          • BoostingOverfit.run_logic
        • CalibrationScore
          • CalibrationScore.add_condition
          • CalibrationScore.clean_conditions
          • CalibrationScore.conditions_decision
          • CalibrationScore.finalize_check_result
          • CalibrationScore.metadata
          • CalibrationScore.name
          • CalibrationScore.params
          • CalibrationScore.remove_condition
          • CalibrationScore.run
          • CalibrationScore.run_logic
        • ConfusionMatrixReport
          • ConfusionMatrixReport.add_condition
          • ConfusionMatrixReport.clean_conditions
          • ConfusionMatrixReport.conditions_decision
          • ConfusionMatrixReport.finalize_check_result
          • ConfusionMatrixReport.metadata
          • ConfusionMatrixReport.name
          • ConfusionMatrixReport.params
          • ConfusionMatrixReport.remove_condition
          • ConfusionMatrixReport.run
          • ConfusionMatrixReport.run_logic
        • ModelErrorAnalysis
          • ModelErrorAnalysis.add_condition
          • ModelErrorAnalysis.add_condition_segments_performance_relative_difference_not_greater_than
          • ModelErrorAnalysis.clean_conditions
          • ModelErrorAnalysis.conditions_decision
          • ModelErrorAnalysis.finalize_check_result
          • ModelErrorAnalysis.metadata
          • ModelErrorAnalysis.name
          • ModelErrorAnalysis.params
          • ModelErrorAnalysis.remove_condition
          • ModelErrorAnalysis.run
          • ModelErrorAnalysis.run_logic
        • ModelInferenceTime
          • ModelInferenceTime.add_condition
          • ModelInferenceTime.add_condition_inference_time_is_not_greater_than
          • ModelInferenceTime.clean_conditions
          • ModelInferenceTime.conditions_decision
          • ModelInferenceTime.finalize_check_result
          • ModelInferenceTime.metadata
          • ModelInferenceTime.name
          • ModelInferenceTime.params
          • ModelInferenceTime.remove_condition
          • ModelInferenceTime.run
          • ModelInferenceTime.run_logic
        • ModelInfo
          • ModelInfo.add_condition
          • ModelInfo.clean_conditions
          • ModelInfo.conditions_decision
          • ModelInfo.finalize_check_result
          • ModelInfo.metadata
          • ModelInfo.name
          • ModelInfo.params
          • ModelInfo.remove_condition
          • ModelInfo.run
          • ModelInfo.run_logic
        • MultiModelPerformanceReport
          • MultiModelPerformanceReport.add_condition
          • MultiModelPerformanceReport.clean_conditions
          • MultiModelPerformanceReport.conditions_decision
          • MultiModelPerformanceReport.finalize_check_result
          • MultiModelPerformanceReport.metadata
          • MultiModelPerformanceReport.name
          • MultiModelPerformanceReport.params
          • MultiModelPerformanceReport.remove_condition
          • MultiModelPerformanceReport.run
          • MultiModelPerformanceReport.run_logic
        • 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.finalize_check_result
          • PerformanceReport.metadata
          • PerformanceReport.name
          • PerformanceReport.params
          • PerformanceReport.remove_condition
          • PerformanceReport.run
          • PerformanceReport.run_logic
        • RegressionErrorDistribution
          • RegressionErrorDistribution.add_condition
          • RegressionErrorDistribution.add_condition_kurtosis_not_less_than
          • RegressionErrorDistribution.clean_conditions
          • RegressionErrorDistribution.conditions_decision
          • RegressionErrorDistribution.finalize_check_result
          • RegressionErrorDistribution.metadata
          • RegressionErrorDistribution.name
          • RegressionErrorDistribution.params
          • RegressionErrorDistribution.remove_condition
          • RegressionErrorDistribution.run
          • RegressionErrorDistribution.run_logic
        • RegressionSystematicError
          • RegressionSystematicError.add_condition
          • RegressionSystematicError.add_condition_systematic_error_ratio_to_rmse_not_greater_than
          • RegressionSystematicError.clean_conditions
          • RegressionSystematicError.conditions_decision
          • RegressionSystematicError.finalize_check_result
          • RegressionSystematicError.metadata
          • RegressionSystematicError.name
          • RegressionSystematicError.params
          • RegressionSystematicError.remove_condition
          • RegressionSystematicError.run
          • RegressionSystematicError.run_logic
        • RocReport
          • RocReport.add_condition
          • RocReport.add_condition_auc_not_less_than
          • RocReport.clean_conditions
          • RocReport.conditions_decision
          • RocReport.finalize_check_result
          • RocReport.metadata
          • RocReport.name
          • RocReport.params
          • RocReport.remove_condition
          • RocReport.run
          • RocReport.run_logic
        • SegmentPerformance
          • SegmentPerformance.feature_1
          • SegmentPerformance.feature_2
          • SegmentPerformance.scorer
          • SegmentPerformance.max_segments
          • SegmentPerformance.add_condition
          • SegmentPerformance.clean_conditions
          • SegmentPerformance.conditions_decision
          • SegmentPerformance.finalize_check_result
          • SegmentPerformance.metadata
          • SegmentPerformance.name
          • SegmentPerformance.params
          • SegmentPerformance.remove_condition
          • SegmentPerformance.run
          • SegmentPerformance.run_logic
        • SimpleModelComparison
          • SimpleModelComparison.add_condition
          • SimpleModelComparison.add_condition_gain_not_less_than
          • SimpleModelComparison.clean_conditions
          • SimpleModelComparison.conditions_decision
          • SimpleModelComparison.finalize_check_result
          • SimpleModelComparison.metadata
          • SimpleModelComparison.name
          • SimpleModelComparison.params
          • SimpleModelComparison.remove_condition
          • SimpleModelComparison.run
          • SimpleModelComparison.run_logic
        • TrainTestPredictionDrift
          • TrainTestPredictionDrift.add_condition
          • TrainTestPredictionDrift.add_condition_drift_score_not_greater_than
          • TrainTestPredictionDrift.clean_conditions
          • TrainTestPredictionDrift.conditions_decision
          • TrainTestPredictionDrift.finalize_check_result
          • TrainTestPredictionDrift.metadata
          • TrainTestPredictionDrift.name
          • TrainTestPredictionDrift.params
          • TrainTestPredictionDrift.remove_condition
          • TrainTestPredictionDrift.run
          • TrainTestPredictionDrift.run_logic
        • UnusedFeatures
          • UnusedFeatures.add_condition
          • UnusedFeatures.add_condition_number_of_high_variance_unused_features_not_greater_than
          • UnusedFeatures.clean_conditions
          • UnusedFeatures.conditions_decision
          • UnusedFeatures.finalize_check_result
          • UnusedFeatures.metadata
          • UnusedFeatures.name
          • UnusedFeatures.params
          • UnusedFeatures.remove_condition
          • UnusedFeatures.run
          • UnusedFeatures.run_logic
    • suites
      • single_dataset_integrity
      • train_test_leakage
      • train_test_validation
      • model_evaluation
      • full_suite
      • data_integrity
    • datasets
      • classification
        • breast_cancer
          • load_data
          • load_fitted_model
        • iris
          • load_data
          • load_fitted_model
        • phishing
          • load_data
          • load_fitted_model
        • adult
          • load_data
          • load_fitted_model
      • regression
        • avocado
          • load_data
          • load_fitted_model
    • Dataset
      • Dataset.cat_features
      • Dataset.classes
      • Dataset.columns_info
      • Dataset.data
      • Dataset.datetime_col
      • Dataset.datetime_name
      • Dataset.features
      • Dataset.features_columns
      • Dataset.index_col
      • Dataset.index_name
      • Dataset.label_col
      • Dataset.label_name
      • Dataset.label_type
      • Dataset.n_samples
      • Dataset.numerical_features
      • Dataset.assert_datetime
      • Dataset.assert_features
      • Dataset.assert_index
      • Dataset.assert_label
      • Dataset.cast_to_dataset
      • Dataset.copy
      • Dataset.datasets_share_categorical_features
      • Dataset.datasets_share_date
      • Dataset.datasets_share_features
      • Dataset.datasets_share_index
      • Dataset.datasets_share_label
      • Dataset.from_numpy
      • Dataset.get_datetime_column_from_index
      • Dataset.is_categorical
      • Dataset.is_sampled
      • Dataset.len_when_sampled
      • Dataset.sample
      • Dataset.select
      • Dataset.train_test_split
    • Context
      • Context.features_importance
      • Context.features_importance_type
      • Context.model
      • Context.model_name
      • Context.task_type
      • Context.test
      • Context.train
      • Context.assert_classification_task
      • Context.assert_regression_task
      • Context.assert_task_type
      • Context.get_data_by_kind
      • Context.get_is_sampled_footnote
      • Context.get_scorers
      • Context.get_single_scorer
      • Context.have_test
    • Suite
      • Suite.add
      • Suite.remove
      • Suite.run
      • Suite.supported_checks
    • SingleDatasetCheck
      • SingleDatasetCheck.add_condition
      • SingleDatasetCheck.clean_conditions
      • SingleDatasetCheck.conditions_decision
      • SingleDatasetCheck.finalize_check_result
      • SingleDatasetCheck.metadata
      • SingleDatasetCheck.name
      • SingleDatasetCheck.params
      • SingleDatasetCheck.remove_condition
      • SingleDatasetCheck.run
      • SingleDatasetCheck.run_logic
    • TrainTestCheck
      • TrainTestCheck.add_condition
      • TrainTestCheck.clean_conditions
      • TrainTestCheck.conditions_decision
      • TrainTestCheck.finalize_check_result
      • TrainTestCheck.metadata
      • TrainTestCheck.name
      • TrainTestCheck.params
      • TrainTestCheck.remove_condition
      • TrainTestCheck.run
      • TrainTestCheck.run_logic
    • ModelOnlyCheck
      • ModelOnlyCheck.add_condition
      • ModelOnlyCheck.clean_conditions
      • ModelOnlyCheck.conditions_decision
      • ModelOnlyCheck.finalize_check_result
      • ModelOnlyCheck.metadata
      • ModelOnlyCheck.name
      • ModelOnlyCheck.params
      • ModelOnlyCheck.remove_condition
      • ModelOnlyCheck.run
      • ModelOnlyCheck.run_logic
    • ModelComparisonContext
    • ModelComparisonCheck
      • ModelComparisonCheck.add_condition
      • ModelComparisonCheck.clean_conditions
      • ModelComparisonCheck.conditions_decision
      • ModelComparisonCheck.finalize_check_result
      • ModelComparisonCheck.metadata
      • ModelComparisonCheck.name
      • ModelComparisonCheck.params
      • ModelComparisonCheck.remove_condition
      • ModelComparisonCheck.run
      • ModelComparisonCheck.run_logic
    • ModelComparisonSuite
      • ModelComparisonSuite.add
      • ModelComparisonSuite.remove
      • ModelComparisonSuite.run
      • ModelComparisonSuite.supported_checks
  • deepchecks.vision
    • checks
      • data_integrity
        • ImagePropertyOutliers
          • ImagePropertyOutliers.add_condition
          • ImagePropertyOutliers.clean_conditions
          • ImagePropertyOutliers.compute
          • ImagePropertyOutliers.conditions_decision
          • ImagePropertyOutliers.draw_image
          • ImagePropertyOutliers.finalize_check_result
          • ImagePropertyOutliers.get_default_properties
          • ImagePropertyOutliers.get_relevant_data
          • ImagePropertyOutliers.initialize_run
          • ImagePropertyOutliers.metadata
          • ImagePropertyOutliers.name
          • ImagePropertyOutliers.params
          • ImagePropertyOutliers.remove_condition
          • ImagePropertyOutliers.run
          • ImagePropertyOutliers.update
        • LabelPropertyOutliers
          • LabelPropertyOutliers.add_condition
          • LabelPropertyOutliers.clean_conditions
          • LabelPropertyOutliers.compute
          • LabelPropertyOutliers.conditions_decision
          • LabelPropertyOutliers.draw_image
          • LabelPropertyOutliers.finalize_check_result
          • LabelPropertyOutliers.get_default_properties
          • LabelPropertyOutliers.get_relevant_data
          • LabelPropertyOutliers.initialize_run
          • LabelPropertyOutliers.metadata
          • LabelPropertyOutliers.name
          • LabelPropertyOutliers.params
          • LabelPropertyOutliers.remove_condition
          • LabelPropertyOutliers.run
          • LabelPropertyOutliers.update
      • train_test_validation
        • HeatmapComparison
          • HeatmapComparison.add_condition
          • HeatmapComparison.clean_conditions
          • HeatmapComparison.compute
          • HeatmapComparison.conditions_decision
          • HeatmapComparison.finalize_check_result
          • HeatmapComparison.initialize_run
          • HeatmapComparison.metadata
          • HeatmapComparison.name
          • HeatmapComparison.params
          • HeatmapComparison.plot_row_of_heatmaps
          • HeatmapComparison.remove_condition
          • HeatmapComparison.run
          • HeatmapComparison.update
        • ImageDatasetDrift
          • ImageDatasetDrift.add_condition
          • ImageDatasetDrift.clean_conditions
          • ImageDatasetDrift.compute
          • ImageDatasetDrift.conditions_decision
          • ImageDatasetDrift.finalize_check_result
          • ImageDatasetDrift.initialize_run
          • ImageDatasetDrift.metadata
          • ImageDatasetDrift.name
          • ImageDatasetDrift.params
          • ImageDatasetDrift.remove_condition
          • ImageDatasetDrift.run
          • ImageDatasetDrift.update
        • ImagePropertyDrift
          • ImagePropertyDrift.add_condition
          • ImagePropertyDrift.add_condition_drift_score_not_greater_than
          • ImagePropertyDrift.clean_conditions
          • ImagePropertyDrift.compute
          • ImagePropertyDrift.conditions_decision
          • ImagePropertyDrift.finalize_check_result
          • ImagePropertyDrift.initialize_run
          • ImagePropertyDrift.metadata
          • ImagePropertyDrift.name
          • ImagePropertyDrift.params
          • ImagePropertyDrift.remove_condition
          • ImagePropertyDrift.run
          • ImagePropertyDrift.update
        • NewLabels
          • NewLabels.add_condition
          • NewLabels.add_condition_new_label_ratio_not_greater_than
          • NewLabels.clean_conditions
          • NewLabels.compute
          • NewLabels.conditions_decision
          • NewLabels.finalize_check_result
          • NewLabels.initialize_run
          • NewLabels.metadata
          • NewLabels.name
          • NewLabels.params
          • NewLabels.remove_condition
          • NewLabels.run
          • NewLabels.update
        • SimilarImageLeakage
          • SimilarImageLeakage.add_condition
          • SimilarImageLeakage.add_condition_similar_images_not_more_than
          • SimilarImageLeakage.clean_conditions
          • SimilarImageLeakage.compute
          • SimilarImageLeakage.conditions_decision
          • SimilarImageLeakage.finalize_check_result
          • SimilarImageLeakage.initialize_run
          • SimilarImageLeakage.metadata
          • SimilarImageLeakage.name
          • SimilarImageLeakage.params
          • SimilarImageLeakage.remove_condition
          • SimilarImageLeakage.run
          • SimilarImageLeakage.update
        • FeatureLabelCorrelationChange
          • FeatureLabelCorrelationChange.add_condition
          • FeatureLabelCorrelationChange.add_condition_feature_pps_difference_not_greater_than
          • FeatureLabelCorrelationChange.add_condition_feature_pps_in_train_not_greater_than
          • FeatureLabelCorrelationChange.clean_conditions
          • FeatureLabelCorrelationChange.compute
          • FeatureLabelCorrelationChange.conditions_decision
          • FeatureLabelCorrelationChange.finalize_check_result
          • FeatureLabelCorrelationChange.initialize_run
          • FeatureLabelCorrelationChange.is_float_column
          • FeatureLabelCorrelationChange.metadata
          • FeatureLabelCorrelationChange.name
          • FeatureLabelCorrelationChange.params
          • FeatureLabelCorrelationChange.remove_condition
          • FeatureLabelCorrelationChange.run
          • FeatureLabelCorrelationChange.update
        • TrainTestLabelDrift
          • TrainTestLabelDrift.add_condition
          • TrainTestLabelDrift.add_condition_drift_score_not_greater_than
          • TrainTestLabelDrift.clean_conditions
          • TrainTestLabelDrift.compute
          • TrainTestLabelDrift.conditions_decision
          • TrainTestLabelDrift.finalize_check_result
          • TrainTestLabelDrift.initialize_run
          • TrainTestLabelDrift.metadata
          • TrainTestLabelDrift.name
          • TrainTestLabelDrift.params
          • TrainTestLabelDrift.remove_condition
          • TrainTestLabelDrift.run
          • TrainTestLabelDrift.update
      • model_evaluation
        • TrainTestPredictionDrift
          • TrainTestPredictionDrift.add_condition
          • TrainTestPredictionDrift.add_condition_drift_score_not_greater_than
          • TrainTestPredictionDrift.clean_conditions
          • TrainTestPredictionDrift.compute
          • TrainTestPredictionDrift.conditions_decision
          • TrainTestPredictionDrift.finalize_check_result
          • TrainTestPredictionDrift.initialize_run
          • TrainTestPredictionDrift.metadata
          • TrainTestPredictionDrift.name
          • TrainTestPredictionDrift.params
          • TrainTestPredictionDrift.remove_condition
          • TrainTestPredictionDrift.run
          • TrainTestPredictionDrift.update
        • ClassPerformance
          • ClassPerformance.add_condition
          • ClassPerformance.add_condition_class_performance_imbalance_ratio_not_greater_than
          • ClassPerformance.add_condition_test_performance_not_less_than
          • ClassPerformance.add_condition_train_test_relative_degradation_not_greater_than
          • ClassPerformance.clean_conditions
          • ClassPerformance.compute
          • ClassPerformance.conditions_decision
          • ClassPerformance.finalize_check_result
          • ClassPerformance.initialize_run
          • ClassPerformance.metadata
          • ClassPerformance.name
          • ClassPerformance.params
          • ClassPerformance.remove_condition
          • ClassPerformance.run
          • ClassPerformance.update
        • ConfusionMatrixReport
          • ConfusionMatrixReport.add_condition
          • ConfusionMatrixReport.clean_conditions
          • ConfusionMatrixReport.compute
          • ConfusionMatrixReport.conditions_decision
          • ConfusionMatrixReport.finalize_check_result
          • ConfusionMatrixReport.initialize_run
          • ConfusionMatrixReport.metadata
          • ConfusionMatrixReport.name
          • ConfusionMatrixReport.params
          • ConfusionMatrixReport.remove_condition
          • ConfusionMatrixReport.run
          • ConfusionMatrixReport.update
          • ConfusionMatrixReport.update_classification
          • ConfusionMatrixReport.update_object_detection
        • ImageSegmentPerformance
          • ImageSegmentPerformance.add_condition
          • ImageSegmentPerformance.add_condition_score_from_mean_ratio_not_less_than
          • ImageSegmentPerformance.clean_conditions
          • ImageSegmentPerformance.compute
          • ImageSegmentPerformance.conditions_decision
          • ImageSegmentPerformance.finalize_check_result
          • ImageSegmentPerformance.initialize_run
          • ImageSegmentPerformance.metadata
          • ImageSegmentPerformance.name
          • ImageSegmentPerformance.params
          • ImageSegmentPerformance.remove_condition
          • ImageSegmentPerformance.run
          • ImageSegmentPerformance.update
        • MeanAveragePrecisionReport
          • MeanAveragePrecisionReport.add_condition
          • MeanAveragePrecisionReport.add_condition_average_mean_average_precision_not_less_than
          • MeanAveragePrecisionReport.add_condition_mean_average_precision_not_less_than
          • MeanAveragePrecisionReport.clean_conditions
          • MeanAveragePrecisionReport.compute
          • MeanAveragePrecisionReport.conditions_decision
          • MeanAveragePrecisionReport.finalize_check_result
          • MeanAveragePrecisionReport.initialize_run
          • MeanAveragePrecisionReport.metadata
          • MeanAveragePrecisionReport.name
          • MeanAveragePrecisionReport.params
          • MeanAveragePrecisionReport.remove_condition
          • MeanAveragePrecisionReport.run
          • MeanAveragePrecisionReport.update
        • MeanAverageRecallReport
          • MeanAverageRecallReport.add_condition
          • MeanAverageRecallReport.add_condition_test_average_recall_not_less_than
          • MeanAverageRecallReport.clean_conditions
          • MeanAverageRecallReport.compute
          • MeanAverageRecallReport.conditions_decision
          • MeanAverageRecallReport.finalize_check_result
          • MeanAverageRecallReport.initialize_run
          • MeanAverageRecallReport.metadata
          • MeanAverageRecallReport.name
          • MeanAverageRecallReport.params
          • MeanAverageRecallReport.remove_condition
          • MeanAverageRecallReport.run
          • MeanAverageRecallReport.update
        • ModelErrorAnalysis
          • ModelErrorAnalysis.add_condition
          • ModelErrorAnalysis.clean_conditions
          • ModelErrorAnalysis.compute
          • ModelErrorAnalysis.conditions_decision
          • ModelErrorAnalysis.finalize_check_result
          • ModelErrorAnalysis.initialize_run
          • ModelErrorAnalysis.metadata
          • ModelErrorAnalysis.name
          • ModelErrorAnalysis.params
          • ModelErrorAnalysis.remove_condition
          • ModelErrorAnalysis.run
          • ModelErrorAnalysis.update
        • RobustnessReport
          • RobustnessReport.add_condition
          • RobustnessReport.add_condition_degradation_not_greater_than
          • RobustnessReport.clean_conditions
          • RobustnessReport.compute
          • RobustnessReport.conditions_decision
          • RobustnessReport.finalize_check_result
          • RobustnessReport.initialize_run
          • RobustnessReport.metadata
          • RobustnessReport.name
          • RobustnessReport.params
          • RobustnessReport.remove_condition
          • RobustnessReport.run
          • RobustnessReport.update
        • SimpleModelComparison
          • SimpleModelComparison.add_condition
          • SimpleModelComparison.add_condition_gain_not_less_than
          • SimpleModelComparison.clean_conditions
          • SimpleModelComparison.compute
          • SimpleModelComparison.conditions_decision
          • SimpleModelComparison.finalize_check_result
          • SimpleModelComparison.initialize_run
          • SimpleModelComparison.metadata
          • SimpleModelComparison.name
          • SimpleModelComparison.params
          • SimpleModelComparison.remove_condition
          • SimpleModelComparison.run
          • SimpleModelComparison.update
        • SingleDatasetScalarPerformance
          • SingleDatasetScalarPerformance.add_condition
          • SingleDatasetScalarPerformance.add_condition_greater_equal_to
          • SingleDatasetScalarPerformance.add_condition_greater_than
          • SingleDatasetScalarPerformance.add_condition_less_equal_to
          • SingleDatasetScalarPerformance.add_condition_less_than
          • SingleDatasetScalarPerformance.clean_conditions
          • SingleDatasetScalarPerformance.compute
          • SingleDatasetScalarPerformance.conditions_decision
          • SingleDatasetScalarPerformance.finalize_check_result
          • SingleDatasetScalarPerformance.initialize_run
          • SingleDatasetScalarPerformance.metadata
          • SingleDatasetScalarPerformance.name
          • SingleDatasetScalarPerformance.params
          • SingleDatasetScalarPerformance.remove_condition
          • SingleDatasetScalarPerformance.run
          • SingleDatasetScalarPerformance.update
    • suites
      • train_test_validation
      • model_evaluation
      • full_suite
      • integrity_validation
    • datasets
      • classification
        • mnist
          • load_dataset
          • load_model
          • MNistNet
            • MNistNet.dump_patches
            • MNistNet.add_module
            • MNistNet.apply
            • MNistNet.bfloat16
            • MNistNet.buffers
            • MNistNet.children
            • MNistNet.cpu
            • MNistNet.cuda
            • MNistNet.double
            • MNistNet.eval
            • MNistNet.extra_repr
            • MNistNet.float
            • MNistNet.forward
            • MNistNet.get_buffer
            • MNistNet.get_extra_state
            • MNistNet.get_parameter
            • MNistNet.get_submodule
            • MNistNet.half
            • MNistNet.load_state_dict
            • MNistNet.modules
            • MNistNet.named_buffers
            • MNistNet.named_children
            • MNistNet.named_modules
            • MNistNet.named_parameters
            • MNistNet.parameters
            • MNistNet.register_backward_hook
            • MNistNet.register_buffer
            • MNistNet.register_forward_hook
            • MNistNet.register_forward_pre_hook
            • MNistNet.register_full_backward_hook
            • MNistNet.register_parameter
            • MNistNet.requires_grad_
            • MNistNet.set_extra_state
            • MNistNet.share_memory
            • MNistNet.state_dict
            • MNistNet.to
            • MNistNet.to_empty
            • MNistNet.train
            • MNistNet.type
            • MNistNet.xpu
            • MNistNet.zero_grad
          • MNIST
            • MNIST.class_to_idx
            • MNIST.classes
            • MNIST.functions
            • MNIST.mirrors
            • MNIST.processed_folder
            • MNIST.raw_folder
            • MNIST.resources
            • MNIST.test_data
            • MNIST.test_file
            • MNIST.test_labels
            • MNIST.train_data
            • MNIST.train_labels
            • MNIST.training_file
            • MNIST.download
            • MNIST.extra_repr
            • MNIST.register_datapipe_as_function
            • MNIST.register_function
          • MNISTData
            • MNISTData.classes_indices
            • MNISTData.data_dimension
            • MNISTData.data_loader
            • MNISTData.has_images
            • MNISTData.has_labels
            • MNISTData.n_of_samples_per_class
            • MNISTData.num_classes
            • MNISTData.num_samples
            • MNISTData.original_num_samples
            • MNISTData.task_type
            • MNISTData.transform_field
            • MNISTData.assert_images_valid
            • MNISTData.assert_labels_valid
            • MNISTData.batch_of_index
            • MNISTData.batch_to_images
            • MNISTData.batch_to_labels
            • MNISTData.copy
            • MNISTData.from_dataset
            • MNISTData.get_augmented_dataset
            • MNISTData.get_classes
            • MNISTData.get_transform_type
            • MNISTData.infer_on_batch
            • MNISTData.init_cache
            • MNISTData.is_sampled
            • MNISTData.label_id_to_name
            • MNISTData.to_batch
            • MNISTData.to_dataset_index
            • MNISTData.update_cache
            • MNISTData.validate_format
            • MNISTData.validate_get_classes
            • MNISTData.validate_image_data
            • MNISTData.validate_infered_batch_predictions
            • MNISTData.validate_label
            • MNISTData.validate_prediction
            • MNISTData.validate_shared_label
      • detection
        • coco
          • load_dataset
          • load_model
          • COCOData
            • COCOData.classes_indices
            • COCOData.data_dimension
            • COCOData.data_loader
            • COCOData.has_images
            • COCOData.has_labels
            • COCOData.n_of_samples_per_class
            • COCOData.num_classes
            • COCOData.num_samples
            • COCOData.original_num_samples
            • COCOData.task_type
            • COCOData.transform_field
            • COCOData.assert_images_valid
            • COCOData.assert_labels_valid
            • COCOData.batch_of_index
            • COCOData.batch_to_images
            • COCOData.batch_to_labels
            • COCOData.copy
            • COCOData.from_dataset
            • COCOData.get_augmented_dataset
            • COCOData.get_classes
            • COCOData.get_transform_type
            • COCOData.infer_on_batch
            • COCOData.init_cache
            • COCOData.is_sampled
            • COCOData.label_id_to_name
            • COCOData.to_batch
            • COCOData.to_dataset_index
            • COCOData.update_cache
            • COCOData.validate_format
            • COCOData.validate_get_classes
            • COCOData.validate_image_data
            • COCOData.validate_infered_batch_predictions
            • COCOData.validate_label
            • COCOData.validate_prediction
            • COCOData.validate_shared_label
          • CocoDataset
            • CocoDataset.functions
            • CocoDataset.apply_transform
            • CocoDataset.download_coco128
            • CocoDataset.extra_repr
            • CocoDataset.register_datapipe_as_function
            • CocoDataset.register_function
        • yolo_to_coco
          • YoloParser
            • YoloParser.parse_images_and_labels
            • YoloParser.parse_label_file
            • YoloParser.parse_yolo_dir
            • YoloParser.save_coco_json
    • utils
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __name__
      • __package__
      • __path__
    • VisionData
      • VisionData.classes_indices
      • VisionData.data_dimension
      • VisionData.data_loader
      • VisionData.has_images
      • VisionData.has_labels
      • VisionData.n_of_samples_per_class
      • VisionData.num_classes
      • VisionData.num_samples
      • VisionData.original_num_samples
      • VisionData.task_type
      • VisionData.transform_field
      • VisionData.assert_images_valid
      • VisionData.assert_labels_valid
      • VisionData.batch_of_index
      • VisionData.batch_to_images
      • VisionData.batch_to_labels
      • VisionData.copy
      • VisionData.from_dataset
      • VisionData.get_augmented_dataset
      • VisionData.get_classes
      • VisionData.get_transform_type
      • VisionData.infer_on_batch
      • VisionData.init_cache
      • VisionData.is_sampled
      • VisionData.label_id_to_name
      • VisionData.to_batch
      • VisionData.to_dataset_index
      • VisionData.update_cache
      • VisionData.validate_format
      • VisionData.validate_get_classes
      • VisionData.validate_image_data
      • VisionData.validate_infered_batch_predictions
      • VisionData.validate_label
      • VisionData.validate_prediction
      • VisionData.validate_shared_label
    • ClassificationData
      • ClassificationData.classes_indices
      • ClassificationData.data_dimension
      • ClassificationData.data_loader
      • ClassificationData.has_images
      • ClassificationData.has_labels
      • ClassificationData.n_of_samples_per_class
      • ClassificationData.num_classes
      • ClassificationData.num_samples
      • ClassificationData.original_num_samples
      • ClassificationData.task_type
      • ClassificationData.transform_field
      • ClassificationData.assert_images_valid
      • ClassificationData.assert_labels_valid
      • ClassificationData.batch_of_index
      • ClassificationData.batch_to_images
      • ClassificationData.batch_to_labels
      • ClassificationData.copy
      • ClassificationData.from_dataset
      • ClassificationData.get_augmented_dataset
      • ClassificationData.get_classes
      • ClassificationData.get_transform_type
      • ClassificationData.infer_on_batch
      • ClassificationData.init_cache
      • ClassificationData.is_sampled
      • ClassificationData.label_id_to_name
      • ClassificationData.to_batch
      • ClassificationData.to_dataset_index
      • ClassificationData.update_cache
      • ClassificationData.validate_format
      • ClassificationData.validate_get_classes
      • ClassificationData.validate_image_data
      • ClassificationData.validate_infered_batch_predictions
      • ClassificationData.validate_label
      • ClassificationData.validate_prediction
      • ClassificationData.validate_shared_label
    • DetectionData
      • DetectionData.classes_indices
      • DetectionData.data_dimension
      • DetectionData.data_loader
      • DetectionData.has_images
      • DetectionData.has_labels
      • DetectionData.n_of_samples_per_class
      • DetectionData.num_classes
      • DetectionData.num_samples
      • DetectionData.original_num_samples
      • DetectionData.task_type
      • DetectionData.transform_field
      • DetectionData.assert_images_valid
      • DetectionData.assert_labels_valid
      • DetectionData.batch_of_index
      • DetectionData.batch_to_images
      • DetectionData.batch_to_labels
      • DetectionData.copy
      • DetectionData.from_dataset
      • DetectionData.get_augmented_dataset
      • DetectionData.get_classes
      • DetectionData.get_transform_type
      • DetectionData.infer_on_batch
      • DetectionData.init_cache
      • DetectionData.is_sampled
      • DetectionData.label_id_to_name
      • DetectionData.to_batch
      • DetectionData.to_dataset_index
      • DetectionData.update_cache
      • DetectionData.validate_format
      • DetectionData.validate_get_classes
      • DetectionData.validate_image_data
      • DetectionData.validate_infered_batch_predictions
      • DetectionData.validate_label
      • DetectionData.validate_prediction
      • DetectionData.validate_shared_label
    • Context
      • Context.device
      • Context.model
      • Context.model_name
      • Context.static_predictions
      • Context.test
      • Context.train
      • Context.assert_predictions_valid
      • Context.assert_task_type
      • Context.get_data_by_kind
      • Context.get_is_sampled_footnote
      • Context.have_test
    • SingleDatasetCheck
      • SingleDatasetCheck.add_condition
      • SingleDatasetCheck.clean_conditions
      • SingleDatasetCheck.compute
      • SingleDatasetCheck.conditions_decision
      • SingleDatasetCheck.finalize_check_result
      • SingleDatasetCheck.initialize_run
      • SingleDatasetCheck.metadata
      • SingleDatasetCheck.name
      • SingleDatasetCheck.params
      • SingleDatasetCheck.remove_condition
      • SingleDatasetCheck.run
      • SingleDatasetCheck.update
    • TrainTestCheck
      • TrainTestCheck.add_condition
      • TrainTestCheck.clean_conditions
      • TrainTestCheck.compute
      • TrainTestCheck.conditions_decision
      • TrainTestCheck.finalize_check_result
      • TrainTestCheck.initialize_run
      • TrainTestCheck.metadata
      • TrainTestCheck.name
      • TrainTestCheck.params
      • TrainTestCheck.remove_condition
      • TrainTestCheck.run
      • TrainTestCheck.update
    • ModelOnlyCheck
      • ModelOnlyCheck.add_condition
      • ModelOnlyCheck.clean_conditions
      • ModelOnlyCheck.compute
      • ModelOnlyCheck.conditions_decision
      • ModelOnlyCheck.finalize_check_result
      • ModelOnlyCheck.initialize_run
      • ModelOnlyCheck.metadata
      • ModelOnlyCheck.name
      • ModelOnlyCheck.params
      • ModelOnlyCheck.remove_condition
      • ModelOnlyCheck.run
    • Suite
      • Suite.add
      • Suite.remove
      • Suite.run
      • Suite.supported_checks
  • deepchecks.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
      • infer_numerical_features
      • is_categorical
    • ipython
      • is_notebook
      • is_widgets_enabled
      • is_headless
      • create_progress_bar
      • is_colab_env
      • is_kaggle_env
      • is_widgets_use_possible
      • is_terminal_interactive_shell
      • is_zmq_interactive_shell
      • ProgressBarGroup
        • ProgressBarGroup.register
        • ProgressBarGroup.create
        • ProgressBarGroup.create_dummy
    • 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
      • create_confusion_matrix_figure
      • hex_to_rgba
    • 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
      • create_new_file_name
      • widget_to_html
      • generate_check_docs_link
      • widget_to_html_string
      • format_number_if_not_nan
    • typing
      • Hashable
      • BasicModel
        • BasicModel.predict
      • ClassificationModel
        • ClassificationModel.predict
        • ClassificationModel.predict_proba
    • validation
      • ensure_hashable_or_mutable_sequence

generate_check_docs_link#

generate_check_docs_link(check)[source]#

Create from check object a link to its example page in the docs.

previous

widget_to_html

next

widget_to_html_string

© Copyright 2021-2022, Deepchecks.

Created using Sphinx 4.5.0.