Fixing colab & notebook links (#309)

* Fixing colab & notebook links * version bump
deepchecks · Dec 22, 2021 · 950de75 · 950de75
1 parent bf8d50a
commit 950de75
Show file tree

Hide file tree

Showing 91 changed files with 56 additions and 58 deletions.
diff --git a/.licenserc_fix.yaml b/.licenserc_fix.yaml
@@ -21,7 +21,7 @@ header:
     - 'VERSION'
     - 'deepchecks.egg-info/PKG-INFO'
     - 'makefile'
-    - 'notebooks/'
+    - 'examples/'
     - 'docs/'
     - 'deepchecks/ppscore.py'
   comment: on-failure

diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ data integrity, distribution mismatches, and more.
 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 [many more checks](./notebooks/checks).
+DataDuplicates, and [many more checks](examples/checks).
 Each check can have two types of results:
 1. A visual result meant for display (e.g. a figure or a table).
 2. A return value that can be used for validating the expected check results
@@ -167,8 +167,8 @@ are in that suite.
 
 ### Example Notebooks
 For usage examples, check out: 
-- [**Quickstart Notebook**](./notebooks/examples/quickstart_in_5_minutes.ipynb) - for running your first suite with a few lines of code.
-- [**Example Checks Output Notebooks**](./notebooks/checks) - to see all of the existing checks and their usage examples.
+- [**Quickstart Notebook**](examples/howto-guides/quickstart_in_5_minutes.ipynb) - for running your first suite with a few lines of code.
+- [**Example Checks Output Notebooks**](examples/checks) - to see all of the existing checks and their usage examples.
 
 ## Communication
 - Join our [Slack Community](https://join.slack.com/t/deepcheckscommunity/shared_invite/zt-y28sjt1v-PBT50S3uoyWui_Deg5L_jg) to connect with the maintainers and follow users and interesting discussions

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.0.14
+0.0.15
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,8 +34,7 @@
 
 GIT = {
     "user": "deepchecks",
-    "repo": "deepchecks",
-    "documentation-path": "docs/source"
+    "repo": "deepchecks"
 }
 
 try:
@@ -367,14 +366,13 @@ def generate_colab_url(notebook_path: str) -> str:
         raise RuntimeError(f"Not a notebook - {notebook_path}")
 
     template = (
-        "https://colab.research.google.com/github/{user}/{repo}/blob/{branch}/{docpath}/{notebook_path}"
+        "https://colab.research.google.com/github/{user}/{repo}/blob/{branch}/{notebook_path}"
     )
 
     return template.format(
         user=GIT['user'],
         repo=GIT['repo'],
         branch=GIT['release'],
-        docpath=GIT['documentation-path'],
         notebook_path=notebook_path
     )
 
@@ -396,13 +394,13 @@ def generate_binder_url(notebook_path: str) -> str:
         user=GIT['user'],
         repo=GIT['repo'],
         branch=GIT['release'],
-        filepath=f"{GIT['documentation-path']}/{notebook_path}"
+        filepath=notebook_path
     )
 
 
 @functools.lru_cache(maxsize=None)
 def get_example_notebooks() -> t.Tuple[pathlib.Path, ...]:
-    examples_folder = PROJECT_DIR / "notebooks"
+    examples_folder = PROJECT_DIR / "examples"
 
     if not examples_folder.exists() or not examples_folder.is_dir():
         raise RuntimeError("Did not find the folder with the example notebooks.")

diff --git a/docs/source/examples/checks/distribution/train_test_feature_drift.nblink b/docs/source/examples/checks/distribution/train_test_feature_drift.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/distribution/train_test_feature_drift.ipynb"
+    "path": "../../../../../examples/checks/distribution/train_test_feature_drift.ipynb"
 }
diff --git a/docs/source/examples/checks/distribution/trust_score_comparison.nblink b/docs/source/examples/checks/distribution/trust_score_comparison.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/distribution/trust_score_comparison.ipynb"
+    "path": "../../../../../examples/checks/distribution/trust_score_comparison.ipynb"
 }
