docs update, reformatting

basf · May 27, 2024 · 31a6369 · 31a6369
1 parent dc2bed1
commit 31a6369
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 7 deletions.
diff --git a/docs/api/base_models/BaseModels.rst b/docs/api/base_models/BaseModels.rst
@@ -5,18 +5,22 @@ Base Models
     :members:
     :undoc-members:
     :no-inherited-members:
+
 .. autoclass:: mambular.base_models.distributional.BaseMambularLSS
     :members:
     :undoc-members:
     :no-inherited-members:
+
 .. autoclass:: mambular.base_models.embedding_classifier.BaseEmbeddingMambularClassifier
     :members:
     :undoc-members:
     :no-inherited-members:
+
 .. autoclass:: mambular.base_models.embedding_regressor.BaseEmbeddingMambularRegressor
     :members:
     :undoc-members:
     :no-inherited-members:
+
 .. autoclass:: mambular.base_models.regressor.BaseMambularRegressor
     :members:
     :undoc-members:

diff --git a/docs/api/base_models/index.rst b/docs/api/base_models/index.rst
@@ -7,15 +7,15 @@ BaseModels
 
 This module provides base classes for the Mambular models.
 
-=========================================    ===================================================================================================
+=========================================    ======================================================================================================
 Functionality                                Description
-=========================================    ===================================================================================================
+=========================================    ======================================================================================================
 :class:`BaseMambularClassifier`              Multi-class and binary classification tasks.
 :class:`BaseMambularLSS`                     Various statistical distribution families for different types of regression and classification tasks.
 :class:`Base EmbeddingMambularClassifier`    Specialized classification module for complex protein sequence data.
 :class:`BaseEmbeddingMambularRegressor`      Specialized regression module for complex protein sequence data.
 :class:`BaseMambularRegressor`               Regression tasks.
-=========================================    ===================================================================================================
+=========================================    ======================================================================================================
 
 
 .. toctree::

diff --git a/docs/api/models/Models.rst b/docs/api/models/Models.rst
@@ -1,8 +1,17 @@
 Models
-===========
+======
 
 .. autoclass:: mambular.models.sklearn_classifier.MambularClassifier
+    :members:
+
 .. autoclass:: mambular.models.sklearn_distributional.MambularLSS 
+    :members:
+
 .. autoclass:: mambular.models.sklearn_embedding_classifier.EmbeddingMambularClassifier
+    :members:
+
 .. autoclass:: mambular.models.sklearn_embedding_regressor.EmbeddingMambularRegressor
+    :members:
+
 .. autoclass:: mambular.models.sklearn_regressor.MambularRegressor
+    :members:
diff --git a/docs/api/models/index.rst b/docs/api/models/index.rst
@@ -7,15 +7,15 @@ Models
 
 This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.
 
-=======================================    =====================================================================================================
+=======================================    =======================================================================================================
 Functionality                              Description
-=======================================    =====================================================================================================
+=======================================    =======================================================================================================
 :class:`MambularClassifier`                Multi-class and binary classification tasks.
 :class:`MambularLSS`                       Various statistical distribution families for different types of regression and classification tasks.
 :class:`EmbeddingMambularClassifier`       Specialized classification module for complex protein sequence data.
 :class:`EmbeddingMambularRegressor`        Specialized regression module for complex protein sequence data.
 :class:`MambularRegressor`                 Regression tasks.
-=======================================    =====================================================================================================
+=======================================    =======================================================================================================
 
 .. toctree::
    :maxdepth: 1