Doc improve3 (#46)

* improve doc * read version from package * move notebook and scripts inside docs * massive doc refactoring * doc refactoring continue * ignore all bat from doc * doc refactor * add a stacking notebook * update notebooks * python script to execute_notebooks * downgrade title
societe-generale · Mar 30, 2020 · 96ed8b5 · 96ed8b5
1 parent ba895bb
commit 96ed8b5
Show file tree

Hide file tree

Showing 51 changed files with 104,107 additions and 2,125 deletions.
diff --git a/.gitignore b/.gitignore
@@ -120,6 +120,4 @@ venv.bak/
 pytest_report.html
 pytest_report_not_long.html
 .DS_Store
-/docs/make.bat
-/docs/make_auto.bat
-/docs/make_html.bat
+/docs/*.bat
diff --git a/docs/adding_new_models.rst b/docs/adding_new_models.rst
@@ -13,6 +13,7 @@ A model needs to be added at two different places in order to be fully integrate
 Let's see what's need to be done to include an hypothetic new models::
 
     class ReallyCoolNewTransformer(BaseEstimator, TransformerMixin):
+        """ This is a great new  transformer """
         def __init__(self, super_choice):
             self.super_choice = super_choice
             
@@ -63,7 +64,8 @@ To do that you need to use the @register decorator::
         custom_hyper = {"super_parameters":hp.HyperChoice(("superchoice_a","superchoice_b"))}
 
     
-See _model_register for complete description of register
+See :ref:`model_register` for complete description of register.
+See :ref:`hyper_parameters` for complete description of register.
 
 Remark:
 The registers behaves like singletons so you can modify them in any part of the code.
@@ -74,5 +76,16 @@ If a model is stable and tested enough the new entry can be added to the python
  * 'model_definition.py' : for the simple register
  * ml_machine/ml_machine_registration.py : for the full auto-ml register
 
+(See :ref:`contribution` for detailed about how to contribute to the evolution of the library)
 
 Remark : you don't need to use the wrapper for your model to be incorporated in the framework. However, it is best to do so. That way you can focus on the logic and let the wrapper make your model more generic.
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   model_register
+   hyper_parameters
+
+
diff --git a/docs/aikit.datasets.rst b/docs/aikit.datasets.rst
diff --git a/docs/aikit.datasets.tests.rst b/docs/aikit.datasets.tests.rst
diff --git a/docs/aikit.ml_machine.rst b/docs/aikit.ml_machine.rst
diff --git a/docs/aikit.ml_machine.tests.rst b/docs/aikit.ml_machine.tests.rst
diff --git a/docs/aikit.models.rst b/docs/aikit.models.rst
diff --git a/docs/aikit.rst b/docs/aikit.rst