diff --git a/docs/source/examples/checks/distribution/whole_dataset_drift.nblink b/docs/source/examples/checks/distribution/whole_dataset_drift.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/distribution/whole_dataset_drift.ipynb"
+    "path": "../../../../../examples/checks/distribution/whole_dataset_drift.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/data_duplicates.nblink b/docs/source/examples/checks/integrity/data_duplicates.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/data_duplicates.ipynb"
+    "path": "../../../../../examples/checks/integrity/data_duplicates.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/dominant_frequency_change.nblink b/docs/source/examples/checks/integrity/dominant_frequency_change.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/dominant_frequency_change.ipynb"
+    "path": "../../../../../examples/checks/integrity/dominant_frequency_change.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/is_single_value.nblink b/docs/source/examples/checks/integrity/is_single_value.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/is_single_value.ipynb"
+    "path": "../../../../../examples/checks/integrity/is_single_value.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/label_ambiguity.nblink b/docs/source/examples/checks/integrity/label_ambiguity.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/label_ambiguity.ipynb"
+    "path": "../../../../../examples/checks/integrity/label_ambiguity.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/mixed_data_types.nblink b/docs/source/examples/checks/integrity/mixed_data_types.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/mixed_data_types.ipynb"
+    "path": "../../../../../examples/checks/integrity/mixed_data_types.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/mixed_nulls.nblink b/docs/source/examples/checks/integrity/mixed_nulls.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/mixed_nulls.ipynb"
+    "path": "../../../../../examples/checks/integrity/mixed_nulls.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/new_category.nblink b/docs/source/examples/checks/integrity/new_category.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/new_category.ipynb"
+    "path": "../../../../../examples/checks/integrity/new_category.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/new_label.nblink b/docs/source/examples/checks/integrity/new_label.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/new_label.ipynb"
+    "path": "../../../../../examples/checks/integrity/new_label.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/special_characters.nblink b/docs/source/examples/checks/integrity/special_characters.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/special_characters.ipynb"
+    "path": "../../../../../examples/checks/integrity/special_characters.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/string_length_out_of_bounds.nblink b/docs/source/examples/checks/integrity/string_length_out_of_bounds.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/string_length_out_of_bounds.ipynb"
+    "path": "../../../../../examples/checks/integrity/string_length_out_of_bounds.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/string_mismatch.nblink b/docs/source/examples/checks/integrity/string_mismatch.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/string_mismatch.ipynb"
+    "path": "../../../../../examples/checks/integrity/string_mismatch.ipynb"
 }
diff --git a/docs/source/examples/checks/integrity/string_mismatch_comparison.nblink b/docs/source/examples/checks/integrity/string_mismatch_comparison.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/integrity/string_mismatch_comparison.ipynb"
+    "path": "../../../../../examples/checks/integrity/string_mismatch_comparison.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/boosting_overfit.nblink b/docs/source/examples/checks/methodology/boosting_overfit.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/boosting_overfit.ipynb"
+    "path": "../../../../../examples/checks/methodology/boosting_overfit.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/datasets_size_comparison.nblink b/docs/source/examples/checks/methodology/datasets_size_comparison.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/datasets_size_comparison.ipynb"
+    "path": "../../../../../examples/checks/methodology/datasets_size_comparison.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/date_train_validation_leakage_duplicates.nblink b/docs/source/examples/checks/methodology/date_train_validation_leakage_duplicates.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/date_train_validation_leakage_duplicates.ipynb"
+    "path": "../../../../../examples/checks/methodology/date_train_validation_leakage_duplicates.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/date_train_validation_leakage_overlap.nblink b/docs/source/examples/checks/methodology/date_train_validation_leakage_overlap.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/date_train_validation_leakage_overlap.ipynb"
+    "path": "../../../../../examples/checks/methodology/date_train_validation_leakage_overlap.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/identifier_leakage.nblink b/docs/source/examples/checks/methodology/identifier_leakage.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/identifier_leakage.ipynb"
+    "path": "../../../../../examples/checks/methodology/identifier_leakage.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/index_leakage.nblink b/docs/source/examples/checks/methodology/index_leakage.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/index_leakage.ipynb"
+    "path": "../../../../../examples/checks/methodology/index_leakage.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/model_inference_time.nblink b/docs/source/examples/checks/methodology/model_inference_time.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/model_inference_time.ipynb"
+    "path": "../../../../../examples/checks/methodology/model_inference_time.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/performance_overfit.nblink b/docs/source/examples/checks/methodology/performance_overfit.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/performance_overfit.ipynb"
+    "path": "../../../../../examples/checks/methodology/performance_overfit.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/single_feature_contribution.nblink b/docs/source/examples/checks/methodology/single_feature_contribution.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/single_feature_contribution.ipynb"
+    "path": "../../../../../examples/checks/methodology/single_feature_contribution.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/single_feature_contribution_train_test.nblink b/docs/source/examples/checks/methodology/single_feature_contribution_train_test.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/single_feature_contribution_train_test.ipynb"
+    "path": "../../../../../examples/checks/methodology/single_feature_contribution_train_test.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/train_test_samples_mix.nblink b/docs/source/examples/checks/methodology/train_test_samples_mix.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/train_test_samples_mix.ipynb"
+    "path": "../../../../../examples/checks/methodology/train_test_samples_mix.ipynb"
 }
