Modification doc

Gsaes · Gsaes · commit df549841c178 · 2023-06-14T14:27:13.000+02:00
diff --git a/docs/Hole_Generator.rst b/docs/Hole_Generator.rst
@@ -0,0 +1,5 @@
+
+Focus on holes generation
+==========================
+
+Qolmat lets you generate your own holes on your database. All features are available in `benchmark.missing_patterns`. This section will be completed very soon...
diff --git a/docs/_templates/__init__.py b/docs/_templates/__init__.py
diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -0,0 +1,17 @@
+:mod:`{{module}}`.{{objname}}
+{{ underline }}==============
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+
+   {% block methods %}
+   .. automethod:: __init__
+   {% endblock %}
+
+.. include:: {{module}}.{{objname}}.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>
diff --git a/docs/_templates/function.rst b/docs/_templates/function.rst
@@ -0,0 +1,12 @@
+:mod:`{{module}}`.{{objname}}
+{{ underline }}====================
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}
+
+.. include:: {{module}}.{{objname}}.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,22 +1,98 @@
-##########
+###########
 Qolmat API
-##########
+###########
 
 .. currentmodule:: qolmat
 
-Classes
+Imputers
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst    
+    
+    imputations.imputers.ImputerEM
+    imputations.imputers.ImputerKNN
+    imputations.imputers.ImputerInterpolation
+    imputations.imputers.ImputerLOCF
+    imputations.imputers.ImputerMedian
+    imputations.imputers.ImputerMean
+    imputations.imputers.ImputerMICE
+    imputations.imputers.ImputerMode
+    imputations.imputers.ImputerNOCB
+    imputations.imputers.ImputerOracle
+    imputations.imputers.ImputerRegressor
+    imputations.imputers.ImputerResiduals
+    imputations.imputers.ImputerRPCA
+    imputations.imputers.ImputerShuffle
+
+Comparator
+===========
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst    
+    
+    benchmark.comparator.Comparator
+
+Missing Patterns
+================
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst    
+    
+    benchmark.missing_patterns.UniformHoleGenerator
+    benchmark.missing_patterns.GeometricHoleGenerator
+    benchmark.missing_patterns.EmpiricalHoleGenerator
+    benchmark.missing_patterns.MultiMarkovHoleGenerator
+    benchmark.missing_patterns.GroupedHoleGenerator
+
+
+Metrics
 =======
 
 .. autosummary::
     :toctree: generated/
-    :template: class.rst
+    :template: function.rst
+
+    benchmark.metrics.mean_squared_error
+    benchmark.metrics.root_mean_squared_error
+    benchmark.metrics.weighted_mean_absolute_percentage_error
+    benchmark.metrics.wasserstein_distance
+    benchmark.metrics.density_from_rf
+    benchmark.metrics.kl_divergence_1D
+    benchmark.metrics.kl_divergence
+    benchmark.metrics.kolmogorov_smirnov_test
+    benchmark.metrics.total_variance_distance
+    benchmark.metrics.mean_difference_correlation_matrix_numerical_features
+    benchmark.metrics.mean_difference_correlation_matrix_categorical_features
+    benchmark.metrics.mean_difference_correlation_matrix_categorical_vs_numerical_features
+    benchmark.metrics.sum_energy_distances
+    benchmark.metrics.frechet_distance
+
+
+RPCA engine
+================
 
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst    
+    
     imputations.rpca.rpca.RPCA
+    imputations.rpca.rpca_noisy.RPCANoisy
+    imputations.rpca.rpca_pcp.RPCAPCP
+
 
-Utils
-=====
+EM engine
+================
 
 .. autosummary::
     :toctree: generated/
-    :template: function.rst
+    :template: class.rst    
+    
+    imputations.em_sampler.EM
+    imputations.em_sampler.MultiNormalEM
+    imputations.em_sampler.VAR1EM
+
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,7 @@
    explanation
    RPCA
    EM_sampler
+   Hole_Generator
 
 .. toctree::
    :maxdepth: 2 
