From 31a6369da6923898cd8c5d91145e553fbcc54ed9 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Mon, 27 May 2024 14:59:57 +0200 Subject: [PATCH] docs update, reformatting --- docs/api/base_models/BaseModels.rst | 4 ++++ docs/api/base_models/index.rst | 6 +++--- docs/api/models/Models.rst | 11 ++++++++++- docs/api/models/index.rst | 6 +++--- 4 files changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/api/base_models/BaseModels.rst b/docs/api/base_models/BaseModels.rst index 9d20f8b..e60e86a 100644 --- 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 index 3aae198..521e33c 100644 --- 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 index 017a589..c167404 100644 --- 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 index a02df09..a718277 100644 --- 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