Docs and readme fixes (#497)

deepchecks · Jan 5, 2022 · 556c01a · 556c01a
1 parent 9b3b0b8
commit 556c01a
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 11 deletions.
diff --git a/README.rst b/README.rst
@@ -193,7 +193,7 @@ Followed by the visual outputs of all of the checks that are in that
 suite, that isn't appended here for brevity.
 
 For a full suite demonstration, check out the `Quickstart
-Notebook <https://docs.deepchecks.com/en/stable/examples/howto-guides/quickstart_in_5_minutes.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme>`__
+Notebook <https://docs.deepchecks.com/en/stable/docs/source/examples/guides/quickstart_in_5_minutes.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme>`__
 and apply it on your own data and models.
 
 Running a Check

diff --git a/docs/source/api/checks/integrity.rst b/docs/source/api/checks/integrity.rst
@@ -20,7 +20,7 @@ Classes Summary
     is_single_value.IsSingleValue
     label_ambiguity.LabelAmbiguity
     mixed_nulls.MixedNulls
-    mixed_types.MixedDataTypes
+    mixed_data_types.MixedDataTypes
     new_category.CategoryMismatchTrainTest
     new_label.NewLabelTrainTest
     special_chars.SpecialCharacters

diff --git a/docs/source/api/checks/methodology.rst b/docs/source/api/checks/methodology.rst
@@ -22,8 +22,7 @@ Classes Summary
     identifier_leakage.IdentifierLeakage
     index_leakage.IndexTrainTestLeakage
     model_inference_time.ModelInferenceTimeCheck
-    performance_overfit.TrainTestDifferenceOverfit
     single_feature_contribution.SingleFeatureContribution
-    single_feature_contribution_train_validation.SingleFeatureContributionTrainTest
+    single_feature_contribution_train_test.SingleFeatureContributionTrainTest
     train_test_samples_mix.TrainTestSamplesMix
     unused_features.UnusedFeatures
diff --git a/docs/source/api/checks/performance.rst b/docs/source/api/checks/performance.rst
@@ -16,8 +16,8 @@ Classes Summary
     :template: check.rst
 
     calibration_score.CalibrationScore
-    class_performance.ClassPerformance
     confusion_matrix_report.ConfusionMatrixReport
+    model_error_analysis.ModelErrorAnalysis
     performance_report.PerformanceReport
     regression_error_distribution.RegressionErrorDistribution
     regression_systematic_error.RegressionSystematicError

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -376,7 +376,7 @@ def generate_colab_url(notebook_path: str) -> str:
         user=GIT['user'],
         repo=GIT['repo'],
         branch=GIT['release'],
-        notebook_path=notebook_path
+        notebook_path=f"docs/source/{notebook_path}"
     )
 
 
@@ -397,7 +397,7 @@ def generate_binder_url(notebook_path: str) -> str:
         user=GIT['user'],
         repo=GIT['repo'],
         branch=GIT['release'],
-        filepath=f"docs/source/${notebook_path}"
+        filepath=f"docs/source/{notebook_path}"
     )
 
 

diff --git a/...checks/integrity/special_characters.ipynb → ...ples/checks/integrity/special_chars.ipynb b/...checks/integrity/special_characters.ipynb → ...ples/checks/integrity/special_chars.ipynb
diff --git a/...train_validation_leakage_duplicates.ipynb → .../date_train_test_leakage_duplicates.ipynb b/...train_validation_leakage_duplicates.ipynb → .../date_train_test_leakage_duplicates.ipynb
diff --git a/...te_train_validation_leakage_overlap.ipynb → ...ogy/date_train_test_leakage_overlap.ipynb b/...te_train_validation_leakage_overlap.ipynb → ...ogy/date_train_test_leakage_overlap.ipynb
diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -1,22 +1,25 @@
 Examples
 ========
 
+Guides
+~~~~~~
 
 .. toctree::
     :maxdepth: 3
     :titlesonly:
-    :caption: Guides
     :glob:
 
     guides/quickstart_in_5_minutes
     guides/create_a_custom_suite
     guides/add_a_custom_check
     guides/configure_check_conditions
 
+.. _examples-check-demonstrations:
 
+Check Demonstrations
+~~~~~~~~~~~~~~~~~~~~
 .. toctree::
     :maxdepth: 2
-    :caption: Check Demonstrations
     :titlesonly:
 
     checks/distribution/index

diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -59,7 +59,7 @@ Simply run the following command in a notebook cell:
 
 Start Working with the Package!
 =================================
-To get started with deepchecks with 5 lines of code, head to :doc:`examples/howto-guides/quickstart_in_5_minutes`.
+To get started with deepchecks with 5 lines of code, head to :doc:`/examples/guides/quickstart_in_5_minutes`.
 
 For additional usage examples and for understanding the best practices of how to use the package, stay tuned for our additional
 guides that will be added here with our official launch!
diff --git a/docs/source/user-guide/key_concepts.rst b/docs/source/user-guide/key_concepts.rst
@@ -9,7 +9,7 @@ Check
 
 Each check enables you to inspect a specific aspect of your data and models.
 They are the basic building block of the deepchecks package, covering all kinds of common issues,
-such as: PerformanceOverfit, DataSampleLeakage, SingleFeatureContribution, DataDuplicates, and :ref:`many more checks <examples/checks>`.
+such as: PerformanceOverfit, DataSampleLeakage, SingleFeatureContribution, DataDuplicates, and :ref:`many more checks <examples-check-demonstrations>`.
 Each check can have two types of results:
 
 #. A visual result meant for display (e.g. a figure or a table).