Integrated HypEx, Updated Tutorials, Improved Docs, and Removed Legac…

…y Code (#170) hypex separation
sb-ai-lab · Dec 19, 2024 · 3c09457 · 3c09457
1 parent 236f431
commit 3c09457
Show file tree

Hide file tree

Showing 43 changed files with 14,965 additions and 7,687 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -67,6 +67,7 @@
     "seaborn",
     "json2html",
     "faiss",
+    "hypex",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -161,6 +162,7 @@
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     "sklearn": ("https://scikit-learn.org/stable/", None),
     "PIL": ("https://pillow.readthedocs.io/en/stable/", None),
+    "hypex": ("https://hypex.readthedocs.io/en/latest/", None),
 }
 
 autodoc_type_aliases = {

diff --git a/docs/pages/Tutorials.rst b/docs/pages/Tutorials.rst
@@ -1,20 +1,59 @@
 Tutorials
 =========
 
+This section contains tutorials for both **LightAutoML** and **HypEx**, covering a wide range of use cases from basic model training to advanced hypothesis testing.
+
+LightAutoML Tutorials
+---------------------
+
 
 .. toctree::
     :maxdepth: 1
-    :caption: Contents
+    :caption: Core Features
 
     tutorials/Tutorial_1_basics.nblink
     tutorials/Tutorial_2_WhiteBox_AutoWoE.nblink
     tutorials/Tutorial_3_sql_data_source.nblink
     tutorials/Tutorial_4_NLP_Interpretation.nblink
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Advanced Topics
+
     tutorials/Tutorial_5_uplift.nblink
     tutorials/Tutorial_6_custom_pipeline.nblink
     tutorials/Tutorial_7_ICE_and_PDP_interpretation.nblink
     tutorials/Tutorial_8_CV_preset.nblink
     tutorials/Tutorial_9_neural_networks.nblink
     tutorials/Tutorial_10_relational_data_with_star_scheme.nblink
     tutorials/Tutorial_11_time_series.nblink
-    tutorials/Tutorial_12_Matching.nblink
+
+
+HypEx Tutorials
+---------------
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: A/B and A/A Testing
+
+    tutorials/Tutorial_12_AA_Test.nblink
+    tutorials/Tutorial_13_AA_Test_multigroup_split.nblink
+    tutorials/Tutorial_14_AB_Test.nblink
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Matching
+
+    tutorials/Tutorial_15_Matching.nblink
+    tutorials/Tutorial_16_Matching_without_replacement.nblink
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Modeling and Testing Limits
+
+    tutorials/Tutorial_17_Modeling_Limit_Distribution.nblink
+    tutorials/Tutorial_18_Test_Limit_Distribution.nblink
diff --git a/docs/pages/modules/addons.rst b/docs/pages/modules/addons.rst
@@ -21,16 +21,8 @@ Utilization
 HypEx -- Hypothesises and Experiments
 -------------------------------------
 
-.. currentmodule:: lightautoml.addons.hypex
+The official HypEx documentation can be found at:
 
-.. autosummary::
-    :toctree: ./generated
-    :nosignatures:
-    :template: classtemplate.rst
+`HypEx Documentation <https://hypex.readthedocs.io/en/latest/>`_
 
-    ~matcher.Matcher
-    algorithms.faiss_matcher.FaissMatcher
-    algorithms.no_replacement_matching.MatcherNoReplacement
-    selectors.lama_feature_selector.LamaFeatureSelector
-    selectors.outliers_filter.OutliersFilter
-    selectors.spearman_filter.SpearmanFilter
+For a detailed reference, visit the HypEx API documentation.
diff --git a/docs/pages/tutorials/Tutorial_12_AA_Test.nblink b/docs/pages/tutorials/Tutorial_12_AA_Test.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_12_AA_Test.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_12_Matching.nblink b/docs/pages/tutorials/Tutorial_12_Matching.nblink
diff --git a/docs/pages/tutorials/Tutorial_13_AA_Test_multigroup_split.nblink b/docs/pages/tutorials/Tutorial_13_AA_Test_multigroup_split.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_13_AA_Test_multigroup_split.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_14_AB_Test.nblink b/docs/pages/tutorials/Tutorial_14_AB_Test.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_14_AB_Test.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_15_Matching.nblink b/docs/pages/tutorials/Tutorial_15_Matching.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_15_Matching.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_16_Matching_without_replacement.nblink b/docs/pages/tutorials/Tutorial_16_Matching_without_replacement.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_16_Matching_without_replacement.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_17_Modeling_Limit_Distribution.nblink b/docs/pages/tutorials/Tutorial_17_Modeling_Limit_Distribution.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_17_Modeling_Limit_Distribution.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}
diff --git a/docs/pages/tutorials/Tutorial_18_Test_Limit_Distribution.nblink b/docs/pages/tutorials/Tutorial_18_Test_Limit_Distribution.nblink
@@ -0,0 +1,6 @@
+{
+    "path": "../../../examples/tutorials/Tutorial_18_Test_Limit_Distribution.ipynb",
+    "extra-media": [
+        "../../../imgs"
+    ]
+}