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

API Reference

  • deepchecks.core
    • checks
      • DatasetKind
      • BaseCheck
        • BaseCheck.add_condition
        • BaseCheck.clean_conditions
        • BaseCheck.conditions_decision
        • BaseCheck.config
        • BaseCheck.from_config
        • BaseCheck.from_json
        • BaseCheck.metadata
        • BaseCheck.name
        • BaseCheck.params
        • BaseCheck.remove_condition
        • BaseCheck.run
        • BaseCheck.to_json
      • SingleDatasetBaseCheck
        • SingleDatasetBaseCheck.context_type
        • SingleDatasetBaseCheck.add_condition
        • SingleDatasetBaseCheck.clean_conditions
        • SingleDatasetBaseCheck.conditions_decision
        • SingleDatasetBaseCheck.config
        • SingleDatasetBaseCheck.from_config
        • SingleDatasetBaseCheck.from_json
        • SingleDatasetBaseCheck.metadata
        • SingleDatasetBaseCheck.name
        • SingleDatasetBaseCheck.params
        • SingleDatasetBaseCheck.remove_condition
        • SingleDatasetBaseCheck.run
        • SingleDatasetBaseCheck.to_json
      • TrainTestBaseCheck
        • TrainTestBaseCheck.context_type
        • TrainTestBaseCheck.add_condition
        • TrainTestBaseCheck.clean_conditions
        • TrainTestBaseCheck.conditions_decision
        • TrainTestBaseCheck.config
        • TrainTestBaseCheck.from_config
        • TrainTestBaseCheck.from_json
        • TrainTestBaseCheck.metadata
        • TrainTestBaseCheck.name
        • TrainTestBaseCheck.params
        • TrainTestBaseCheck.remove_condition
        • TrainTestBaseCheck.run
        • TrainTestBaseCheck.to_json
      • ModelOnlyBaseCheck
        • ModelOnlyBaseCheck.context_type
        • ModelOnlyBaseCheck.add_condition
        • ModelOnlyBaseCheck.clean_conditions
        • ModelOnlyBaseCheck.conditions_decision
        • ModelOnlyBaseCheck.config
        • ModelOnlyBaseCheck.from_config
        • ModelOnlyBaseCheck.from_json
        • ModelOnlyBaseCheck.metadata
        • ModelOnlyBaseCheck.name
        • ModelOnlyBaseCheck.params
        • ModelOnlyBaseCheck.remove_condition
        • ModelOnlyBaseCheck.run
        • ModelOnlyBaseCheck.to_json
    • errors
      • DeepchecksValueError
      • DeepchecksNotSupportedError
      • DeepchecksProcessError
      • NumberOfFeaturesLimitError
      • DatasetValidationError
      • ModelValidationError
      • DeepchecksNotImplementedError
      • ValidationError
      • DeepchecksBaseError
      • NotEnoughSamplesError
      • DeepchecksTimeoutError
    • BaseCheck
      • BaseCheck.add_condition
      • BaseCheck.clean_conditions
      • BaseCheck.conditions_decision
      • BaseCheck.config
      • BaseCheck.from_config
      • BaseCheck.from_json
      • BaseCheck.metadata
      • BaseCheck.name
      • BaseCheck.params
      • BaseCheck.remove_condition
      • BaseCheck.run
      • BaseCheck.to_json
    • CheckResult
      • CheckResult.html_serializer
      • CheckResult.ipython_serializer
      • CheckResult.priority
      • CheckResult.run_time
      • CheckResult.widget_serializer
      • 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.reduce_output
      • CheckResult.save_as_html
      • CheckResult.show
      • CheckResult.show_in_iframe
      • CheckResult.show_in_window
      • CheckResult.show_not_interactive
      • CheckResult.to_json
      • CheckResult.to_wandb
      • CheckResult.to_widget
    • CheckFailure
      • CheckFailure.html_serializer
      • CheckFailure.ipython_serializer
      • CheckFailure.run_time
      • CheckFailure.widget_serializer
      • 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.show_in_iframe
      • CheckFailure.show_in_window
      • CheckFailure.show_not_interactive
      • CheckFailure.to_json
      • CheckFailure.to_wandb
      • CheckFailure.to_widget
    • Condition
      • Condition.name
      • Condition.function
      • Condition.params
    • ConditionResult
      • ConditionResult.priority
      • ConditionResult.category
      • ConditionResult.details
      • ConditionResult.name
      • ConditionResult.get_icon
      • ConditionResult.is_pass
      • ConditionResult.set_name
    • ConditionCategory
    • BaseSuite
      • BaseSuite.checks
      • BaseSuite.name
      • BaseSuite.add
      • BaseSuite.config
      • BaseSuite.from_config
      • BaseSuite.from_json
      • BaseSuite.remove
      • BaseSuite.supported_checks
      • BaseSuite.to_json
    • SuiteResult
      • SuiteResult.html_serializer
      • SuiteResult.ipython_serializer
      • SuiteResult.widget_serializer
      • SuiteResult.name
      • SuiteResult.extra_info
      • SuiteResult.results
      • SuiteResult.from_json
      • SuiteResult.get_not_passed_checks
      • SuiteResult.get_not_ran_checks
      • SuiteResult.get_passed_checks
      • SuiteResult.passed
      • SuiteResult.save_as_cml_markdown
      • SuiteResult.save_as_html
      • SuiteResult.select_results
      • SuiteResult.show
      • SuiteResult.show_in_iframe
      • SuiteResult.show_in_window
      • SuiteResult.show_not_interactive
      • 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.config
          • ColumnsInfo.from_config
          • ColumnsInfo.from_json
          • ColumnsInfo.metadata
          • ColumnsInfo.name
          • ColumnsInfo.params
          • ColumnsInfo.remove_condition
          • ColumnsInfo.run
          • ColumnsInfo.run_logic
          • ColumnsInfo.to_json
        • MixedNulls
          • MixedNulls.add_condition
          • MixedNulls.add_condition_different_nulls_less_equal_to
          • MixedNulls.clean_conditions
          • MixedNulls.conditions_decision
          • MixedNulls.config
          • MixedNulls.feature_reduce
          • MixedNulls.from_config
          • MixedNulls.from_json
          • MixedNulls.greater_is_better
          • MixedNulls.metadata
          • MixedNulls.name
          • MixedNulls.params
          • MixedNulls.reduce_output
          • MixedNulls.remove_condition
          • MixedNulls.run
          • MixedNulls.run_logic
          • MixedNulls.to_json
        • StringMismatch
          • StringMismatch.add_condition
          • StringMismatch.add_condition_no_variants
          • StringMismatch.add_condition_number_variants_less_or_equal
          • StringMismatch.add_condition_ratio_variants_less_or_equal
          • StringMismatch.clean_conditions
          • StringMismatch.conditions_decision
          • StringMismatch.config
          • StringMismatch.feature_reduce
          • StringMismatch.from_config
          • StringMismatch.from_json
          • StringMismatch.greater_is_better
          • StringMismatch.metadata
          • StringMismatch.name
          • StringMismatch.params
          • StringMismatch.reduce_output
          • StringMismatch.remove_condition
          • StringMismatch.run
          • StringMismatch.run_logic
          • StringMismatch.to_json
        • MixedDataTypes
          • MixedDataTypes.add_condition
          • MixedDataTypes.add_condition_rare_type_ratio_not_in_range
          • MixedDataTypes.clean_conditions
          • MixedDataTypes.conditions_decision
          • MixedDataTypes.config
          • MixedDataTypes.from_config
          • MixedDataTypes.from_json
          • MixedDataTypes.metadata
          • MixedDataTypes.name
          • MixedDataTypes.params
          • MixedDataTypes.remove_condition
          • MixedDataTypes.run
          • MixedDataTypes.run_logic
          • MixedDataTypes.to_json
        • IsSingleValue
          • IsSingleValue.add_condition
          • IsSingleValue.add_condition_not_single_value
          • IsSingleValue.clean_conditions
          • IsSingleValue.conditions_decision
          • IsSingleValue.config
          • IsSingleValue.from_config
          • IsSingleValue.from_json
          • IsSingleValue.metadata
          • IsSingleValue.name
          • IsSingleValue.params
          • IsSingleValue.remove_condition
          • IsSingleValue.run
          • IsSingleValue.run_logic
          • IsSingleValue.to_json
        • SpecialCharacters
          • SpecialCharacters.add_condition
          • SpecialCharacters.add_condition_ratio_of_special_characters_less_or_equal
          • SpecialCharacters.clean_conditions
          • SpecialCharacters.conditions_decision
          • SpecialCharacters.config
          • SpecialCharacters.from_config
          • SpecialCharacters.from_json
          • SpecialCharacters.metadata
          • SpecialCharacters.name
          • SpecialCharacters.params
          • SpecialCharacters.remove_condition
          • SpecialCharacters.run
          • SpecialCharacters.run_logic
          • SpecialCharacters.to_json
        • StringLengthOutOfBounds
          • StringLengthOutOfBounds.add_condition
          • StringLengthOutOfBounds.add_condition_number_of_outliers_less_or_equal
          • StringLengthOutOfBounds.add_condition_ratio_of_outliers_less_or_equal
          • StringLengthOutOfBounds.clean_conditions
          • StringLengthOutOfBounds.conditions_decision
          • StringLengthOutOfBounds.config
          • StringLengthOutOfBounds.from_config
          • StringLengthOutOfBounds.from_json
          • StringLengthOutOfBounds.metadata
          • StringLengthOutOfBounds.name
          • StringLengthOutOfBounds.params
          • StringLengthOutOfBounds.remove_condition
          • StringLengthOutOfBounds.run
          • StringLengthOutOfBounds.run_logic
          • StringLengthOutOfBounds.to_json
        • DataDuplicates
          • DataDuplicates.add_condition
          • DataDuplicates.add_condition_ratio_less_or_equal
          • DataDuplicates.clean_conditions
          • DataDuplicates.conditions_decision
          • DataDuplicates.config
          • DataDuplicates.from_config
          • DataDuplicates.from_json
          • DataDuplicates.metadata
          • DataDuplicates.name
          • DataDuplicates.params
          • DataDuplicates.remove_condition
          • DataDuplicates.run
          • DataDuplicates.run_logic
          • DataDuplicates.to_json
        • ConflictingLabels
          • ConflictingLabels.add_condition
          • ConflictingLabels.add_condition_ratio_of_conflicting_labels_less_or_equal
          • ConflictingLabels.clean_conditions
          • ConflictingLabels.conditions_decision
          • ConflictingLabels.config
          • ConflictingLabels.from_config
          • ConflictingLabels.from_json
          • ConflictingLabels.metadata
          • ConflictingLabels.name
          • ConflictingLabels.params
          • ConflictingLabels.remove_condition
          • ConflictingLabels.run
          • ConflictingLabels.run_logic
          • ConflictingLabels.to_json
        • ClassImbalance
          • ClassImbalance.add_condition
          • ClassImbalance.add_condition_class_ratio_less_than
          • ClassImbalance.clean_conditions
          • ClassImbalance.conditions_decision
          • ClassImbalance.config
          • ClassImbalance.from_config
          • ClassImbalance.from_json
          • ClassImbalance.metadata
          • ClassImbalance.name
          • ClassImbalance.params
          • ClassImbalance.remove_condition
          • ClassImbalance.run
          • ClassImbalance.run_logic
          • ClassImbalance.to_json
        • OutlierSampleDetection
          • OutlierSampleDetection.add_condition
          • OutlierSampleDetection.add_condition_no_outliers
          • OutlierSampleDetection.add_condition_outlier_ratio_less_or_equal
          • OutlierSampleDetection.clean_conditions
          • OutlierSampleDetection.conditions_decision
          • OutlierSampleDetection.config
          • OutlierSampleDetection.from_config
          • OutlierSampleDetection.from_json
          • OutlierSampleDetection.metadata
          • OutlierSampleDetection.name
          • OutlierSampleDetection.params
          • OutlierSampleDetection.remove_condition
          • OutlierSampleDetection.run
          • OutlierSampleDetection.run_logic
          • OutlierSampleDetection.to_json
        • FeatureLabelCorrelation
          • FeatureLabelCorrelation.add_condition
          • FeatureLabelCorrelation.add_condition_feature_pps_less_than
          • FeatureLabelCorrelation.clean_conditions
          • FeatureLabelCorrelation.conditions_decision
          • FeatureLabelCorrelation.config
          • FeatureLabelCorrelation.from_config
          • FeatureLabelCorrelation.from_json
          • FeatureLabelCorrelation.metadata
          • FeatureLabelCorrelation.name
          • FeatureLabelCorrelation.params
          • FeatureLabelCorrelation.remove_condition
          • FeatureLabelCorrelation.run
          • FeatureLabelCorrelation.run_logic
          • FeatureLabelCorrelation.to_json
        • FeatureFeatureCorrelation
          • FeatureFeatureCorrelation.add_condition
          • FeatureFeatureCorrelation.add_condition_max_number_of_pairs_above_threshold
          • FeatureFeatureCorrelation.clean_conditions
          • FeatureFeatureCorrelation.conditions_decision
          • FeatureFeatureCorrelation.config
          • FeatureFeatureCorrelation.from_config
          • FeatureFeatureCorrelation.from_json
          • FeatureFeatureCorrelation.metadata
          • FeatureFeatureCorrelation.name
          • FeatureFeatureCorrelation.params
          • FeatureFeatureCorrelation.remove_condition
          • FeatureFeatureCorrelation.run
          • FeatureFeatureCorrelation.run_logic
          • FeatureFeatureCorrelation.to_json
        • IdentifierLabelCorrelation
          • IdentifierLabelCorrelation.add_condition
          • IdentifierLabelCorrelation.add_condition_pps_less_or_equal
          • IdentifierLabelCorrelation.clean_conditions
          • IdentifierLabelCorrelation.conditions_decision
          • IdentifierLabelCorrelation.config
          • IdentifierLabelCorrelation.from_config
          • IdentifierLabelCorrelation.from_json
          • IdentifierLabelCorrelation.metadata
          • IdentifierLabelCorrelation.name
          • IdentifierLabelCorrelation.params
          • IdentifierLabelCorrelation.remove_condition
          • IdentifierLabelCorrelation.run
          • IdentifierLabelCorrelation.run_logic
          • IdentifierLabelCorrelation.to_json
        • PercentOfNulls
          • PercentOfNulls.add_condition
          • PercentOfNulls.add_condition_percent_of_nulls_not_greater_than
          • PercentOfNulls.clean_conditions
          • PercentOfNulls.conditions_decision
          • PercentOfNulls.config
          • PercentOfNulls.feature_reduce
          • PercentOfNulls.from_config
          • PercentOfNulls.from_json
          • PercentOfNulls.greater_is_better
          • PercentOfNulls.metadata
          • PercentOfNulls.name
          • PercentOfNulls.params
          • PercentOfNulls.reduce_output
          • PercentOfNulls.remove_condition
          • PercentOfNulls.run
          • PercentOfNulls.run_logic
          • PercentOfNulls.to_json
      • train_test_validation
        • CategoryMismatchTrainTest
          • CategoryMismatchTrainTest.add_condition
          • CategoryMismatchTrainTest.add_condition_new_categories_less_or_equal
          • CategoryMismatchTrainTest.add_condition_new_category_ratio_less_or_equal
          • CategoryMismatchTrainTest.clean_conditions
          • CategoryMismatchTrainTest.conditions_decision
          • CategoryMismatchTrainTest.config
          • CategoryMismatchTrainTest.feature_reduce
          • CategoryMismatchTrainTest.from_config
          • CategoryMismatchTrainTest.from_json
          • CategoryMismatchTrainTest.greater_is_better
          • CategoryMismatchTrainTest.metadata
          • CategoryMismatchTrainTest.name
          • CategoryMismatchTrainTest.params
          • CategoryMismatchTrainTest.reduce_output
          • CategoryMismatchTrainTest.remove_condition
          • CategoryMismatchTrainTest.run
          • CategoryMismatchTrainTest.run_logic
          • CategoryMismatchTrainTest.to_json
        • NewCategoryTrainTest
          • NewCategoryTrainTest.add_condition
          • NewCategoryTrainTest.add_condition_new_categories_less_or_equal
          • NewCategoryTrainTest.add_condition_new_category_ratio_less_or_equal
          • NewCategoryTrainTest.clean_conditions
          • NewCategoryTrainTest.conditions_decision
          • NewCategoryTrainTest.config
          • NewCategoryTrainTest.feature_reduce
          • NewCategoryTrainTest.from_config
          • NewCategoryTrainTest.from_json
          • NewCategoryTrainTest.greater_is_better
          • NewCategoryTrainTest.metadata
          • NewCategoryTrainTest.name
          • NewCategoryTrainTest.params
          • NewCategoryTrainTest.reduce_output
          • NewCategoryTrainTest.remove_condition
          • NewCategoryTrainTest.run
          • NewCategoryTrainTest.run_logic
          • NewCategoryTrainTest.to_json
        • DatasetsSizeComparison
          • DatasetsSizeComparison.add_condition
          • DatasetsSizeComparison.add_condition_test_size_greater_or_equal
          • DatasetsSizeComparison.add_condition_test_train_size_ratio_greater_than
          • DatasetsSizeComparison.add_condition_train_dataset_greater_or_equal_test
          • DatasetsSizeComparison.clean_conditions
          • DatasetsSizeComparison.conditions_decision
          • DatasetsSizeComparison.config
          • DatasetsSizeComparison.from_config
          • DatasetsSizeComparison.from_json
          • DatasetsSizeComparison.metadata
          • DatasetsSizeComparison.name
          • DatasetsSizeComparison.params
          • DatasetsSizeComparison.remove_condition
          • DatasetsSizeComparison.run
          • DatasetsSizeComparison.run_logic
          • DatasetsSizeComparison.to_json
        • DateTrainTestLeakageDuplicates
          • DateTrainTestLeakageDuplicates.add_condition
          • DateTrainTestLeakageDuplicates.add_condition_leakage_ratio_less_or_equal
          • DateTrainTestLeakageDuplicates.clean_conditions
          • DateTrainTestLeakageDuplicates.conditions_decision
          • DateTrainTestLeakageDuplicates.config
          • DateTrainTestLeakageDuplicates.from_config
          • DateTrainTestLeakageDuplicates.from_json
          • DateTrainTestLeakageDuplicates.metadata
          • DateTrainTestLeakageDuplicates.name
          • DateTrainTestLeakageDuplicates.params
          • DateTrainTestLeakageDuplicates.remove_condition
          • DateTrainTestLeakageDuplicates.run
          • DateTrainTestLeakageDuplicates.run_logic
          • DateTrainTestLeakageDuplicates.to_json
        • DateTrainTestLeakageOverlap
          • DateTrainTestLeakageOverlap.add_condition
          • DateTrainTestLeakageOverlap.add_condition_leakage_ratio_less_or_equal
          • DateTrainTestLeakageOverlap.clean_conditions
          • DateTrainTestLeakageOverlap.conditions_decision
          • DateTrainTestLeakageOverlap.config
          • DateTrainTestLeakageOverlap.from_config
          • DateTrainTestLeakageOverlap.from_json
          • DateTrainTestLeakageOverlap.metadata
          • DateTrainTestLeakageOverlap.name
          • DateTrainTestLeakageOverlap.params
          • DateTrainTestLeakageOverlap.remove_condition
          • DateTrainTestLeakageOverlap.run
          • DateTrainTestLeakageOverlap.run_logic
          • DateTrainTestLeakageOverlap.to_json
        • IdentifierLabelCorrelation
          • IdentifierLabelCorrelation.add_condition
          • IdentifierLabelCorrelation.add_condition_pps_less_or_equal
          • IdentifierLabelCorrelation.clean_conditions
          • IdentifierLabelCorrelation.conditions_decision
          • IdentifierLabelCorrelation.config
          • IdentifierLabelCorrelation.from_config
          • IdentifierLabelCorrelation.from_json
          • IdentifierLabelCorrelation.metadata
          • IdentifierLabelCorrelation.name
          • IdentifierLabelCorrelation.params
          • IdentifierLabelCorrelation.remove_condition
          • IdentifierLabelCorrelation.run
          • IdentifierLabelCorrelation.run_logic
          • IdentifierLabelCorrelation.to_json
        • IndexTrainTestLeakage
          • IndexTrainTestLeakage.add_condition
          • IndexTrainTestLeakage.add_condition_ratio_less_or_equal
          • IndexTrainTestLeakage.clean_conditions
          • IndexTrainTestLeakage.conditions_decision
          • IndexTrainTestLeakage.config
          • IndexTrainTestLeakage.from_config
          • IndexTrainTestLeakage.from_json
          • IndexTrainTestLeakage.metadata
          • IndexTrainTestLeakage.name
          • IndexTrainTestLeakage.params
          • IndexTrainTestLeakage.remove_condition
          • IndexTrainTestLeakage.run
          • IndexTrainTestLeakage.run_logic
          • IndexTrainTestLeakage.to_json
        • NewLabelTrainTest
          • NewLabelTrainTest.add_condition
          • NewLabelTrainTest.add_condition_new_label_ratio_less_or_equal
          • NewLabelTrainTest.add_condition_new_labels_number_less_or_equal
          • NewLabelTrainTest.clean_conditions
          • NewLabelTrainTest.conditions_decision
          • NewLabelTrainTest.config
          • NewLabelTrainTest.from_config
          • NewLabelTrainTest.from_json
          • NewLabelTrainTest.greater_is_better
          • NewLabelTrainTest.metadata
          • NewLabelTrainTest.name
          • NewLabelTrainTest.params
          • NewLabelTrainTest.reduce_output
          • NewLabelTrainTest.remove_condition
          • NewLabelTrainTest.run
          • NewLabelTrainTest.run_logic
          • NewLabelTrainTest.to_json
        • FeatureLabelCorrelationChange
          • FeatureLabelCorrelationChange.add_condition
          • FeatureLabelCorrelationChange.add_condition_feature_pps_difference_less_than
          • FeatureLabelCorrelationChange.add_condition_feature_pps_in_train_less_than
          • FeatureLabelCorrelationChange.clean_conditions
          • FeatureLabelCorrelationChange.conditions_decision
          • FeatureLabelCorrelationChange.config
          • FeatureLabelCorrelationChange.from_config
          • FeatureLabelCorrelationChange.from_json
          • FeatureLabelCorrelationChange.metadata
          • FeatureLabelCorrelationChange.name
          • FeatureLabelCorrelationChange.params
          • FeatureLabelCorrelationChange.remove_condition
          • FeatureLabelCorrelationChange.run
          • FeatureLabelCorrelationChange.run_logic
          • FeatureLabelCorrelationChange.to_json
        • StringMismatchComparison
          • StringMismatchComparison.add_condition
          • StringMismatchComparison.add_condition_no_new_variants
          • StringMismatchComparison.add_condition_ratio_new_variants_less_or_equal
          • StringMismatchComparison.clean_conditions
          • StringMismatchComparison.conditions_decision
          • StringMismatchComparison.config
          • StringMismatchComparison.from_config
          • StringMismatchComparison.from_json
          • StringMismatchComparison.metadata
          • StringMismatchComparison.name
          • StringMismatchComparison.params
          • StringMismatchComparison.remove_condition
          • StringMismatchComparison.run
          • StringMismatchComparison.run_logic
          • StringMismatchComparison.to_json
        • TrainTestFeatureDrift
          • TrainTestFeatureDrift.add_condition
          • TrainTestFeatureDrift.add_condition_drift_score_less_than
          • TrainTestFeatureDrift.clean_conditions
          • TrainTestFeatureDrift.conditions_decision
          • TrainTestFeatureDrift.config
          • TrainTestFeatureDrift.feature_reduce
          • TrainTestFeatureDrift.from_config
          • TrainTestFeatureDrift.from_json
          • TrainTestFeatureDrift.greater_is_better
          • TrainTestFeatureDrift.metadata
          • TrainTestFeatureDrift.name
          • TrainTestFeatureDrift.params
          • TrainTestFeatureDrift.reduce_output
          • TrainTestFeatureDrift.remove_condition
          • TrainTestFeatureDrift.run
          • TrainTestFeatureDrift.run_logic
          • TrainTestFeatureDrift.to_json
        • FeatureDrift
          • FeatureDrift.add_condition
          • FeatureDrift.add_condition_drift_score_less_than
          • FeatureDrift.clean_conditions
          • FeatureDrift.conditions_decision
          • FeatureDrift.config
          • FeatureDrift.feature_reduce
          • FeatureDrift.from_config
          • FeatureDrift.from_json
          • FeatureDrift.greater_is_better
          • FeatureDrift.metadata
          • FeatureDrift.name
          • FeatureDrift.params
          • FeatureDrift.reduce_output
          • FeatureDrift.remove_condition
          • FeatureDrift.run
          • FeatureDrift.run_logic
          • FeatureDrift.to_json
        • TrainTestLabelDrift
          • TrainTestLabelDrift.add_condition
          • TrainTestLabelDrift.add_condition_drift_score_less_than
          • TrainTestLabelDrift.clean_conditions
          • TrainTestLabelDrift.conditions_decision
          • TrainTestLabelDrift.config
          • TrainTestLabelDrift.from_config
          • TrainTestLabelDrift.from_json
          • TrainTestLabelDrift.greater_is_better
          • TrainTestLabelDrift.metadata
          • TrainTestLabelDrift.name
          • TrainTestLabelDrift.params
          • TrainTestLabelDrift.reduce_output
          • TrainTestLabelDrift.remove_condition
          • TrainTestLabelDrift.run
          • TrainTestLabelDrift.run_logic
          • TrainTestLabelDrift.to_json
        • LabelDrift
          • LabelDrift.add_condition
          • LabelDrift.add_condition_drift_score_less_than
          • LabelDrift.clean_conditions
          • LabelDrift.conditions_decision
          • LabelDrift.config
          • LabelDrift.from_config
          • LabelDrift.from_json
          • LabelDrift.greater_is_better
          • LabelDrift.metadata
          • LabelDrift.name
          • LabelDrift.params
          • LabelDrift.reduce_output
          • LabelDrift.remove_condition
          • LabelDrift.run
          • LabelDrift.run_logic
          • LabelDrift.to_json
        • TrainTestSamplesMix
          • TrainTestSamplesMix.add_condition
          • TrainTestSamplesMix.add_condition_duplicates_ratio_less_or_equal
          • TrainTestSamplesMix.clean_conditions
          • TrainTestSamplesMix.conditions_decision
          • TrainTestSamplesMix.config
          • TrainTestSamplesMix.from_config
          • TrainTestSamplesMix.from_json
          • TrainTestSamplesMix.metadata
          • TrainTestSamplesMix.name
          • TrainTestSamplesMix.params
          • TrainTestSamplesMix.remove_condition
          • TrainTestSamplesMix.run
          • TrainTestSamplesMix.run_logic
          • TrainTestSamplesMix.to_json
        • MultivariateDrift
          • MultivariateDrift.add_condition
          • MultivariateDrift.add_condition_overall_drift_value_less_than
          • MultivariateDrift.clean_conditions
          • MultivariateDrift.conditions_decision
          • MultivariateDrift.config
          • MultivariateDrift.from_config
          • MultivariateDrift.from_json
          • MultivariateDrift.metadata
          • MultivariateDrift.name
          • MultivariateDrift.params
          • MultivariateDrift.remove_condition
          • MultivariateDrift.run
          • MultivariateDrift.run_logic
          • MultivariateDrift.to_json
        • WholeDatasetDrift
          • WholeDatasetDrift.add_condition
          • WholeDatasetDrift.add_condition_overall_drift_value_less_than
          • WholeDatasetDrift.clean_conditions
          • WholeDatasetDrift.conditions_decision
          • WholeDatasetDrift.config
          • WholeDatasetDrift.from_config
          • WholeDatasetDrift.from_json
          • WholeDatasetDrift.metadata
          • WholeDatasetDrift.name
          • WholeDatasetDrift.params
          • WholeDatasetDrift.remove_condition
          • WholeDatasetDrift.run
          • WholeDatasetDrift.run_logic
          • WholeDatasetDrift.to_json
      • model_evaluation
        • BoostingOverfit
          • BoostingOverfit.add_condition
          • BoostingOverfit.add_condition_test_score_percent_decline_less_than
          • BoostingOverfit.clean_conditions
          • BoostingOverfit.conditions_decision
          • BoostingOverfit.config
          • BoostingOverfit.from_config
          • BoostingOverfit.from_json
          • BoostingOverfit.metadata
          • BoostingOverfit.name
          • BoostingOverfit.params
          • BoostingOverfit.remove_condition
          • BoostingOverfit.run
          • BoostingOverfit.run_logic
          • BoostingOverfit.to_json
        • CalibrationScore
          • CalibrationScore.add_condition
          • CalibrationScore.clean_conditions
          • CalibrationScore.conditions_decision
          • CalibrationScore.config
          • CalibrationScore.from_config
          • CalibrationScore.from_json
          • CalibrationScore.metadata
          • CalibrationScore.name
          • CalibrationScore.params
          • CalibrationScore.remove_condition
          • CalibrationScore.run
          • CalibrationScore.run_logic
          • CalibrationScore.to_json
        • ConfusionMatrixReport
          • ConfusionMatrixReport.add_condition
          • ConfusionMatrixReport.clean_conditions
          • ConfusionMatrixReport.conditions_decision
          • ConfusionMatrixReport.config
          • ConfusionMatrixReport.from_config
          • ConfusionMatrixReport.from_json
          • ConfusionMatrixReport.metadata
          • ConfusionMatrixReport.name
          • ConfusionMatrixReport.params
          • ConfusionMatrixReport.remove_condition
          • ConfusionMatrixReport.run
          • ConfusionMatrixReport.run_logic
          • ConfusionMatrixReport.to_json
        • ModelInferenceTime
          • ModelInferenceTime.add_condition
          • ModelInferenceTime.add_condition_inference_time_less_than
          • ModelInferenceTime.clean_conditions
          • ModelInferenceTime.conditions_decision
          • ModelInferenceTime.config
          • ModelInferenceTime.from_config
          • ModelInferenceTime.from_json
          • ModelInferenceTime.metadata
          • ModelInferenceTime.name
          • ModelInferenceTime.params
          • ModelInferenceTime.remove_condition
          • ModelInferenceTime.run
          • ModelInferenceTime.run_logic
          • ModelInferenceTime.to_json
        • ModelInfo
          • ModelInfo.add_condition
          • ModelInfo.clean_conditions
          • ModelInfo.conditions_decision
          • ModelInfo.config
          • ModelInfo.from_config
          • ModelInfo.from_json
          • ModelInfo.metadata
          • ModelInfo.name
          • ModelInfo.params
          • ModelInfo.remove_condition
          • ModelInfo.run
          • ModelInfo.run_logic
          • ModelInfo.to_json
        • MultiModelPerformanceReport
          • MultiModelPerformanceReport.add_condition
          • MultiModelPerformanceReport.clean_conditions
          • MultiModelPerformanceReport.conditions_decision
          • MultiModelPerformanceReport.config
          • MultiModelPerformanceReport.from_config
          • MultiModelPerformanceReport.from_json
          • MultiModelPerformanceReport.metadata
          • MultiModelPerformanceReport.name
          • MultiModelPerformanceReport.params
          • MultiModelPerformanceReport.remove_condition
          • MultiModelPerformanceReport.run
          • MultiModelPerformanceReport.run_logic
          • MultiModelPerformanceReport.to_json
        • TrainTestPerformance
          • TrainTestPerformance.add_condition
          • TrainTestPerformance.add_condition_class_performance_imbalance_ratio_less_than
          • TrainTestPerformance.add_condition_test_performance_greater_than
          • TrainTestPerformance.add_condition_train_test_relative_degradation_less_than
          • TrainTestPerformance.clean_conditions
          • TrainTestPerformance.conditions_decision
          • TrainTestPerformance.config
          • TrainTestPerformance.from_config
          • TrainTestPerformance.from_json
          • TrainTestPerformance.metadata
          • TrainTestPerformance.name
          • TrainTestPerformance.params
          • TrainTestPerformance.remove_condition
          • TrainTestPerformance.run
          • TrainTestPerformance.run_logic
          • TrainTestPerformance.to_json
        • RegressionErrorDistribution
          • RegressionErrorDistribution.add_condition
          • RegressionErrorDistribution.add_condition_kurtosis_greater_than
          • RegressionErrorDistribution.add_condition_systematic_error_ratio_to_rmse_less_than
          • RegressionErrorDistribution.clean_conditions
          • RegressionErrorDistribution.conditions_decision
          • RegressionErrorDistribution.config
          • RegressionErrorDistribution.from_config
          • RegressionErrorDistribution.from_json
          • RegressionErrorDistribution.metadata
          • RegressionErrorDistribution.name
          • RegressionErrorDistribution.params
          • RegressionErrorDistribution.remove_condition
          • RegressionErrorDistribution.run
          • RegressionErrorDistribution.run_logic
          • RegressionErrorDistribution.to_json
        • RegressionSystematicError
          • RegressionSystematicError.add_condition
          • RegressionSystematicError.add_condition_systematic_error_ratio_to_rmse_less_than
          • RegressionSystematicError.clean_conditions
          • RegressionSystematicError.conditions_decision
          • RegressionSystematicError.config
          • RegressionSystematicError.from_config
          • RegressionSystematicError.from_json
          • RegressionSystematicError.metadata
          • RegressionSystematicError.name
          • RegressionSystematicError.params
          • RegressionSystematicError.remove_condition
          • RegressionSystematicError.run
          • RegressionSystematicError.run_logic
          • RegressionSystematicError.to_json
        • RocReport
          • RocReport.add_condition
          • RocReport.add_condition_auc_greater_than
          • RocReport.clean_conditions
          • RocReport.conditions_decision
          • RocReport.config
          • RocReport.from_config
          • RocReport.from_json
          • RocReport.metadata
          • RocReport.name
          • RocReport.params
          • RocReport.remove_condition
          • RocReport.run
          • RocReport.run_logic
          • RocReport.to_json
        • SegmentPerformance
          • SegmentPerformance.feature_1
          • SegmentPerformance.feature_2
          • SegmentPerformance.alternative_scorer
          • SegmentPerformance.max_segments
          • SegmentPerformance.add_condition
          • SegmentPerformance.clean_conditions
          • SegmentPerformance.conditions_decision
          • SegmentPerformance.config
          • SegmentPerformance.from_config
          • SegmentPerformance.from_json
          • SegmentPerformance.metadata
          • SegmentPerformance.name
          • SegmentPerformance.params
          • SegmentPerformance.remove_condition
          • SegmentPerformance.run
          • SegmentPerformance.run_logic
          • SegmentPerformance.to_json
        • SimpleModelComparison
          • SimpleModelComparison.add_condition
          • SimpleModelComparison.add_condition_gain_greater_than
          • SimpleModelComparison.clean_conditions
          • SimpleModelComparison.conditions_decision
          • SimpleModelComparison.config
          • SimpleModelComparison.from_config
          • SimpleModelComparison.from_json
          • SimpleModelComparison.metadata
          • SimpleModelComparison.name
          • SimpleModelComparison.params
          • SimpleModelComparison.remove_condition
          • SimpleModelComparison.run
          • SimpleModelComparison.run_logic
          • SimpleModelComparison.to_json
        • TrainTestPredictionDrift
          • TrainTestPredictionDrift.add_condition
          • TrainTestPredictionDrift.add_condition_drift_score_less_than
          • TrainTestPredictionDrift.clean_conditions
          • TrainTestPredictionDrift.conditions_decision
          • TrainTestPredictionDrift.config
          • TrainTestPredictionDrift.from_config
          • TrainTestPredictionDrift.from_json
          • TrainTestPredictionDrift.greater_is_better
          • TrainTestPredictionDrift.metadata
          • TrainTestPredictionDrift.name
          • TrainTestPredictionDrift.params
          • TrainTestPredictionDrift.reduce_output
          • TrainTestPredictionDrift.remove_condition
          • TrainTestPredictionDrift.run
          • TrainTestPredictionDrift.run_logic
          • TrainTestPredictionDrift.to_json
        • PredictionDrift
          • PredictionDrift.add_condition
          • PredictionDrift.add_condition_drift_score_less_than
          • PredictionDrift.clean_conditions
          • PredictionDrift.conditions_decision
          • PredictionDrift.config
          • PredictionDrift.from_config
          • PredictionDrift.from_json
          • PredictionDrift.greater_is_better
          • PredictionDrift.metadata
          • PredictionDrift.name
          • PredictionDrift.params
          • PredictionDrift.reduce_output
          • PredictionDrift.remove_condition
          • PredictionDrift.run
          • PredictionDrift.run_logic
          • PredictionDrift.to_json
        • WeakSegmentsPerformance
          • WeakSegmentsPerformance.add_condition
          • WeakSegmentsPerformance.add_condition_segments_relative_performance_greater_than
          • WeakSegmentsPerformance.clean_conditions
          • WeakSegmentsPerformance.conditions_decision
          • WeakSegmentsPerformance.config
          • WeakSegmentsPerformance.from_config
          • WeakSegmentsPerformance.from_json
          • WeakSegmentsPerformance.metadata
          • WeakSegmentsPerformance.name
          • WeakSegmentsPerformance.params
          • WeakSegmentsPerformance.remove_condition
          • WeakSegmentsPerformance.run
          • WeakSegmentsPerformance.run_logic
          • WeakSegmentsPerformance.to_json
        • UnusedFeatures
          • UnusedFeatures.add_condition
          • UnusedFeatures.add_condition_number_of_high_variance_unused_features_less_or_equal
          • UnusedFeatures.clean_conditions
          • UnusedFeatures.conditions_decision
          • UnusedFeatures.config
          • UnusedFeatures.from_config
          • UnusedFeatures.from_json
          • UnusedFeatures.metadata
          • UnusedFeatures.name
          • UnusedFeatures.params
          • UnusedFeatures.remove_condition
          • UnusedFeatures.run
          • UnusedFeatures.run_logic
          • UnusedFeatures.to_json
        • SingleDatasetPerformance
          • SingleDatasetPerformance.add_condition
          • SingleDatasetPerformance.add_condition_greater_than
          • SingleDatasetPerformance.clean_conditions
          • SingleDatasetPerformance.conditions_decision
          • SingleDatasetPerformance.config
          • SingleDatasetPerformance.from_config
          • SingleDatasetPerformance.from_json
          • SingleDatasetPerformance.greater_is_better
          • SingleDatasetPerformance.metadata
          • SingleDatasetPerformance.name
          • SingleDatasetPerformance.params
          • SingleDatasetPerformance.reduce_output
          • SingleDatasetPerformance.remove_condition
          • SingleDatasetPerformance.run
          • SingleDatasetPerformance.run_logic
          • SingleDatasetPerformance.to_json
        • PerformanceBias
          • PerformanceBias.add_condition
          • PerformanceBias.add_condition_bounded_performance_difference
          • PerformanceBias.add_condition_bounded_relative_performance_difference
          • PerformanceBias.clean_conditions
          • PerformanceBias.conditions_decision
          • PerformanceBias.config
          • PerformanceBias.from_config
          • PerformanceBias.from_json
          • PerformanceBias.metadata
          • PerformanceBias.name
          • PerformanceBias.params
          • PerformanceBias.remove_condition
          • PerformanceBias.run
          • PerformanceBias.run_logic
          • PerformanceBias.to_json
          • PerformanceBias.validate_attributes
    • suites
      • data_integrity
      • train_test_validation
      • model_evaluation
      • full_suite
    • 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
        • lending_club
          • load_data
          • load_fitted_model
      • regression
        • avocado
          • load_data
          • load_fitted_model
        • wine_quality
          • load_data
          • load_fitted_model
        • airbnb
          • load_data
          • load_pre_calculated_prediction
          • load_pre_calculated_feature_importance
    • integrations
      • __all__
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __loader__
      • __name__
      • __package__
      • __path__
      • __spec__
    • metric_utils
      • TaskType
      • DEFAULT_SCORERS_DICT
      • DEFAULT_REGRESSION_SCORERS
      • DEFAULT_BINARY_SCORERS
      • DEFAULT_MULTICLASS_SCORERS
      • MULTICLASS_SCORERS_NON_AVERAGE
      • DeepcheckScorer
        • DeepcheckScorer.filter_nulls
        • DeepcheckScorer.run_on_data_and_label
        • DeepcheckScorer.run_on_pred
        • DeepcheckScorer.score_perfect
        • DeepcheckScorer.validate_fitting
        • DeepcheckScorer.validate_scorer_multilabel_output
      • init_validate_scorers
      • get_default_scorers
    • utils
      • __all__
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __loader__
      • __name__
      • __package__
      • __path__
      • __spec__
      • feature_importance
        • calculate_feature_importance_or_none
        • column_importance_sorter_dict
        • column_importance_sorter_df
        • validate_feature_importance
      • feature_inference
        • infer_categorical_features
        • infer_numerical_features
        • is_categorical
      • messages
        • get_condition_passed_message
      • task_inference
        • infer_task_type_by_labels
        • infer_classes_from_model
        • get_all_labels
        • infer_task_type_by_class_number
      • task_type
        • TaskType
      • validation
        • model_type_validation
        • validate_model
        • ensure_dataframe_type
        • ensure_predictions_shape
        • ensure_predictions_proba
  • deepchecks.vision
    • checks
      • data_integrity
        • ImagePropertyOutliers
          • ImagePropertyOutliers.add_condition
          • ImagePropertyOutliers.clean_conditions
          • ImagePropertyOutliers.compute
          • ImagePropertyOutliers.conditions_decision
          • ImagePropertyOutliers.config
          • ImagePropertyOutliers.from_config
          • ImagePropertyOutliers.from_json
          • ImagePropertyOutliers.get_default_properties
          • ImagePropertyOutliers.initialize_run
          • ImagePropertyOutliers.metadata
          • ImagePropertyOutliers.name
          • ImagePropertyOutliers.params
          • ImagePropertyOutliers.remove_condition
          • ImagePropertyOutliers.run
          • ImagePropertyOutliers.to_json
          • ImagePropertyOutliers.update
        • LabelPropertyOutliers
          • LabelPropertyOutliers.add_condition
          • LabelPropertyOutliers.clean_conditions
          • LabelPropertyOutliers.compute
          • LabelPropertyOutliers.conditions_decision
          • LabelPropertyOutliers.config
          • LabelPropertyOutliers.from_config
          • LabelPropertyOutliers.from_json
          • LabelPropertyOutliers.get_default_properties
          • LabelPropertyOutliers.initialize_run
          • LabelPropertyOutliers.metadata
          • LabelPropertyOutliers.name
          • LabelPropertyOutliers.params
          • LabelPropertyOutliers.remove_condition
          • LabelPropertyOutliers.run
          • LabelPropertyOutliers.to_json
          • LabelPropertyOutliers.update
        • PropertyLabelCorrelation
          • PropertyLabelCorrelation.add_condition
          • PropertyLabelCorrelation.add_condition_property_pps_less_than
          • PropertyLabelCorrelation.clean_conditions
          • PropertyLabelCorrelation.compute
          • PropertyLabelCorrelation.conditions_decision
          • PropertyLabelCorrelation.config
          • PropertyLabelCorrelation.from_config
          • PropertyLabelCorrelation.from_json
          • PropertyLabelCorrelation.initialize_run
          • PropertyLabelCorrelation.metadata
          • PropertyLabelCorrelation.name
          • PropertyLabelCorrelation.params
          • PropertyLabelCorrelation.remove_condition
          • PropertyLabelCorrelation.run
          • PropertyLabelCorrelation.to_json
          • PropertyLabelCorrelation.update
      • train_test_validation
        • HeatmapComparison
          • HeatmapComparison.add_condition
          • HeatmapComparison.clean_conditions
          • HeatmapComparison.compute
          • HeatmapComparison.conditions_decision
          • HeatmapComparison.config
          • HeatmapComparison.from_config
          • HeatmapComparison.from_json
          • HeatmapComparison.initialize_run
          • HeatmapComparison.metadata
          • HeatmapComparison.name
          • HeatmapComparison.params
          • HeatmapComparison.plot_row_of_heatmaps
          • HeatmapComparison.remove_condition
          • HeatmapComparison.run
          • HeatmapComparison.to_json
          • HeatmapComparison.update
        • ImageDatasetDrift
          • ImageDatasetDrift.add_condition
          • ImageDatasetDrift.add_condition_drift_score_less_than
          • ImageDatasetDrift.clean_conditions
          • ImageDatasetDrift.compute
          • ImageDatasetDrift.conditions_decision
          • ImageDatasetDrift.config
          • ImageDatasetDrift.from_config
          • ImageDatasetDrift.from_json
          • ImageDatasetDrift.initialize_run
          • ImageDatasetDrift.metadata
          • ImageDatasetDrift.name
          • ImageDatasetDrift.params
          • ImageDatasetDrift.remove_condition
          • ImageDatasetDrift.run
          • ImageDatasetDrift.to_json
          • ImageDatasetDrift.update
        • ImagePropertyDrift
          • ImagePropertyDrift.add_condition
          • ImagePropertyDrift.add_condition_drift_score_less_than
          • ImagePropertyDrift.clean_conditions
          • ImagePropertyDrift.compute
          • ImagePropertyDrift.conditions_decision
          • ImagePropertyDrift.config
          • ImagePropertyDrift.from_config
          • ImagePropertyDrift.from_json
          • ImagePropertyDrift.greater_is_better
          • ImagePropertyDrift.initialize_run
          • ImagePropertyDrift.metadata
          • ImagePropertyDrift.name
          • ImagePropertyDrift.params
          • ImagePropertyDrift.property_reduce
          • ImagePropertyDrift.reduce_output
          • ImagePropertyDrift.remove_condition
          • ImagePropertyDrift.run
          • ImagePropertyDrift.to_json
          • ImagePropertyDrift.update
        • NewLabels
          • NewLabels.add_condition
          • NewLabels.add_condition_new_label_ratio_less_or_equal
          • NewLabels.clean_conditions
          • NewLabels.compute
          • NewLabels.conditions_decision
          • NewLabels.config
          • NewLabels.from_config
          • NewLabels.from_json
          • NewLabels.greater_is_better
          • NewLabels.initialize_run
          • NewLabels.metadata
          • NewLabels.name
          • NewLabels.params
          • NewLabels.reduce_output
          • NewLabels.remove_condition
          • NewLabels.run
          • NewLabels.to_json
          • NewLabels.update
        • PropertyLabelCorrelationChange
          • PropertyLabelCorrelationChange.add_condition
          • PropertyLabelCorrelationChange.add_condition_property_pps_difference_less_than
          • PropertyLabelCorrelationChange.add_condition_property_pps_in_train_less_than
          • PropertyLabelCorrelationChange.clean_conditions
          • PropertyLabelCorrelationChange.compute
          • PropertyLabelCorrelationChange.conditions_decision
          • PropertyLabelCorrelationChange.config
          • PropertyLabelCorrelationChange.from_config
          • PropertyLabelCorrelationChange.from_json
          • PropertyLabelCorrelationChange.initialize_run
          • PropertyLabelCorrelationChange.metadata
          • PropertyLabelCorrelationChange.name
          • PropertyLabelCorrelationChange.params
          • PropertyLabelCorrelationChange.remove_condition
          • PropertyLabelCorrelationChange.run
          • PropertyLabelCorrelationChange.to_json
          • PropertyLabelCorrelationChange.update
        • TrainTestLabelDrift
          • TrainTestLabelDrift.add_condition
          • TrainTestLabelDrift.add_condition_drift_score_less_than
          • TrainTestLabelDrift.clean_conditions
          • TrainTestLabelDrift.compute
          • TrainTestLabelDrift.conditions_decision
          • TrainTestLabelDrift.config
          • TrainTestLabelDrift.from_config
          • TrainTestLabelDrift.from_json
          • TrainTestLabelDrift.greater_is_better
          • TrainTestLabelDrift.initialize_run
          • TrainTestLabelDrift.metadata
          • TrainTestLabelDrift.name
          • TrainTestLabelDrift.params
          • TrainTestLabelDrift.property_reduce
          • TrainTestLabelDrift.reduce_output
          • TrainTestLabelDrift.remove_condition
          • TrainTestLabelDrift.run
          • TrainTestLabelDrift.to_json
          • TrainTestLabelDrift.update
        • LabelDrift
          • LabelDrift.add_condition
          • LabelDrift.add_condition_drift_score_less_than
          • LabelDrift.clean_conditions
          • LabelDrift.compute
          • LabelDrift.conditions_decision
          • LabelDrift.config
          • LabelDrift.from_config
          • LabelDrift.from_json
          • LabelDrift.greater_is_better
          • LabelDrift.initialize_run
          • LabelDrift.metadata
          • LabelDrift.name
          • LabelDrift.params
          • LabelDrift.property_reduce
          • LabelDrift.reduce_output
          • LabelDrift.remove_condition
          • LabelDrift.run
          • LabelDrift.to_json
          • LabelDrift.update
      • model_evaluation
        • TrainTestPredictionDrift
          • TrainTestPredictionDrift.add_condition
          • TrainTestPredictionDrift.add_condition_drift_score_less_than
          • TrainTestPredictionDrift.clean_conditions
          • TrainTestPredictionDrift.compute
          • TrainTestPredictionDrift.conditions_decision
          • TrainTestPredictionDrift.config
          • TrainTestPredictionDrift.from_config
          • TrainTestPredictionDrift.from_json
          • TrainTestPredictionDrift.greater_is_better
          • TrainTestPredictionDrift.initialize_run
          • TrainTestPredictionDrift.metadata
          • TrainTestPredictionDrift.name
          • TrainTestPredictionDrift.params
          • TrainTestPredictionDrift.property_reduce
          • TrainTestPredictionDrift.reduce_output
          • TrainTestPredictionDrift.remove_condition
          • TrainTestPredictionDrift.run
          • TrainTestPredictionDrift.to_json
          • TrainTestPredictionDrift.update
        • PredictionDrift
          • PredictionDrift.add_condition
          • PredictionDrift.add_condition_drift_score_less_than
          • PredictionDrift.clean_conditions
          • PredictionDrift.compute
          • PredictionDrift.conditions_decision
          • PredictionDrift.config
          • PredictionDrift.from_config
          • PredictionDrift.from_json
          • PredictionDrift.greater_is_better
          • PredictionDrift.initialize_run
          • PredictionDrift.metadata
          • PredictionDrift.name
          • PredictionDrift.params
          • PredictionDrift.property_reduce
          • PredictionDrift.reduce_output
          • PredictionDrift.remove_condition
          • PredictionDrift.run
          • PredictionDrift.to_json
          • PredictionDrift.update
        • ClassPerformance
          • ClassPerformance.add_condition
          • ClassPerformance.add_condition_class_performance_imbalance_ratio_less_than
          • ClassPerformance.add_condition_test_performance_greater_than
          • ClassPerformance.add_condition_train_test_relative_degradation_less_than
          • ClassPerformance.clean_conditions
          • ClassPerformance.compute
          • ClassPerformance.conditions_decision
          • ClassPerformance.config
          • ClassPerformance.from_config
          • ClassPerformance.from_json
          • ClassPerformance.initialize_run
          • ClassPerformance.metadata
          • ClassPerformance.name
          • ClassPerformance.params
          • ClassPerformance.remove_condition
          • ClassPerformance.run
          • ClassPerformance.to_json
          • ClassPerformance.update
        • ConfusionMatrixReport
          • ConfusionMatrixReport.add_condition
          • ConfusionMatrixReport.clean_conditions
          • ConfusionMatrixReport.compute
          • ConfusionMatrixReport.conditions_decision
          • ConfusionMatrixReport.config
          • ConfusionMatrixReport.from_config
          • ConfusionMatrixReport.from_json
          • ConfusionMatrixReport.initialize_run
          • ConfusionMatrixReport.metadata
          • ConfusionMatrixReport.name
          • ConfusionMatrixReport.params
          • ConfusionMatrixReport.remove_condition
          • ConfusionMatrixReport.run
          • ConfusionMatrixReport.to_json
          • ConfusionMatrixReport.update
          • ConfusionMatrixReport.update_classification
          • ConfusionMatrixReport.update_object_detection
        • MeanAveragePrecisionReport
          • MeanAveragePrecisionReport.add_condition
          • MeanAveragePrecisionReport.add_condition_average_mean_average_precision_greater_than
          • MeanAveragePrecisionReport.add_condition_mean_average_precision_greater_than
          • MeanAveragePrecisionReport.clean_conditions
          • MeanAveragePrecisionReport.compute
          • MeanAveragePrecisionReport.conditions_decision
          • MeanAveragePrecisionReport.config
          • MeanAveragePrecisionReport.from_config
          • MeanAveragePrecisionReport.from_json
          • MeanAveragePrecisionReport.initialize_run
          • MeanAveragePrecisionReport.metadata
          • MeanAveragePrecisionReport.name
          • MeanAveragePrecisionReport.params
          • MeanAveragePrecisionReport.remove_condition
          • MeanAveragePrecisionReport.run
          • MeanAveragePrecisionReport.to_json
          • MeanAveragePrecisionReport.update
        • MeanAverageRecallReport
          • MeanAverageRecallReport.add_condition
          • MeanAverageRecallReport.add_condition_test_average_recall_greater_than
          • MeanAverageRecallReport.clean_conditions
          • MeanAverageRecallReport.compute
          • MeanAverageRecallReport.conditions_decision
          • MeanAverageRecallReport.config
          • MeanAverageRecallReport.from_config
          • MeanAverageRecallReport.from_json
          • MeanAverageRecallReport.initialize_run
          • MeanAverageRecallReport.metadata
          • MeanAverageRecallReport.name
          • MeanAverageRecallReport.params
          • MeanAverageRecallReport.remove_condition
          • MeanAverageRecallReport.run
          • MeanAverageRecallReport.to_json
          • MeanAverageRecallReport.update
        • SimpleModelComparison
          • SimpleModelComparison.add_condition
          • SimpleModelComparison.add_condition_gain_greater_than
          • SimpleModelComparison.clean_conditions
          • SimpleModelComparison.compute
          • SimpleModelComparison.conditions_decision
          • SimpleModelComparison.config
          • SimpleModelComparison.from_config
          • SimpleModelComparison.from_json
          • SimpleModelComparison.initialize_run
          • SimpleModelComparison.metadata
          • SimpleModelComparison.name
          • SimpleModelComparison.params
          • SimpleModelComparison.remove_condition
          • SimpleModelComparison.run
          • SimpleModelComparison.to_json
          • SimpleModelComparison.update
        • SingleDatasetPerformance
          • SingleDatasetPerformance.add_condition
          • SingleDatasetPerformance.add_condition_greater_than
          • SingleDatasetPerformance.add_condition_less_than
          • SingleDatasetPerformance.clean_conditions
          • SingleDatasetPerformance.compute
          • SingleDatasetPerformance.conditions_decision
          • SingleDatasetPerformance.config
          • SingleDatasetPerformance.from_config
          • SingleDatasetPerformance.from_json
          • SingleDatasetPerformance.greater_is_better
          • SingleDatasetPerformance.initialize_run
          • SingleDatasetPerformance.metadata
          • SingleDatasetPerformance.name
          • SingleDatasetPerformance.params
          • SingleDatasetPerformance.reduce_output
          • SingleDatasetPerformance.remove_condition
          • SingleDatasetPerformance.run
          • SingleDatasetPerformance.to_json
          • SingleDatasetPerformance.update
        • WeakSegmentsPerformance
          • WeakSegmentsPerformance.add_condition
          • WeakSegmentsPerformance.add_condition_segments_relative_performance_greater_than
          • WeakSegmentsPerformance.clean_conditions
          • WeakSegmentsPerformance.compute
          • WeakSegmentsPerformance.conditions_decision
          • WeakSegmentsPerformance.config
          • WeakSegmentsPerformance.from_config
          • WeakSegmentsPerformance.from_json
          • WeakSegmentsPerformance.initialize_run
          • WeakSegmentsPerformance.metadata
          • WeakSegmentsPerformance.name
          • WeakSegmentsPerformance.params
          • WeakSegmentsPerformance.remove_condition
          • WeakSegmentsPerformance.run
          • WeakSegmentsPerformance.to_json
          • WeakSegmentsPerformance.update
    • suites
      • data_integrity
      • train_test_validation
      • model_evaluation
      • full_suite
    • datasets
      • classification
        • mnist_torch
          • load_dataset
          • load_model
          • MnistModel
            • MnistModel.dump_patches
            • MnistModel.add_module
            • MnistModel.apply
            • MnistModel.bfloat16
            • MnistModel.buffers
            • MnistModel.children
            • MnistModel.cpu
            • MnistModel.cuda
            • MnistModel.double
            • MnistModel.eval
            • MnistModel.extra_repr
            • MnistModel.float
            • MnistModel.forward
            • MnistModel.get_buffer
            • MnistModel.get_extra_state
            • MnistModel.get_parameter
            • MnistModel.get_submodule
            • MnistModel.half
            • MnistModel.load_state_dict
            • MnistModel.modules
            • MnistModel.named_buffers
            • MnistModel.named_children
            • MnistModel.named_modules
            • MnistModel.named_parameters
            • MnistModel.parameters
            • MnistModel.register_backward_hook
            • MnistModel.register_buffer
            • MnistModel.register_forward_hook
            • MnistModel.register_forward_pre_hook
            • MnistModel.register_full_backward_hook
            • MnistModel.register_parameter
            • MnistModel.requires_grad_
            • MnistModel.set_extra_state
            • MnistModel.share_memory
            • MnistModel.state_dict
            • MnistModel.to
            • MnistModel.to_empty
            • MnistModel.train
            • MnistModel.type
            • MnistModel.xpu
            • MnistModel.zero_grad
          • TorchMnistDataset
            • TorchMnistDataset.class_to_idx
            • TorchMnistDataset.classes
            • TorchMnistDataset.functions
            • TorchMnistDataset.mirrors
            • TorchMnistDataset.processed_folder
            • TorchMnistDataset.raw_folder
            • TorchMnistDataset.resources
            • TorchMnistDataset.test_data
            • TorchMnistDataset.test_file
            • TorchMnistDataset.test_labels
            • TorchMnistDataset.train_data
            • TorchMnistDataset.train_labels
            • TorchMnistDataset.training_file
            • TorchMnistDataset.download
            • TorchMnistDataset.extra_repr
            • TorchMnistDataset.register_datapipe_as_function
            • TorchMnistDataset.register_function
          • IterableTorchMnistDataset
            • IterableTorchMnistDataset.functions
            • IterableTorchMnistDataset.mirrors
            • IterableTorchMnistDataset.raw_folder
            • IterableTorchMnistDataset.reduce_ex_hook
            • IterableTorchMnistDataset.resources
            • IterableTorchMnistDataset.type
            • IterableTorchMnistDataset.download
            • IterableTorchMnistDataset.register_datapipe_as_function
            • IterableTorchMnistDataset.register_function
            • IterableTorchMnistDataset.reinforce_type
            • IterableTorchMnistDataset.set_reduce_ex_hook
        • mnist_tensorflow
          • load_dataset
          • load_model
      • detection
        • coco_torch
          • load_dataset
          • load_model
          • CocoDataset
            • CocoDataset.functions
            • CocoDataset.download_coco128
            • CocoDataset.extra_repr
            • CocoDataset.register_datapipe_as_function
            • CocoDataset.register_function
        • mask
          • load_dataset
          • load_model
          • get_data_timestamps
          • MaskDataset
            • MaskDataset.functions
            • MaskDataset.download_mask
            • MaskDataset.extra_repr
            • MaskDataset.get_time_to_sample_dict
            • MaskDataset.register_datapipe_as_function
            • MaskDataset.register_function
        • coco_tensorflow
          • load_dataset
      • segmentation
        • __builtins__
        • __cached__
        • __doc__
        • __file__
        • __name__
        • __package__
        • __path__
    • utils
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __name__
      • __package__
      • __path__
    • metrics_utils
      • get_scorers_dict
      • metric_results_to_df
      • ObjectDetectionAveragePrecision
        • ObjectDetectionAveragePrecision.required_output_keys
        • ObjectDetectionAveragePrecision.attach
        • ObjectDetectionAveragePrecision.calc_pairwise_ious
        • ObjectDetectionAveragePrecision.completed
        • ObjectDetectionAveragePrecision.compute
        • ObjectDetectionAveragePrecision.detach
        • ObjectDetectionAveragePrecision.filter_res
        • ObjectDetectionAveragePrecision.get_classes_scores_at
        • ObjectDetectionAveragePrecision.get_confidences
        • ObjectDetectionAveragePrecision.get_detection_areas
        • ObjectDetectionAveragePrecision.get_labels_areas
        • ObjectDetectionAveragePrecision.group_class_detection_label
        • ObjectDetectionAveragePrecision.is_attached
        • ObjectDetectionAveragePrecision.iteration_completed
        • ObjectDetectionAveragePrecision.reset
        • ObjectDetectionAveragePrecision.started
        • ObjectDetectionAveragePrecision.update
      • AveragePrecisionRecall
        • AveragePrecisionRecall.required_output_keys
        • AveragePrecisionRecall.attach
        • AveragePrecisionRecall.calc_pairwise_ious
        • AveragePrecisionRecall.completed
        • AveragePrecisionRecall.compute
        • AveragePrecisionRecall.detach
        • AveragePrecisionRecall.filter_res
        • AveragePrecisionRecall.get_classes_scores_at
        • AveragePrecisionRecall.get_confidences
        • AveragePrecisionRecall.get_detection_areas
        • AveragePrecisionRecall.get_labels_areas
        • AveragePrecisionRecall.group_class_detection_label
        • AveragePrecisionRecall.is_attached
        • AveragePrecisionRecall.iteration_completed
        • AveragePrecisionRecall.reset
        • AveragePrecisionRecall.started
        • AveragePrecisionRecall.update
      • ObjectDetectionTpFpFn
        • ObjectDetectionTpFpFn.required_output_keys
        • ObjectDetectionTpFpFn.attach
        • ObjectDetectionTpFpFn.calc_pairwise_ious
        • ObjectDetectionTpFpFn.completed
        • ObjectDetectionTpFpFn.compute
        • ObjectDetectionTpFpFn.detach
        • ObjectDetectionTpFpFn.get_confidences
        • ObjectDetectionTpFpFn.get_detection_areas
        • ObjectDetectionTpFpFn.get_labels_areas
        • ObjectDetectionTpFpFn.group_class_detection_label
        • ObjectDetectionTpFpFn.is_attached
        • ObjectDetectionTpFpFn.iteration_completed
        • ObjectDetectionTpFpFn.reset
        • ObjectDetectionTpFpFn.started
        • ObjectDetectionTpFpFn.update
      • TpFpFn
        • TpFpFn.required_output_keys
        • TpFpFn.attach
        • TpFpFn.calc_pairwise_ious
        • TpFpFn.completed
        • TpFpFn.compute
        • TpFpFn.detach
        • TpFpFn.get_confidences
        • TpFpFn.get_detection_areas
        • TpFpFn.get_labels_areas
        • TpFpFn.group_class_detection_label
        • TpFpFn.is_attached
        • TpFpFn.iteration_completed
        • TpFpFn.reset
        • TpFpFn.started
        • TpFpFn.update
      • AVAILABLE_EVALUATING_FUNCTIONS
      • CustomClassificationScorer
        • CustomClassificationScorer.required_output_keys
        • CustomClassificationScorer.attach
        • CustomClassificationScorer.completed
        • CustomClassificationScorer.compute
        • CustomClassificationScorer.detach
        • CustomClassificationScorer.is_attached
        • CustomClassificationScorer.iteration_completed
        • CustomClassificationScorer.reset
        • CustomClassificationScorer.started
        • CustomClassificationScorer.update
      • CustomMetric
        • CustomMetric.compute
        • CustomMetric.reset
        • CustomMetric.update
    • vision_data
      • VisionData
        • VisionData.batch_loader
        • VisionData.has_additional_data
        • VisionData.has_embeddings
        • VisionData.has_image_identifiers
        • VisionData.has_images
        • VisionData.has_labels
        • VisionData.has_predictions
        • VisionData.num_classes
        • VisionData.number_of_images_cached
        • VisionData.task_type
        • VisionData.copy
        • VisionData.get_cache
        • VisionData.get_observed_classes
        • VisionData.head
        • VisionData.init_cache
        • VisionData.update_cache
        • VisionData.validate
      • BatchOutputFormat
        • BatchOutputFormat.images
        • BatchOutputFormat.labels
        • BatchOutputFormat.predictions
        • BatchOutputFormat.image_identifiers
        • BatchOutputFormat.clear
        • BatchOutputFormat.copy
        • BatchOutputFormat.fromkeys
        • BatchOutputFormat.get
        • BatchOutputFormat.items
        • BatchOutputFormat.keys
        • BatchOutputFormat.pop
        • BatchOutputFormat.popitem
        • BatchOutputFormat.setdefault
        • BatchOutputFormat.update
        • BatchOutputFormat.values
      • TaskType
        • TaskType.values
    • base_checks
      • SingleDatasetCheck
        • SingleDatasetCheck.add_condition
        • SingleDatasetCheck.clean_conditions
        • SingleDatasetCheck.compute
        • SingleDatasetCheck.conditions_decision
        • SingleDatasetCheck.config
        • SingleDatasetCheck.from_config
        • SingleDatasetCheck.from_json
        • SingleDatasetCheck.initialize_run
        • SingleDatasetCheck.metadata
        • SingleDatasetCheck.name
        • SingleDatasetCheck.params
        • SingleDatasetCheck.remove_condition
        • SingleDatasetCheck.run
        • SingleDatasetCheck.to_json
        • SingleDatasetCheck.update
      • TrainTestCheck
        • TrainTestCheck.add_condition
        • TrainTestCheck.clean_conditions
        • TrainTestCheck.compute
        • TrainTestCheck.conditions_decision
        • TrainTestCheck.config
        • TrainTestCheck.from_config
        • TrainTestCheck.from_json
        • TrainTestCheck.initialize_run
        • TrainTestCheck.metadata
        • TrainTestCheck.name
        • TrainTestCheck.params
        • TrainTestCheck.remove_condition
        • TrainTestCheck.run
        • TrainTestCheck.to_json
        • TrainTestCheck.update
      • ModelOnlyCheck
        • ModelOnlyCheck.add_condition
        • ModelOnlyCheck.clean_conditions
        • ModelOnlyCheck.compute
        • ModelOnlyCheck.conditions_decision
        • ModelOnlyCheck.config
        • ModelOnlyCheck.from_config
        • ModelOnlyCheck.from_json
        • ModelOnlyCheck.initialize_run
        • ModelOnlyCheck.metadata
        • ModelOnlyCheck.name
        • ModelOnlyCheck.params
        • ModelOnlyCheck.remove_condition
        • ModelOnlyCheck.run
        • ModelOnlyCheck.to_json
    • context
      • Context
        • Context.task_type
        • Context.test
        • Context.train
        • Context.with_display
        • Context.assert_task_type
        • Context.finalize_check_result
        • Context.get_data_by_kind
        • Context.have_test
    • deprecation_warnings
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __name__
      • __package__
    • metrics
      • ObjectDetectionAveragePrecision
        • ObjectDetectionAveragePrecision.required_output_keys
        • ObjectDetectionAveragePrecision.attach
        • ObjectDetectionAveragePrecision.calc_pairwise_ious
        • ObjectDetectionAveragePrecision.completed
        • ObjectDetectionAveragePrecision.compute
        • ObjectDetectionAveragePrecision.detach
        • ObjectDetectionAveragePrecision.filter_res
        • ObjectDetectionAveragePrecision.get_classes_scores_at
        • ObjectDetectionAveragePrecision.get_confidences
        • ObjectDetectionAveragePrecision.get_detection_areas
        • ObjectDetectionAveragePrecision.get_labels_areas
        • ObjectDetectionAveragePrecision.group_class_detection_label
        • ObjectDetectionAveragePrecision.is_attached
        • ObjectDetectionAveragePrecision.iteration_completed
        • ObjectDetectionAveragePrecision.reset
        • ObjectDetectionAveragePrecision.started
        • ObjectDetectionAveragePrecision.update
      • ObjectDetectionTpFpFn
        • ObjectDetectionTpFpFn.required_output_keys
        • ObjectDetectionTpFpFn.attach
        • ObjectDetectionTpFpFn.calc_pairwise_ious
        • ObjectDetectionTpFpFn.completed
        • ObjectDetectionTpFpFn.compute
        • ObjectDetectionTpFpFn.detach
        • ObjectDetectionTpFpFn.get_confidences
        • ObjectDetectionTpFpFn.get_detection_areas
        • ObjectDetectionTpFpFn.get_labels_areas
        • ObjectDetectionTpFpFn.group_class_detection_label
        • ObjectDetectionTpFpFn.is_attached
        • ObjectDetectionTpFpFn.iteration_completed
        • ObjectDetectionTpFpFn.reset
        • ObjectDetectionTpFpFn.started
        • ObjectDetectionTpFpFn.update
      • MeanDice
        • MeanDice.required_output_keys
        • MeanDice.attach
        • MeanDice.completed
        • MeanDice.compute
        • MeanDice.detach
        • MeanDice.is_attached
        • MeanDice.iteration_completed
        • MeanDice.reset
        • MeanDice.started
        • MeanDice.update
      • MeanIoU
        • MeanIoU.required_output_keys
        • MeanIoU.attach
        • MeanIoU.completed
        • MeanIoU.compute
        • MeanIoU.detach
        • MeanIoU.is_attached
        • MeanIoU.iteration_completed
        • MeanIoU.reset
        • MeanIoU.started
        • MeanIoU.update
    • suite
      • Suite
        • Suite.add
        • Suite.config
        • Suite.from_config
        • Suite.from_json
        • Suite.remove
        • Suite.run
        • Suite.supported_checks
        • Suite.to_json
  • deepchecks.nlp
    • checks
      • PropertyLabelCorrelation
        • PropertyLabelCorrelation.add_condition
        • PropertyLabelCorrelation.add_condition_property_pps_less_than
        • PropertyLabelCorrelation.clean_conditions
        • PropertyLabelCorrelation.conditions_decision
        • PropertyLabelCorrelation.config
        • PropertyLabelCorrelation.from_config
        • PropertyLabelCorrelation.from_json
        • PropertyLabelCorrelation.metadata
        • PropertyLabelCorrelation.name
        • PropertyLabelCorrelation.params
        • PropertyLabelCorrelation.remove_condition
        • PropertyLabelCorrelation.run
        • PropertyLabelCorrelation.run_logic
        • PropertyLabelCorrelation.to_json
      • SingleDatasetPerformance
        • SingleDatasetPerformance.add_condition
        • SingleDatasetPerformance.add_condition_greater_than
        • SingleDatasetPerformance.clean_conditions
        • SingleDatasetPerformance.conditions_decision
        • SingleDatasetPerformance.config
        • SingleDatasetPerformance.from_config
        • SingleDatasetPerformance.from_json
        • SingleDatasetPerformance.greater_is_better
        • SingleDatasetPerformance.metadata
        • SingleDatasetPerformance.name
        • SingleDatasetPerformance.params
        • SingleDatasetPerformance.reduce_output
        • SingleDatasetPerformance.remove_condition
        • SingleDatasetPerformance.run
        • SingleDatasetPerformance.run_logic
        • SingleDatasetPerformance.to_json
      • MetadataSegmentsPerformance
        • MetadataSegmentsPerformance.add_condition
        • MetadataSegmentsPerformance.add_condition_segments_relative_performance_greater_than
        • MetadataSegmentsPerformance.clean_conditions
        • MetadataSegmentsPerformance.conditions_decision
        • MetadataSegmentsPerformance.config
        • MetadataSegmentsPerformance.from_config
        • MetadataSegmentsPerformance.from_json
        • MetadataSegmentsPerformance.metadata
        • MetadataSegmentsPerformance.name
        • MetadataSegmentsPerformance.params
        • MetadataSegmentsPerformance.remove_condition
        • MetadataSegmentsPerformance.run
        • MetadataSegmentsPerformance.run_logic
        • MetadataSegmentsPerformance.to_json
      • PropertySegmentsPerformance
        • PropertySegmentsPerformance.add_condition
        • PropertySegmentsPerformance.add_condition_segments_relative_performance_greater_than
        • PropertySegmentsPerformance.clean_conditions
        • PropertySegmentsPerformance.conditions_decision
        • PropertySegmentsPerformance.config
        • PropertySegmentsPerformance.from_config
        • PropertySegmentsPerformance.from_json
        • PropertySegmentsPerformance.metadata
        • PropertySegmentsPerformance.name
        • PropertySegmentsPerformance.params
        • PropertySegmentsPerformance.remove_condition
        • PropertySegmentsPerformance.run
        • PropertySegmentsPerformance.run_logic
        • PropertySegmentsPerformance.to_json
      • PredictionDrift
        • PredictionDrift.add_condition
        • PredictionDrift.add_condition_drift_score_less_than
        • PredictionDrift.clean_conditions
        • PredictionDrift.conditions_decision
        • PredictionDrift.config
        • PredictionDrift.from_config
        • PredictionDrift.from_json
        • PredictionDrift.metadata
        • PredictionDrift.name
        • PredictionDrift.params
        • PredictionDrift.remove_condition
        • PredictionDrift.run
        • PredictionDrift.run_logic
        • PredictionDrift.to_json
      • LabelDrift
        • LabelDrift.add_condition
        • LabelDrift.add_condition_drift_score_less_than
        • LabelDrift.clean_conditions
        • LabelDrift.conditions_decision
        • LabelDrift.config
        • LabelDrift.from_config
        • LabelDrift.from_json
        • LabelDrift.metadata
        • LabelDrift.name
        • LabelDrift.params
        • LabelDrift.remove_condition
        • LabelDrift.run
        • LabelDrift.run_logic
        • LabelDrift.to_json
    • suites
      • data_integrity
      • train_test_validation
      • model_evaluation
      • full_suite
    • datasets
      • classification
        • tweet_emotion
          • load_data
          • load_embeddings
          • load_precalculated_predictions
    • metric_utils
      • get_default_token_scorers
      • validate_scorers
      • get_scorer_dict
      • init_validate_scorers
      • infer_on_text_data
    • utils
      • calculate_embeddings_for_text
    • text_data
      • TextData
        • TextData.is_multilabel
        • TextData.label
        • TextData.metadata
        • TextData.n_samples
        • TextData.name
        • TextData.properties
        • TextData.task_type
        • TextData.text
        • TextData.tokenized_text
        • TextData.index
        • TextData.calculate_default_properties
        • TextData.cast_to_dataset
        • TextData.copy
        • TextData.datasets_share_task_type
        • TextData.get_raw_sample
        • TextData.get_tokenized_sample
        • TextData.has_label
        • TextData.head
        • TextData.is_sampled
        • TextData.len_when_sampled
        • TextData.reindex
        • TextData.sample
        • TextData.set_metadata
        • TextData.set_properties
    • base_checks
      • SingleDatasetCheck
        • SingleDatasetCheck.add_condition
        • SingleDatasetCheck.clean_conditions
        • SingleDatasetCheck.conditions_decision
        • SingleDatasetCheck.config
        • SingleDatasetCheck.from_config
        • SingleDatasetCheck.from_json
        • SingleDatasetCheck.metadata
        • SingleDatasetCheck.name
        • SingleDatasetCheck.params
        • SingleDatasetCheck.remove_condition
        • SingleDatasetCheck.run
        • SingleDatasetCheck.run_logic
        • SingleDatasetCheck.to_json
      • TrainTestCheck
        • TrainTestCheck.add_condition
        • TrainTestCheck.clean_conditions
        • TrainTestCheck.conditions_decision
        • TrainTestCheck.config
        • TrainTestCheck.from_config
        • TrainTestCheck.from_json
        • TrainTestCheck.metadata
        • TrainTestCheck.name
        • TrainTestCheck.params
        • TrainTestCheck.remove_condition
        • TrainTestCheck.run
        • TrainTestCheck.run_logic
        • TrainTestCheck.to_json
    • context
      • Context
        • Context.model
        • Context.model_classes
        • Context.model_name
        • Context.observed_classes
        • Context.task_type
        • Context.test
        • Context.train
        • Context.with_display
        • Context.assert_metadata
        • Context.assert_properties
        • Context.assert_task_type
        • Context.finalize_check_result
        • Context.get_data_by_kind
        • Context.get_scorers
        • Context.get_single_scorer
        • Context.have_test
        • Context.infer_task_type
    • suite
      • Suite
        • Suite.add
        • Suite.config
        • Suite.from_config
        • Suite.from_json
        • Suite.remove
        • Suite.run
        • Suite.supported_checks
        • Suite.to_json
  • deepchecks.utils
    • array_math
      • fast_sum_by_row
      • sequence_to_numpy
    • correlation_methods
      • conditional_entropy
      • correlation_ratio
      • symmetric_theil_u_correlation
      • theil_u_correlation
    • dataframes
      • validate_columns_exist
      • select_from_dataframe
      • un_numpy
      • generalized_corrwith
      • floatify_dataframe
      • floatify_series
      • default_fill_na_per_column_type
      • is_float_column
    • decorators
      • deprecate_kwarg
      • Substitution
        • Substitution.update
      • Appender
        • Appender.addendum
    • dict_funcs
      • get_dict_entry_by_value
      • sort_dict
    • display
      • imagetag
      • display_in_gui
    • docref
      • doclink
    • function
      • run_available_kwargs
      • initvars
    • gower_distance
      • calculate_distance
      • calculate_nearest_neighbors_distances
      • gower_matrix
    • html
      • imagetag
      • linktag
    • ipython
      • is_notebook
      • is_headless
      • create_progress_bar
      • is_colab_env
      • is_kaggle_env
      • is_databricks_env
      • is_sagemaker_env
      • is_terminal_interactive_shell
      • is_zmq_interactive_shell
      • is_sphinx
      • ProgressBarGroup
        • ProgressBarGroup.register
        • ProgressBarGroup.create
        • ProgressBarGroup.create_dummy
    • json_utils
      • from_json
    • logger
      • get_logger
      • get_verbosity
      • set_verbosity
    • metrics
      • get_gain
      • get_scorer_name
      • averaging_mechanism
    • model
      • get_model_of_pipeline
    • outliers
      • iqr_outliers_range
    • plot
      • create_colorbar_barchart_for_check
      • shifted_color_map
      • create_confusion_matrix_figure
      • hex_to_rgba
    • simple_models
      • PerfectModel
        • PerfectModel.fit
        • PerfectModel.predict
        • PerfectModel.predict_proba
      • RandomModel
        • RandomModel.fit
        • RandomModel.predict
        • RandomModel.predict_proba
      • ClassificationUniformModel
        • ClassificationUniformModel.fit
        • ClassificationUniformModel.predict
        • ClassificationUniformModel.predict_proba
      • RegressionUniformModel
        • RegressionUniformModel.fit
        • RegressionUniformModel.predict
    • single_sample_metrics
      • calculate_per_sample_loss
      • per_sample_cross_entropy
      • per_sample_mse
    • 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
      • get_docs_link
    • typing
      • Hashable
      • BasicModel
        • BasicModel.predict
      • ClassificationModel
        • ClassificationModel.predict
        • ClassificationModel.predict_proba
    • validation
      • ensure_hashable_or_mutable_sequence
      • is_sequence_not_str
    • wandb_utils
      • wandb_run

doclink#

doclink(name: str, default_link: Optional[str] = None, template: Optional[str] = None, package_version: str = '0.13.0') → str[source]#

Get documentation link.

Parameters
name: str

the name of the required link as appears in the links’ dictionary.

default_link: t.Optional[str], default: None

default like to use if no link corresponding to name was found.

template: t.Optional[str], default: None

a string template in which to incorporate the link.

package_version: str

which version of the docs to use

Returns
str

The template text incorporated with the relevant link

previous

docref

next

function

© Copyright 2021-2023, Deepchecks.

Created using Sphinx 4.5.0.