Examples restructure (#1335)

* Restructuring galleries * Restructuring galleries * Fixing read more urls * fix plot_simple_classification_tutorial.py * Fixing tutorials navbar * fix git ignore
deepchecks · Apr 27, 2022 · f442813 · f442813
1 parent c700e58
commit f442813
Show file tree

Hide file tree

Showing 99 changed files with 110 additions and 193 deletions.
diff --git a/.gitignore b/.gitignore
@@ -96,24 +96,11 @@ docs.error.log
 *MNIST*
 
 # build folders of sphinx gallery
-docs/source/examples/vision/guides/examples/
-docs/source/examples/general/examples/
-docs/source/examples/vision/checks/distribution/examples/
-docs/source/examples/vision/checks/performance/examples/
-docs/source/examples/tabular/guides/examples/
-docs/source/examples/tabular/checks/distribution/examples/
-docs/source/examples/tabular/checks/overview/examples/
-docs/source/examples/tabular/checks/integrity/examples/
-docs/source/examples/tabular/checks/methodology/examples/
-docs/source/examples/tabular/checks/performance/examples/
-docs/source/examples/tabular/use-cases/examples/
-docs/source/examples/tabular/checks/methodology/examples/
-docs/source/tutorials/tabular/examples
-docs/source/tutorials/vision/examples
-docs/source/examples/vision/checks/methodology/examples/
 docs/source/user-guide/general/customizations/examples/
 docs/source/user-guide/general/exporting_results/examples/
-docs/source/tutorials/tabular/examples/
+docs/source/checks_gallery/
+docs/source/auto_tutorials/tabular
+docs/source/auto_tutorials/vision
 
 # build artifacts from running docs (vision and wandb export)
 docs/source/tutorials/vision/*.html

diff --git a/deepchecks/utils/strings.py b/deepchecks/utils/strings.py
@@ -152,7 +152,7 @@ def generate_check_docs_link(check):
         return ''
 
     link_template = (
-        'https://docs.deepchecks.com/{version}/examples/{path}.html'
+        'https://docs.deepchecks.com/{version}/checks_gallery/{path}.html'
         '?utm_source=display_output&utm_medium=referral'
         '&utm_campaign=check_link'
     )
@@ -161,13 +161,13 @@ def generate_check_docs_link(check):
     # understand how link is formatted:
     #
     # - deepchecks.tabular.checks.integrity.StringMismatchComparison
-    # - https://docs.deepchecks.com/{version}/examples/tabular/checks/integrity/examples/plot_string_mismatch_comparison.html # noqa: E501 # pylint: disable=line-too-long
+    # - https://docs.deepchecks.com/{version}/checks_gallery/tabular/integrity/plot_string_mismatch_comparison.html # noqa: E501 # pylint: disable=line-too-long
 
     # Remove deepchecks from the start
     module_path = module_path[len('deepchecks.'):]
     module_parts = module_path.split('.')
     module_parts[-1] = f'plot_{module_parts[-1]}'
-    module_parts.insert(len(module_parts) - 1, 'examples')
+    module_parts.remove('checks')
     url = '/'.join([*module_parts])
     if deepchecks.__version__ and deepchecks.__version__ != 'dev':
         version_obj: Version = Version(deepchecks.__version__)

diff --git a/deepchecks/vision/detection_data.py b/deepchecks/vision/detection_data.py
@@ -135,7 +135,7 @@ def validate_label(self, batch):
         batch
 
         Raises
-        -------
+        ------
         DeepchecksValueError
             If labels format is invalid
         DeepchecksNotImplementedError

diff --git a/deepchecks/vision/vision_data.py b/deepchecks/vision/vision_data.py
@@ -385,7 +385,7 @@ def validate_image_data(self, batch):
         batch
 
         Raises
-        -------
+        ------
         DeepchecksValueError
             If the batch data doesn't fit the format after being transformed by self().
 
@@ -415,7 +415,7 @@ def validate_get_classes(self, batch):
         batch
 
         Raises
-        -------
+        ------
         ValidationError
             If the classes data doesn't fit the format after being transformed.
         """

diff --git a/docs/source/_templates/autosummary/check.rst b/docs/source/_templates/autosummary/check.rst
@@ -10,7 +10,7 @@
 {# submoduletype = tabular|vision... #}
 {% set submoduletype = splitname[1] %}
 
-{% set path = getcwd() + '/source/examples/' + submoduletype + '/checks/' + checktype + '/source/plot_' + to_snake_case(objname).lower() + '.py' %}
+{% set path = getcwd() + '/source/checks/' + submoduletype + '/' + checktype + '/plot_' + to_snake_case(objname).lower() + '.py' %}
 
 {%- if path_exists(path) %}
 Examples
@@ -22,14 +22,16 @@ Examples
 
 .. only:: html
 
- .. figure:: /examples/{{ submoduletype }}/checks/{{ checktype}}/examples/images/thumb/sphx_glr_plot_{{ to_snake_case(objname).lower() }}_thumb.png
+ .. figure:: /checks_gallery/{{ submoduletype }}/{{ checktype}}/images/thumb/sphx_glr_plot_{{ to_snake_case(objname).lower() }}_thumb.png
      :alt: {{ objname }}
 
-     :ref:`sphx_glr_examples_{{submoduletype}}_checks_{{ checktype }}_examples_plot_{{ to_snake_case(objname).lower() }}.py`
+     :ref:`sphx_glr_checks_gallery_{{submoduletype}}_{{ checktype }}_plot_{{ to_snake_case(objname).lower() }}.py`
 
 .. raw:: html
 
     </div>
     <div style="clear:both"></div>
 {%- endif %}
+
+
 {% endblock %}
diff --git a/docs/source/api/deepchecks.vision.checks.rst b/docs/source/api/deepchecks.vision.checks.rst
@@ -12,4 +12,5 @@ checks
     :template: autosummary/check-module.rst
 
     distribution
+    methodology
     performance
diff --git a/docs/source/tutorials/index.rst → docs/source/auto_tutorials/index.rst b/docs/source/tutorials/index.rst → docs/source/auto_tutorials/index.rst
@@ -5,21 +5,20 @@ Tutorials
 ==========
 
 Tabular Tutorials
------------------
+=================
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
     :caption: Tabular Tutorials
-    :glob:
 
-    tabular/examples/plot*
+    tabular/index
 
 Vision Tutorials
-----------------
+================
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
     :caption: Vision Tutorials
     :glob:
 
-    vision/examples/plot*
+    vision/index
diff --git a/docs/source/examples/.nbval-sanitizer → docs/source/checks/.nbval-sanitizer b/docs/source/examples/.nbval-sanitizer → docs/source/checks/.nbval-sanitizer
diff --git a/docs/source/checks/tabular/README.txt b/docs/source/checks/tabular/README.txt
@@ -0,0 +1,3 @@
+================
+Tabular Checks
+================
diff --git a/docs/source/checks/tabular/distribution/README.txt b/docs/source/checks/tabular/distribution/README.txt
@@ -0,0 +1,2 @@
+Data Distribution
+===================
diff --git a/...n/source/plot_train_test_feature_drift.py → ...ribution/plot_train_test_feature_drift.py b/...n/source/plot_train_test_feature_drift.py → ...ribution/plot_train_test_feature_drift.py
@@ -40,7 +40,7 @@
 training a classifier that detects which samples come from a known
 distribution and defines the drift by the accuracy of this classifier. For
 more information, refer to the :doc:`Whole Dataset Drift check
-</examples/tabular/checks/distribution/examples/plot_whole_dataset_drift>`.
+</checks_gallery/tabular/distribution/plot_whole_dataset_drift>`.
 
 Other approaches include statistical methods aim to measure difference
 between distribution of 2 given sets. We exprimented with various approaches

diff --git a/...ion/source/plot_train_test_label_drift.py → ...stribution/plot_train_test_label_drift.py b/...ion/source/plot_train_test_label_drift.py → ...stribution/plot_train_test_label_drift.py
diff --git a/...ource/plot_train_test_prediction_drift.py → ...ution/plot_train_test_prediction_drift.py b/...ource/plot_train_test_prediction_drift.py → ...ution/plot_train_test_prediction_drift.py
diff --git a/...bution/source/plot_whole_dataset_drift.py → .../distribution/plot_whole_dataset_drift.py b/...bution/source/plot_whole_dataset_drift.py → .../distribution/plot_whole_dataset_drift.py
@@ -28,7 +28,7 @@
 * Change in relation between features, or covariate shift.
 
 The difference between a :doc:`feature drift
-</examples/tabular/checks/distribution/examples/plot_train_test_feature_drift>`
+</checks_gallery/tabular/distribution/plot_train_test_feature_drift>`
 (or univariate dataset drift) and a multivariate drift is that in the
 latter the data drift occures in more that one feature.
 

diff --git a/docs/source/checks/tabular/integrity/README.txt b/docs/source/checks/tabular/integrity/README.txt
@@ -0,0 +1,2 @@
+Data Integrity
+==============
diff --git a/...urce/plot_category_mismatch_train_test.py → ...rity/plot_category_mismatch_train_test.py b/...urce/plot_category_mismatch_train_test.py → ...rity/plot_category_mismatch_train_test.py
diff --git a/.../integrity/source/plot_data_duplicates.py → ...tabular/integrity/plot_data_duplicates.py b/.../integrity/source/plot_data_duplicates.py → ...tabular/integrity/plot_data_duplicates.py
diff --git a/.../source/plot_dominant_frequency_change.py → ...tegrity/plot_dominant_frequency_change.py b/.../source/plot_dominant_frequency_change.py → ...tegrity/plot_dominant_frequency_change.py
diff --git a/.../integrity/source/plot_is_single_value.py → ...tabular/integrity/plot_is_single_value.py b/.../integrity/source/plot_is_single_value.py → ...tabular/integrity/plot_is_single_value.py
diff --git a/.../integrity/source/plot_label_ambiguity.py → ...tabular/integrity/plot_label_ambiguity.py b/.../integrity/source/plot_label_ambiguity.py → ...tabular/integrity/plot_label_ambiguity.py
diff --git a/...integrity/source/plot_mixed_data_types.py → ...abular/integrity/plot_mixed_data_types.py b/...integrity/source/plot_mixed_data_types.py → ...abular/integrity/plot_mixed_data_types.py
diff --git a/...ecks/integrity/source/plot_mixed_nulls.py → ...cks/tabular/integrity/plot_mixed_nulls.py b/...ecks/integrity/source/plot_mixed_nulls.py → ...cks/tabular/integrity/plot_mixed_nulls.py
diff --git a/...grity/source/plot_new_label_train_test.py → ...ar/integrity/plot_new_label_train_test.py b/...grity/source/plot_new_label_train_test.py → ...ar/integrity/plot_new_label_train_test.py
diff --git a/...y/source/plot_outlier_sample_detection.py → ...ntegrity/plot_outlier_sample_detection.py b/...y/source/plot_outlier_sample_detection.py → ...ntegrity/plot_outlier_sample_detection.py
diff --git a/...ks/integrity/source/plot_special_chars.py → ...s/tabular/integrity/plot_special_chars.py b/...ks/integrity/source/plot_special_chars.py → ...s/tabular/integrity/plot_special_chars.py
diff --git a/...ource/plot_string_length_out_of_bounds.py → ...grity/plot_string_length_out_of_bounds.py b/...ource/plot_string_length_out_of_bounds.py → ...grity/plot_string_length_out_of_bounds.py
diff --git a/.../integrity/source/plot_string_mismatch.py → ...tabular/integrity/plot_string_mismatch.py b/.../integrity/source/plot_string_mismatch.py → ...tabular/integrity/plot_string_mismatch.py
diff --git a/...source/plot_string_mismatch_comparison.py → ...egrity/plot_string_mismatch_comparison.py b/...source/plot_string_mismatch_comparison.py → ...egrity/plot_string_mismatch_comparison.py
diff --git a/...sion/checks/methodology/source/README.rst → ...rce/checks/tabular/methodology/README.txt b/...sion/checks/methodology/source/README.rst → ...rce/checks/tabular/methodology/README.txt
diff --git a/...thodology/source/plot_boosting_overfit.py → ...ular/methodology/plot_boosting_overfit.py b/...thodology/source/plot_boosting_overfit.py → ...ular/methodology/plot_boosting_overfit.py
diff --git a/...y/source/plot_datasets_size_comparison.py → ...hodology/plot_datasets_size_comparison.py b/...y/source/plot_datasets_size_comparison.py → ...hodology/plot_datasets_size_comparison.py
diff --git a/...lot_date_train_test_leakage_duplicates.py → ...lot_date_train_test_leakage_duplicates.py b/...lot_date_train_test_leakage_duplicates.py → ...lot_date_train_test_leakage_duplicates.py
diff --git a/...e/plot_date_train_test_leakage_overlap.py → ...y/plot_date_train_test_leakage_overlap.py b/...e/plot_date_train_test_leakage_overlap.py → ...y/plot_date_train_test_leakage_overlap.py
diff --git a/...odology/source/plot_identifier_leakage.py → ...ar/methodology/plot_identifier_leakage.py b/...odology/source/plot_identifier_leakage.py → ...ar/methodology/plot_identifier_leakage.py
diff --git a/.../methodology/source/plot_index_leakage.py → ...tabular/methodology/plot_index_leakage.py b/.../methodology/source/plot_index_leakage.py → ...tabular/methodology/plot_index_leakage.py
diff --git a/...ology/source/plot_model_inference_time.py → .../methodology/plot_model_inference_time.py b/...ology/source/plot_model_inference_time.py → .../methodology/plot_model_inference_time.py
diff --git a/...ource/plot_single_feature_contribution.py → ...ology/plot_single_feature_contribution.py b/...ource/plot_single_feature_contribution.py → ...ology/plot_single_feature_contribution.py
diff --git a/...single_feature_contribution_train_test.py → ...single_feature_contribution_train_test.py b/...single_feature_contribution_train_test.py → ...single_feature_contribution_train_test.py
diff --git a/...ogy/source/plot_train_test_samples_mix.py → ...ethodology/plot_train_test_samples_mix.py b/...ogy/source/plot_train_test_samples_mix.py → ...ethodology/plot_train_test_samples_mix.py
diff --git a/...ethodology/source/plot_unused_features.py → ...bular/methodology/plot_unused_features.py b/...ethodology/source/plot_unused_features.py → ...bular/methodology/plot_unused_features.py
diff --git a/...tabular/checks/overview/source/README.rst → ...source/checks/tabular/overview/README.txt b/...tabular/checks/overview/source/README.rst → ...source/checks/tabular/overview/README.txt
diff --git a/...ecks/overview/source/plot_columns_info.py → ...cks/tabular/overview/plot_columns_info.py b/...ecks/overview/source/plot_columns_info.py → ...cks/tabular/overview/plot_columns_info.py
diff --git a/...checks/overview/source/plot_model_info.py → ...hecks/tabular/overview/plot_model_info.py b/...checks/overview/source/plot_model_info.py → ...hecks/tabular/overview/plot_model_info.py
diff --git a/...ular/checks/performance/source/README.rst → ...rce/checks/tabular/performance/README.txt b/...ular/checks/performance/source/README.rst → ...rce/checks/tabular/performance/README.txt
diff --git a/...formance/source/plot_calibration_score.py → ...lar/performance/plot_calibration_score.py b/...formance/source/plot_calibration_score.py → ...lar/performance/plot_calibration_score.py
diff --git a/...ce/source/plot_confusion_matrix_report.py → ...rformance/plot_confusion_matrix_report.py b/...ce/source/plot_confusion_matrix_report.py → ...rformance/plot_confusion_matrix_report.py
diff --git a/...mance/source/plot_model_error_analysis.py → .../performance/plot_model_error_analysis.py b/...mance/source/plot_model_error_analysis.py → .../performance/plot_model_error_analysis.py
diff --git a/...ce/plot_multi_model_performance_report.py → ...ce/plot_multi_model_performance_report.py b/...ce/plot_multi_model_performance_report.py → ...ce/plot_multi_model_performance_report.py
diff --git a/...ormance/source/plot_performance_report.py → ...ar/performance/plot_performance_report.py b/...ormance/source/plot_performance_report.py → ...ar/performance/plot_performance_report.py
diff --git a/...rce/plot_regression_error_distribution.py → ...nce/plot_regression_error_distribution.py b/...rce/plot_regression_error_distribution.py → ...nce/plot_regression_error_distribution.py
diff --git a/...ource/plot_regression_systematic_error.py → ...mance/plot_regression_systematic_error.py b/...ource/plot_regression_systematic_error.py → ...mance/plot_regression_systematic_error.py
diff --git a/...cks/performance/source/plot_roc_report.py → ...ks/tabular/performance/plot_roc_report.py b/...cks/performance/source/plot_roc_report.py → ...ks/tabular/performance/plot_roc_report.py
diff --git a/...rmance/source/plot_segment_performance.py → ...r/performance/plot_segment_performance.py b/...rmance/source/plot_segment_performance.py → ...r/performance/plot_segment_performance.py
diff --git a/...ce/source/plot_simple_model_comparison.py → ...rformance/plot_simple_model_comparison.py b/...ce/source/plot_simple_model_comparison.py → ...rformance/plot_simple_model_comparison.py
diff --git a/docs/source/checks/vision/README.txt b/docs/source/checks/vision/README.txt
@@ -0,0 +1,3 @@
+================
+Vision Checks
+================
diff --git a/...lar/checks/distribution/source/README.rst → ...rce/checks/vision/distribution/README.txt b/...lar/checks/distribution/source/README.rst → ...rce/checks/vision/distribution/README.txt
@@ -1,3 +1,3 @@
-===================
 Data Distribution
-===================
+===================
+
diff --git a/...ibution/source/plot_heatmap_comparison.py → ...n/distribution/plot_heatmap_comparison.py b/...ibution/source/plot_heatmap_comparison.py → ...n/distribution/plot_heatmap_comparison.py
@@ -42,9 +42,9 @@
 Another, more traditional method to detect such drift would be to use statistical methods.
 Such an approach is covered by several builtin check in the deepchecks.vision package, such as the
 :doc:`Label Drift Check
-</examples/vision/checks/distribution/examples/plot_train_test_label_drift>`
+</checks_gallery/vision/distribution/plot_train_test_label_drift>`
 or the :doc:`Image Dataset Drift Check
-</examples/vision/checks/distribution/examples/plot_image_dataset_drift>`.
+</checks_gallery/vision/distribution/plot_image_dataset_drift>`.
 
 
 Run the Check on a Classification Task (MNIST)

diff --git a/...bution/source/plot_image_dataset_drift.py → .../distribution/plot_image_dataset_drift.py b/...bution/source/plot_image_dataset_drift.py → .../distribution/plot_image_dataset_drift.py
diff --git a/...ution/source/plot_image_property_drift.py → ...distribution/plot_image_property_drift.py b/...ution/source/plot_image_property_drift.py → ...distribution/plot_image_property_drift.py
diff --git a/...on/source/plot_image_property_outliers.py → ...tribution/plot_image_property_outliers.py b/...on/source/plot_image_property_outliers.py → ...tribution/plot_image_property_outliers.py
@@ -38,7 +38,7 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 By default the checks use the built-in image properties, and it's also possible to replace the default properties
 with custom ones. For the list of the built-in image properties and explanation about custom properties refer to
-:doc:`vision properties </user-guide/vision/visio_properties>`.
+:doc:`vision properties </user-guide/vision/vision_properties>`.
 
 """
 

diff --git a/...on/source/plot_label_property_outliers.py → ...tribution/plot_label_property_outliers.py b/...on/source/plot_label_property_outliers.py → ...tribution/plot_label_property_outliers.py
@@ -37,7 +37,7 @@
 For object detection we have default built-in label properties. For other tasks you have to define your own custom label
 properties.
 For the list of the built-in object detection label properties and explanation about custom properties refer to
-:doc:`vision properties </user-guide/vision/visio_properties>`.
+:doc:`vision properties </user-guide/vision/vision_properties>`.
 
 """
 

diff --git a/...ion/source/plot_train_test_label_drift.py → ...stribution/plot_train_test_label_drift.py b/...ion/source/plot_train_test_label_drift.py → ...stribution/plot_train_test_label_drift.py
diff --git a/...ource/plot_train_test_prediction_drift.py → ...ution/plot_train_test_prediction_drift.py b/...ource/plot_train_test_prediction_drift.py → ...ution/plot_train_test_prediction_drift.py
diff --git a/...ular/checks/methodology/source/README.rst → ...urce/checks/vision/methodology/README.txt b/...ular/checks/methodology/source/README.rst → ...urce/checks/vision/methodology/README.txt
@@ -1,2 +1,2 @@
 Methodology
-***********
+===========
diff --git a/...logy/source/plot_similar_image_leakage.py → ...methodology/plot_similar_image_leakage.py b/...logy/source/plot_similar_image_leakage.py → ...methodology/plot_similar_image_leakage.py
diff --git a/...ource/plot_simple_feature_contribution.py → ...ology/plot_simple_feature_contribution.py b/...ource/plot_simple_feature_contribution.py → ...ology/plot_simple_feature_contribution.py
diff --git a/...sion/checks/performance/source/README.rst → ...urce/checks/vision/performance/README.txt b/...sion/checks/performance/source/README.rst → ...urce/checks/vision/performance/README.txt
@@ -1,2 +1,2 @@
 Performance
-***********
+===========
diff --git a/...formance/source/plot_class_performance.py → ...ion/performance/plot_class_performance.py b/...formance/source/plot_class_performance.py → ...ion/performance/plot_class_performance.py
diff --git a/...rformance/source/plot_confusion_matrix.py → ...sion/performance/plot_confusion_matrix.py b/...rformance/source/plot_confusion_matrix.py → ...sion/performance/plot_confusion_matrix.py
diff --git a/.../source/plot_image_segment_performance.py → ...ormance/plot_image_segment_performance.py b/.../source/plot_image_segment_performance.py → ...ormance/plot_image_segment_performance.py
diff --git a/...rce/plot_mean_average_precision_report.py → ...nce/plot_mean_average_precision_report.py b/...rce/plot_mean_average_precision_report.py → ...nce/plot_mean_average_precision_report.py
diff --git a/...source/plot_mean_average_recall_report.py → ...rmance/plot_mean_average_recall_report.py b/...source/plot_mean_average_recall_report.py → ...rmance/plot_mean_average_recall_report.py
diff --git a/...mance/source/plot_model_error_analysis.py → .../performance/plot_model_error_analysis.py b/...mance/source/plot_model_error_analysis.py → .../performance/plot_model_error_analysis.py
diff --git a/...formance/source/plot_robustness_report.py → ...ion/performance/plot_robustness_report.py b/...formance/source/plot_robustness_report.py → ...ion/performance/plot_robustness_report.py
diff --git a/...ce/source/plot_simple_model_comparison.py → ...rformance/plot_simple_model_comparison.py b/...ce/source/plot_simple_model_comparison.py → ...rformance/plot_simple_model_comparison.py
@@ -34,7 +34,7 @@ class has equal probability.
 ================  ===================================
 
 Similiar to the :doc:`tabular simple model comparison check
-</examples/tabular/checks/performance/examples/plot_simple_model_comparison>`,
+</checks_gallery/tabular/performance/plot_simple_model_comparison>`,
 there is no simple model which is more "correct" to use, each gives a different baseline
 to compare to, and you may experiment with the different types and see how it performs
 on your data.

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -85,16 +85,16 @@
 ]
 
 redirects = {
-    "examples/guides/quickstart_in_5_minutes": "../../tutorials/tabular/examples/plot_quickstart_in_5_minutes.html",
+    "examples/guides/quickstart_in_5_minutes": "../../auto_tutorials/tabular/plot_quickstart_in_5_minutes.html",
     "user-guide/key_concepts": "../user-guide/general/deepchecks_hierarchy.html",
     "user-guide/when_should_you_use": "../getting-started/when_should_you_use.html",
-    "examples/checks/distribution/index": "../../../examples/tabular/checks/distribution/examples/index.html",
-    "examples/checks/distribution/train_test_feature_drift": "../../../examples/tabular/checks/distribution/examples/plot_train_test_feature_drift.html",
-    "examples/checks/integrity/index": "../../../examples/tabular/checks/integrity/examples/index.html",
-    "examples/checks/methodology/index": "../../../examples/tabular/checks/methodology/examples/index.html",
-    "examples/checks/overview/index": "../../../examples/tabular/checks/overview/examples/index.html",
-    "examples/checks/performance/index": "../../../examples/tabular/checks/performance/examples/index.html",
-    "user-guide/supported_models": "..//user-guide/tabular/supported_models.html",
+    "examples/checks/distribution/index": "../../../checks_gallery/tabular/index.html",
+    "examples/checks/distribution/train_test_feature_drift": "../../../checks_gallery/tabular/distribution/plot_train_test_feature_drift.html",
+    "examples/checks/integrity/index": "../../../checks_gallery/tabular/index.html",
+    "examples/checks/methodology/index": "../../../checks_gallery/tabular/index.html",
+    "examples/checks/overview/index": "../../../checks_gallery/tabular/index.html",
+    "examples/checks/performance/index": "../../../checks_gallery/tabular/index.html",
+    "user-guide/supported_models": "../user-guide/tabular/supported_models.html",
     "examples/guides/create_a_custom_suite": "../../user-guide/general/customizations/examples/plot_create_a_custom_suite.html",
     "examples/guides/export_outputs_to_wandb": "../../user-guide/general/exporting_results/examples/plot_exports_output_to_wandb.html",
     "examples/guides/save_suite_result_as_html": "../../user-guide/general/exporting_results/examples/plot_save_suite_results_as_html.html",
@@ -103,36 +103,20 @@
 
 sphinx_gallery_conf = {
     "examples_dirs": [
-        "examples/vision/checks/distribution/source",
-        "examples/vision/checks/performance/source",
-        "examples/vision/checks/methodology/source",
-        # "examples/tabular/guides/source",
-        "examples/tabular/checks/distribution/source",
-        "examples/tabular/checks/overview/source",
-        "examples/tabular/checks/integrity/source",
-        "examples/tabular/checks/methodology/source",
-        "examples/tabular/checks/performance/source",
+        "checks/vision",
+        "checks/tabular",
         "tutorials/tabular",
         "tutorials/vision",
         "user-guide/general/customizations",
         "user-guide/general/exporting_results",
-        # "examples/tabular/use-cases/source",
     ],  # path to your example scripts
     "gallery_dirs": [
-        "examples/vision/checks/distribution/examples",
-        "examples/vision/checks/performance/examples",
-        "examples/vision/checks/methodology/examples",
-        # "examples/tabular/guides/examples",
-        "examples/tabular/checks/distribution/examples",
-        "examples/tabular/checks/overview/examples",
-        "examples/tabular/checks/integrity/examples",
-        "examples/tabular/checks/methodology/examples",
-        "examples/tabular/checks/performance/examples",
-        "tutorials/tabular/examples",
-        "tutorials/vision/examples",
+        "checks_gallery/vision",
+        "checks_gallery/tabular",
+        "auto_tutorials/tabular",
+        "auto_tutorials/vision",
         "user-guide/general/customizations/examples",
         "user-guide/general/exporting_results/examples",
-        # "examples/tabular/use-cases/examples",
     ], # path to where to save gallery generated output
     "image_scrapers": (
         "matplotlib",
@@ -141,6 +125,12 @@
     "pypandoc": True,
     "default_thumb_file": os.path.join(os.path.dirname(os.path.abspath(__file__)),
                                        "_static/sphx_glr_deepchecks_icon.png"),
+    "doc_module": "deepchecks",
+    "backreferences_dir": os.path.join(PROJECT_DIR, "docs/source/api/generated/backreferences"),
+    "reference_url": {'deepchecks': None},
+    # avoid generating too many cross links
+    "inspect_global_variables": True,
+    "remove_config_comments": True,
 }
 
 # Add any paths that contain templates here, relative to this directory.
@@ -191,6 +181,7 @@
 #
 # autosummary_generate = False
 
+
 # If true, autosummary overwrites existing files by generated stub pages.
 # Defaults to true (enabled).
 #
@@ -209,12 +200,15 @@
 # A dictionary of values to pass into the template engine’s context
 # for autosummary stubs files.
 
+
 def path_exists(path: str):
     return os.path.exists(path)
 
+
 def getswd(pth: str):
     return os.getcwd()
 
+
 autosummary_context = {
     'to_snake_case': to_snake_case, 
     'path_exists': path_exists, 
@@ -440,10 +434,10 @@ def linkcode_resolve(domain, info):
 
 def get_check_example_api_reference(filepath: str) -> t.Optional[str]:
     if not (
-        filepath.startswith("docs/source/examples/tabular/checks/")
-        or filepath.startswith("docs/source/examples/vision/checks/")
-        or filepath.startswith("examples/tabular/checks/")
-        or filepath.startswith("examples/vision/checks/")
+        filepath.startswith("docs/source/checks/tabular/")
+        or filepath.startswith("docs/source/checks/vision/")
+        or filepath.startswith("checks/tabular/")
+        or filepath.startswith("checks/vision/")
     ):
         return ''
 

diff --git a/docs/source/distribution/index.rst b/docs/source/distribution/index.rst