Refactored and updated User Guide doc

Caparrini · Nov 5, 2024 · 8da61a4 · 8da61a4
1 parent ba2dc67
commit 8da61a4
Show file tree

Hide file tree

Showing 24 changed files with 890 additions and 506 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,6 +51,15 @@
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
+    'scikit-learn': ('https://scikit-learn.org/stable/', None),
+    'mlflow': ('https://www.mlflow.org/docs/latest/', None),
+    'xgboot': ('https://xgboost.readthedocs.io/en/latest/', None),
+    'lightgbm': ('https://lightgbm.readthedocs.io/en/latest/', None),
+    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
+    'matplotlib': ('https://matplotlib.org/stable/', None),
+    'seaborn': ('https://seaborn.pydata.org/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
+    'deap': ('https://deap.readthedocs.io/en/master/', None),
 }
 
 templates_path = ['_templates']

diff --git a/docs/sections/Advanced/index.rst b/docs/sections/Advanced/index.rst
@@ -0,0 +1,23 @@
+Advanced Customization
+======================
+
+The advanced customization options in `mloptimizer` enable fine-tuning of the optimization process, providing flexibility to adapt to different scenarios, computational resources, and evaluation needs. Use these options to define custom scoring metrics, ensure reproducibility, or leverage parallel processing for faster optimization.
+
+.. toctree::
+   :hidden:
+
+   score_functions
+   reproducibility
+   parallel
+
+
+Overview of Customization Options
+---------------------------------
+
+- **Custom Score Functions**: Define custom scoring metrics tailored to your specific objectives. This flexibility allows you to optimize models based on metrics beyond standard evaluation scores, aligning with unique project requirements.
+
+- **Reproducibility**: Ensure consistent results by setting seeds and managing randomization across optimization runs. Reproducibility is essential for benchmarking and validating models in research and production environments.
+
+- **Parallel Processing**: Accelerate optimization by distributing computations across multiple cores. Parallel processing can significantly reduce runtime, especially for complex models or extensive hyperparameter spaces.
+
+Each section provides detailed guidance on implementing these advanced options.
diff --git a/docs/sections/Concepts/parallel.rst → docs/sections/Advanced/parallel.rst b/docs/sections/Concepts/parallel.rst → docs/sections/Advanced/parallel.rst
diff --git a/docs/sections/Concepts/reproducibility.rst → docs/sections/Advanced/reproducibility.rst b/docs/sections/Concepts/reproducibility.rst → docs/sections/Advanced/reproducibility.rst
diff --git a/docs/sections/Concepts/score_functions.rst → docs/sections/Advanced/score_functions.rst b/docs/sections/Concepts/score_functions.rst → docs/sections/Advanced/score_functions.rst
diff --git a/docs/sections/Basics/directory_structure.rst b/docs/sections/Basics/directory_structure.rst
diff --git a/docs/sections/Basics/index.rst b/docs/sections/Basics/index.rst
diff --git a/docs/sections/Basics/overview.rst b/docs/sections/Basics/overview.rst