diff --git a/docs/source/examples/checks/methodology/unused_features.nblink b/docs/source/examples/checks/methodology/unused_features.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/methodology/unused_features.ipynb"
+    "path": "../../../../../examples/checks/methodology/unused_features.ipynb"
 }
diff --git a/docs/source/examples/checks/overview/columns_info.nblink b/docs/source/examples/checks/overview/columns_info.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/overview/columns_info.ipynb"
+    "path": "../../../../../examples/checks/overview/columns_info.ipynb"
 }
diff --git a/docs/source/examples/checks/overview/model_info.nblink b/docs/source/examples/checks/overview/model_info.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/overview/model_info.ipynb"
+    "path": "../../../../../examples/checks/overview/model_info.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/calibration_score.nblink b/docs/source/examples/checks/performance/calibration_score.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/calibration_score.ipynb"
+    "path": "../../../../../examples/checks/performance/calibration_score.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/class_performance.nblink b/docs/source/examples/checks/performance/class_performance.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/class_performance.ipynb"
+    "path": "../../../../../examples/checks/performance/class_performance.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/confusion_matrix_report.nblink b/docs/source/examples/checks/performance/confusion_matrix_report.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/confusion_matrix_report.ipynb"
+    "path": "../../../../../examples/checks/performance/confusion_matrix_report.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/performance_report.nblink b/docs/source/examples/checks/performance/performance_report.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/performance_report.ipynb"
+    "path": "../../../../../examples/checks/performance/performance_report.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/regression_error_distribution.nblink b/docs/source/examples/checks/performance/regression_error_distribution.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/regression_error_distribution.ipynb"
+    "path": "../../../../../examples/checks/performance/regression_error_distribution.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/regression_systematic_error.nblink b/docs/source/examples/checks/performance/regression_systematic_error.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/regression_systematic_error.ipynb"
+    "path": "../../../../../examples/checks/performance/regression_systematic_error.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/roc_report.nblink b/docs/source/examples/checks/performance/roc_report.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/roc_report.ipynb"
+    "path": "../../../../../examples/checks/performance/roc_report.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/segment_performance.nblink b/docs/source/examples/checks/performance/segment_performance.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/segment_performance.ipynb"
+    "path": "../../../../../examples/checks/performance/segment_performance.ipynb"
 }
diff --git a/docs/source/examples/checks/performance/simple_model_comparison.nblink b/docs/source/examples/checks/performance/simple_model_comparison.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../../notebooks/checks/performance/simple_model_comparison.ipynb"
+    "path": "../../../../../examples/checks/performance/simple_model_comparison.ipynb"
 }
diff --git a/docs/source/examples/howto-guides/add_a_custom_check.nblink b/docs/source/examples/howto-guides/add_a_custom_check.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../notebooks/examples/add_a_custom_check.ipynb"
+    "path": "../../../../examples/howto-guides/add_a_custom_check.ipynb"
 }
diff --git a/docs/source/examples/howto-guides/configure_check_conditions.nblink b/docs/source/examples/howto-guides/configure_check_conditions.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../notebooks/examples/configure_check_conditions.ipynb"
+    "path": "../../../../examples/howto-guides/configure_check_conditions.ipynb"
 }
