general
logo
  • Getting Started
  • General
  • Tabular
  • NLP
  • Vision
  • API Reference
  • Monitoring
  • CI
Report a problem Show Source

API Reference

  • deepchecks.core
    • checks
      • DatasetKind
      • BaseCheck
      • SingleDatasetBaseCheck
      • TrainTestBaseCheck
      • ModelOnlyBaseCheck
    • 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
      • train_test_validation
      • model_evaluation
    • suites
      • data_integrity
      • train_test_validation
      • model_evaluation
      • full_suite
    • datasets
      • classification
      • regression
    • 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
      • init_validate_scorers
      • get_default_scorers
    • utils
      • __all__
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __loader__
      • __name__
      • __package__
      • __path__
      • __spec__
      • feature_importance
      • messages
      • task_inference
      • task_type
      • validation
  • deepchecks.vision
    • checks
      • data_integrity
      • train_test_validation
      • model_evaluation
    • suites
      • data_integrity
      • train_test_validation
      • model_evaluation
      • full_suite
    • datasets
      • classification
      • detection
      • segmentation
    • utils
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __name__
      • __package__
      • __path__
    • metrics_utils
      • get_scorers_dict
      • metric_results_to_df
      • ObjectDetectionAveragePrecision
      • AveragePrecisionRecall
      • ObjectDetectionTpFpFn
      • TpFpFn
      • AVAILABLE_EVALUATING_FUNCTIONS
      • CustomClassificationScorer
      • CustomMetric
    • vision_data
      • VisionData
      • BatchOutputFormat
      • TaskType
    • base_checks
      • SingleDatasetCheck
      • TrainTestCheck
      • ModelOnlyCheck
    • context
      • Context
    • deprecation_warnings
      • __builtins__
      • __cached__
      • __doc__
      • __file__
      • __name__
      • __package__
    • metrics
      • ObjectDetectionAveragePrecision
      • ObjectDetectionTpFpFn
      • MeanDice
      • MeanIoU
    • suite
      • Suite
  • deepchecks.nlp
    • checks
      • data_integrity
      • train_test_validation
      • model_evaluation
    • suites
      • train_test_validation
      • model_evaluation
      • full_suite
    • datasets
      • classification
      • token_classification
    • metric_utils
      • get_default_token_scorers
      • validate_scorers
      • get_scorer_dict
      • init_validate_scorers
      • infer_on_text_data
    • utils
      • calculate_builtin_properties
      • calculate_builtin_embeddings
      • call_open_ai_completion_api
    • text_data
      • TextData
    • base_checks
      • SingleDatasetCheck
      • TrainTestCheck
    • context
      • Context
    • suite
      • Suite
  • 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
      • default_fill_na_series
      • cast_categorical_to_object_dtype
      • hide_index_for_display
    • decorators
      • deprecate_kwarg
      • Substitution
      • Appender
    • 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
    • json_utils
      • from_json
    • logger
      • get_logger
      • get_verbosity
      • set_verbosity
    • metrics
      • get_gain
      • get_scorer_name
      • averaging_mechanism
      • is_label_none
    • model
      • get_model_of_pipeline
    • outliers
      • iqr_outliers_range
      • sharp_drop_outliers_range
    • plot
      • create_colorbar_barchart_for_check
      • shifted_color_map
      • hex_to_rgba
    • simple_models
      • PerfectModel
      • RandomModel
      • ClassificationUniformModel
      • RegressionUniformModel
    • single_sample_metrics
      • calculate_neg_cross_entropy_per_sample
      • calculate_neg_mse_per_sample
    • 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
      • truncate_string
      • 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
      • ClassificationModel
    • validation
      • ensure_hashable_or_mutable_sequence
      • is_sequence_not_str
    • wandb_utils
      • wandb_run

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-2023, Deepchecks.

Created using Sphinx 4.5.0.