Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrated HypEx, Updated Tutorials, Improved Docs, and Removed Legacy Code #170

Merged
merged 16 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"seaborn",
"json2html",
"faiss",
"hypex",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -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 = {
Expand Down
43 changes: 41 additions & 2 deletions docs/pages/Tutorials.rst
Original file line number Diff line number Diff line change
@@ -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
14 changes: 3 additions & 11 deletions docs/pages/modules/addons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 6 additions & 0 deletions docs/pages/tutorials/Tutorial_12_AA_Test.nblink
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_12_AA_Test.ipynb",
"extra-media": [
"../../../imgs"
]
}
6 changes: 0 additions & 6 deletions docs/pages/tutorials/Tutorial_12_Matching.nblink

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_13_AA_Test_multigroup_split.ipynb",
"extra-media": [
"../../../imgs"
]
}
6 changes: 6 additions & 0 deletions docs/pages/tutorials/Tutorial_14_AB_Test.nblink
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_14_AB_Test.ipynb",
"extra-media": [
"../../../imgs"
]
}
6 changes: 6 additions & 0 deletions docs/pages/tutorials/Tutorial_15_Matching.nblink
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_15_Matching.ipynb",
"extra-media": [
"../../../imgs"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_16_Matching_without_replacement.ipynb",
"extra-media": [
"../../../imgs"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_17_Modeling_Limit_Distribution.ipynb",
"extra-media": [
"../../../imgs"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"path": "../../../examples/tutorials/Tutorial_18_Test_Limit_Distribution.ipynb",
"extra-media": [
"../../../imgs"
]
}
Loading
Loading