diff --git a/docs/source/examples/howto-guides/create_a_custom_suite.nblink b/docs/source/examples/howto-guides/create_a_custom_suite.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../notebooks/examples/create_a_custom_suite.ipynb"
+    "path": "../../../../examples/howto-guides/create_a_custom_suite.ipynb"
 }
diff --git a/docs/source/examples/howto-guides/quickstart_in_5_minutes.nblink b/docs/source/examples/howto-guides/quickstart_in_5_minutes.nblink
@@ -1,3 +1,3 @@
 {
-    "path": "../../../../notebooks/examples/quickstart_in_5_minutes.ipynb"
+    "path": "../../../../examples/howto-guides/quickstart_in_5_minutes.ipynb"
 }
diff --git a/notebooks/.nbval-sanitizer → examples/.nbval-sanitizer b/notebooks/.nbval-sanitizer → examples/.nbval-sanitizer
diff --git a/notebooks/checks/README.md → examples/checks/README.md b/notebooks/checks/README.md → examples/checks/README.md
diff --git a/...stribution/train_test_feature_drift.ipynb → ...stribution/train_test_feature_drift.ipynb b/...stribution/train_test_feature_drift.ipynb → ...stribution/train_test_feature_drift.ipynb
diff --git a/...distribution/trust_score_comparison.ipynb → ...distribution/trust_score_comparison.ipynb b/...distribution/trust_score_comparison.ipynb → ...distribution/trust_score_comparison.ipynb
diff --git a/...ks/distribution/whole_dataset_drift.ipynb → ...ks/distribution/whole_dataset_drift.ipynb b/...ks/distribution/whole_dataset_drift.ipynb → ...ks/distribution/whole_dataset_drift.ipynb
diff --git a/...ks/checks/integrity/data_duplicates.ipynb → ...es/checks/integrity/data_duplicates.ipynb b/...ks/checks/integrity/data_duplicates.ipynb → ...es/checks/integrity/data_duplicates.ipynb
diff --git a/...integrity/dominant_frequency_change.ipynb → ...integrity/dominant_frequency_change.ipynb b/...integrity/dominant_frequency_change.ipynb → ...integrity/dominant_frequency_change.ipynb
diff --git a/...ks/checks/integrity/is_single_value.ipynb → ...es/checks/integrity/is_single_value.ipynb b/...ks/checks/integrity/is_single_value.ipynb → ...es/checks/integrity/is_single_value.ipynb
diff --git a/...ks/checks/integrity/label_ambiguity.ipynb → ...es/checks/integrity/label_ambiguity.ipynb b/...ks/checks/integrity/label_ambiguity.ipynb → ...es/checks/integrity/label_ambiguity.ipynb
diff --git a/...s/checks/integrity/mixed_data_types.ipynb → ...s/checks/integrity/mixed_data_types.ipynb b/...s/checks/integrity/mixed_data_types.ipynb → ...s/checks/integrity/mixed_data_types.ipynb
diff --git a/notebooks/checks/integrity/mixed_nulls.ipynb → examples/checks/integrity/mixed_nulls.ipynb b/notebooks/checks/integrity/mixed_nulls.ipynb → examples/checks/integrity/mixed_nulls.ipynb
diff --git a/...books/checks/integrity/new_category.ipynb → examples/checks/integrity/new_category.ipynb b/...books/checks/integrity/new_category.ipynb → examples/checks/integrity/new_category.ipynb
diff --git a/notebooks/checks/integrity/new_label.ipynb → examples/checks/integrity/new_label.ipynb b/notebooks/checks/integrity/new_label.ipynb → examples/checks/integrity/new_label.ipynb
diff --git a/...checks/integrity/special_characters.ipynb → ...checks/integrity/special_characters.ipynb b/...checks/integrity/special_characters.ipynb → ...checks/integrity/special_characters.ipynb
diff --git a/...tegrity/string_length_out_of_bounds.ipynb → ...tegrity/string_length_out_of_bounds.ipynb b/...tegrity/string_length_out_of_bounds.ipynb → ...tegrity/string_length_out_of_bounds.ipynb
diff --git a/...ks/checks/integrity/string_mismatch.ipynb → ...es/checks/integrity/string_mismatch.ipynb b/...ks/checks/integrity/string_mismatch.ipynb → ...es/checks/integrity/string_mismatch.ipynb
diff --git a/...ntegrity/string_mismatch_comparison.ipynb → ...ntegrity/string_mismatch_comparison.ipynb b/...ntegrity/string_mismatch_comparison.ipynb → ...ntegrity/string_mismatch_comparison.ipynb
diff --git a/...checks/methodology/boosting_overfit.ipynb → ...checks/methodology/boosting_overfit.ipynb b/...checks/methodology/boosting_overfit.ipynb → ...checks/methodology/boosting_overfit.ipynb
diff --git a/...ethodology/datasets_size_comparison.ipynb → ...ethodology/datasets_size_comparison.ipynb b/...ethodology/datasets_size_comparison.ipynb → ...ethodology/datasets_size_comparison.ipynb
diff --git a/...train_validation_leakage_duplicates.ipynb → ...train_validation_leakage_duplicates.ipynb b/...train_validation_leakage_duplicates.ipynb → ...train_validation_leakage_duplicates.ipynb
diff --git a/...te_train_validation_leakage_overlap.ipynb → ...te_train_validation_leakage_overlap.ipynb b/...te_train_validation_leakage_overlap.ipynb → ...te_train_validation_leakage_overlap.ipynb
diff --git a/...ecks/methodology/identifier_leakage.ipynb → ...ecks/methodology/identifier_leakage.ipynb b/...ecks/methodology/identifier_leakage.ipynb → ...ecks/methodology/identifier_leakage.ipynb
diff --git a/...ks/checks/methodology/index_leakage.ipynb → ...es/checks/methodology/index_leakage.ipynb b/...ks/checks/methodology/index_leakage.ipynb → ...es/checks/methodology/index_leakage.ipynb
diff --git a/...ks/methodology/model_inference_time.ipynb → ...ks/methodology/model_inference_time.ipynb b/...ks/methodology/model_inference_time.ipynb → ...ks/methodology/model_inference_time.ipynb
diff --git a/...cks/methodology/performance_overfit.ipynb → ...cks/methodology/performance_overfit.ipynb b/...cks/methodology/performance_overfit.ipynb → ...cks/methodology/performance_overfit.ipynb
diff --git a/...odology/single_feature_contribution.ipynb → ...odology/single_feature_contribution.ipynb b/...odology/single_feature_contribution.ipynb → ...odology/single_feature_contribution.ipynb
diff --git a/...gle_feature_contribution_train_test.ipynb → ...gle_feature_contribution_train_test.ipynb b/...gle_feature_contribution_train_test.ipynb → ...gle_feature_contribution_train_test.ipynb
diff --git a/.../methodology/train_test_samples_mix.ipynb → .../methodology/train_test_samples_mix.ipynb b/.../methodology/train_test_samples_mix.ipynb → .../methodology/train_test_samples_mix.ipynb
diff --git a/.../checks/methodology/unused_features.ipynb → .../checks/methodology/unused_features.ipynb b/.../checks/methodology/unused_features.ipynb → .../checks/methodology/unused_features.ipynb
diff --git a/notebooks/checks/overview/columns_info.ipynb → examples/checks/overview/columns_info.ipynb b/notebooks/checks/overview/columns_info.ipynb → examples/checks/overview/columns_info.ipynb
diff --git a/notebooks/checks/overview/model_info.ipynb → examples/checks/overview/model_info.ipynb b/notebooks/checks/overview/model_info.ipynb → examples/checks/overview/model_info.ipynb
diff --git a/...hecks/performance/calibration_score.ipynb → ...hecks/performance/calibration_score.ipynb b/...hecks/performance/calibration_score.ipynb → ...hecks/performance/calibration_score.ipynb
diff --git a/...hecks/performance/class_performance.ipynb → ...hecks/performance/class_performance.ipynb b/...hecks/performance/class_performance.ipynb → ...hecks/performance/class_performance.ipynb
diff --git a/...performance/confusion_matrix_report.ipynb → ...performance/confusion_matrix_report.ipynb b/...performance/confusion_matrix_report.ipynb → ...performance/confusion_matrix_report.ipynb
diff --git a/...ecks/performance/performance_report.ipynb → ...ecks/performance/performance_report.ipynb b/...ecks/performance/performance_report.ipynb → ...ecks/performance/performance_report.ipynb
diff --git a/...mance/regression_error_distribution.ipynb → ...mance/regression_error_distribution.ipynb b/...mance/regression_error_distribution.ipynb → ...mance/regression_error_distribution.ipynb
diff --git a/...ormance/regression_systematic_error.ipynb → ...ormance/regression_systematic_error.ipynb b/...ormance/regression_systematic_error.ipynb → ...ormance/regression_systematic_error.ipynb
diff --git a/...books/checks/performance/roc_report.ipynb → examples/checks/performance/roc_report.ipynb b/...books/checks/performance/roc_report.ipynb → examples/checks/performance/roc_report.ipynb
diff --git a/...cks/performance/segment_performance.ipynb → ...cks/performance/segment_performance.ipynb b/...cks/performance/segment_performance.ipynb → ...cks/performance/segment_performance.ipynb
diff --git a/...performance/simple_model_comparison.ipynb → ...performance/simple_model_comparison.ipynb b/...performance/simple_model_comparison.ipynb → ...performance/simple_model_comparison.ipynb
diff --git a/notebooks/examples/add_a_custom_check.ipynb → ...les/howto-guides/add_a_custom_check.ipynb b/notebooks/examples/add_a_custom_check.ipynb → ...les/howto-guides/add_a_custom_check.ipynb
diff --git a/...examples/configure_check_conditions.ipynb → ...o-guides/configure_check_conditions.ipynb b/...examples/configure_check_conditions.ipynb → ...o-guides/configure_check_conditions.ipynb
diff --git a/...ooks/examples/create_a_custom_suite.ipynb → .../howto-guides/create_a_custom_suite.ipynb b/...ooks/examples/create_a_custom_suite.ipynb → .../howto-guides/create_a_custom_suite.ipynb
diff --git a/...ks/examples/quickstart_in_5_minutes.ipynb → ...owto-guides/quickstart_in_5_minutes.ipynb b/...ks/examples/quickstart_in_5_minutes.ipynb → ...owto-guides/quickstart_in_5_minutes.ipynb
diff --git a/makefile b/makefile
@@ -59,9 +59,9 @@ REQUIREMENTS_LOG := .requirements.log
 ANALIZE_PKGS = pylint pydocstyle flake8 flake8-spellcheck flake8-eradicate flake8-rst
 TEST_CODE := tests/
 TEST_RUNNER_PKGS = pytest pytest-cov pyhamcrest nbval
-NOTEBOOK_CHECKS = ./notebooks/checks
-NOTEBOOK_EXAMPLES = ./notebooks/examples/*.ipynb
-NOTEBOOK_SANITIZER_FILE= ./notebooks/.nbval-sanitizer
+NOTEBOOK_CHECKS = ./examples/checks
+NOTEBOOK_EXAMPLES = ./examples/howto-guides/*.ipynb
+NOTEBOOK_SANITIZER_FILE= ./examples/.nbval-sanitizer
 
 PYLINT_LOG = .pylint.log
 
@@ -103,7 +103,7 @@ help:
 	@echo "test -      TEST_RUNNER on '$(TESTDIR)'"
 	@echo "            args=\"<pytest Arguements>\"  optional arguments"
 	@echo "coverage -  Get coverage information, optional 'args' like test\n"
-	@echo "jupyter - Deploy jupyer-notebook using './notebook' directory"
+	@echo "jupyter - Deploy jupyer-notebook using './examples' directory"
 	@echo "					 args=\"<jupyter Arguments\" -passable\n"
 	@echo "tox      -  Test against multiple versions of python as defined in tox.ini"
 	@echo "clean | clean-all -  Clean up | clean up & removing virtualenv"
@@ -308,7 +308,7 @@ download:
 	$(PIP) install $(PROJECT)
 
 jupyter: $(JUPYTER)
-	$(BIN)/jupyter-notebook $(args) --notebook-dir=./notebooks
+	$(BIN)/jupyter-notebook $(args) --notebook-dir=./examples
 
 $(JUPYTER):
 	$(PIP) install jupyter