Skip to content

Commit 3286fda

Browse files
mkumar73mkumar73
committed
doc updated
1 parent f99a0af commit 3286fda

8 files changed

Lines changed: 160 additions & 21 deletions

File tree

‎docs/api/base_models/BaseModels.rst‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
mambular.base_models
22
====================
33

4-
.. autoclass:: mambular.base_models.BaseMambularClassifier
4+
.. autoclass:: mambular.base_models.BaseModel
55
:members:
66
:no-inherited-members:
77

8-
.. autoclass:: mambular.base_models.BaseMambularLSS
8+
.. autoclass:: mambular.base_models.TaskModel
99
:members:
1010
:no-inherited-members:
1111

12-
.. autoclass:: mambular.base_models.BaseEmbeddingMambularClassifier
12+
.. autoclass:: mambular.base_models.Mambular
1313
:members:
1414
:no-inherited-members:
1515

16-
.. autoclass:: mambular.base_models.BaseEmbeddingMambularRegressor
16+
.. autoclass:: mambular.base_models.MLP
1717
:members:
1818
:no-inherited-members:
1919

20-
.. autoclass:: mambular.base_models.BaseMambularRegressor
20+
.. autoclass:: mambular.base_models.ResNet
21+
:members:
22+
:no-inherited-members:
23+
24+
.. autoclass:: mambular.base_models.FTTransformer
25+
:members:
26+
:no-inherited-members:
27+
28+
.. autoclass:: mambular.base_models.TabTransformer
2129
:members:
2230
:no-inherited-members:

‎docs/api/base_models/index.rst‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ This module provides base classes for the Mambular models.
1010
========================================= =======================================================================================================
1111
Modules Description
1212
========================================= =======================================================================================================
13-
:class:`BaseMambularClassifier` Multi-class and binary classification tasks.
14-
:class:`BaseMambularLSS` Various statistical distribution families for different types of regression and classification tasks.
15-
:class:`BaseEmbeddingMambularClassifier` Specialized classification module for complex protein sequence data.
16-
:class:`BaseEmbeddingMambularRegressor` Specialized regression module for complex protein sequence data.
17-
:class:`BaseMambularRegressor` Regression tasks.
13+
:class:`BaseModel` Initializes the BaseModel with given hyperparameters
14+
:class:`TaskModel` PyTorch Lightning Module for training and evaluating a model
15+
:class:`Mambular` PyTorch model for tasks utilizing the Mamba architecture and various normalization techniques
16+
:class:`MLP` Initializes the MLP model with the given configuration
17+
:class:`ResNet` ResNet model for structured data
18+
:class:`FTTransformer` PyTorch model for tasks utilizing the Transformer architecture and various normalization techniques
19+
:class:`TabTransformer` PyTorch model for tasks utilizing the Transformer architecture and various normalization techniques
1820
========================================= =======================================================================================================
1921

2022

‎docs/api/data_utils/Datautils.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
mambular.data_utils
2+
===================
3+
4+
.. autoclass:: mambular.data_utils.MambularDataset
5+
:members:
6+
7+
.. autoclass:: mambular.data_utils.MambularDataModule
8+
:members:

‎docs/api/data_utils/index.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. -*- mode: rst -*-
2+
3+
.. currentmodule:: mambular.data_utils
4+
5+
Data Utils
6+
==========
7+
8+
This module provides class for data preparation input data.
9+
10+
======================================= =======================================================================================================
11+
Modules Description
12+
======================================= =======================================================================================================
13+
:class:`MambularDataset` A class for loading and preprocessing the dataset.
14+
:class:`MambularDataModule` A class for preparing the dataset for training and testing etc.
15+
======================================= =======================================================================================================
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
:hidden:
20+
21+
Datautils

‎docs/api/models/Models.rst‎

Lines changed: 85 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,96 @@ mambular.models
33

44
.. autoclass:: mambular.models.MambularClassifier
55
:members:
6+
:inherited-members:
67

7-
.. autoclass:: mambular.models.MambularLSS
8+
.. autoclass:: mambular.models.MambularRegressor
89
:members:
10+
:inherited-members:
911

10-
.. autoclass:: mambular.models.EmbeddingMambularClassifier
12+
.. autoclass:: mambular.models.MambularLSS
1113
:members:
14+
:undoc-members:
15+
:inherited-members:
16+
:show-inheritance:
1217

13-
.. autoclass:: mambular.models.EmbeddingMambularRegressor
18+
.. autoclass:: mambular.models.FTTransformerClassifier
1419
:members:
20+
:undoc-members:
21+
:inherited-members:
22+
:show-inheritance:
1523

16-
.. autoclass:: mambular.models.MambularRegressor
24+
.. autoclass:: mambular.models.FTTransformerRegressor
1725
:members:
26+
:undoc-members:
27+
:inherited-members:
28+
:show-inheritance:
29+
30+
.. autoclass:: mambular.models.FTTransformerLSS
31+
:members:
32+
:undoc-members:
33+
:inherited-members:
34+
:show-inheritance:
35+
36+
.. autoclass:: mambular.models.MLPClassifier
37+
:members:
38+
:undoc-members:
39+
:inherited-members:
40+
:show-inheritance:
41+
42+
.. autoclass:: mambular.models.MLPRegressor
43+
:members:
44+
:undoc-members:
45+
:inherited-members:
46+
:show-inheritance:
47+
48+
.. autoclass:: mambular.models.MLPLSS
49+
:members:
50+
:undoc-members:
51+
:inherited-members:
52+
:show-inheritance:
53+
54+
.. autoclass:: mambular.models.TabTransformerClassifier
55+
:members:
56+
:undoc-members:
57+
:inherited-members:
58+
:show-inheritance:
59+
60+
.. autoclass:: mambular.models.TabTransformerRegressor
61+
:members:
62+
:undoc-members:
63+
:inherited-members:
64+
65+
.. autoclass:: mambular.models.TabTransformerLSS
66+
:members:
67+
:undoc-members:
68+
:inherited-members:
69+
70+
.. autoclass:: mambular.models.ResNetClassifier
71+
:members:
72+
:undoc-members:
73+
:inherited-members:
74+
75+
.. autoclass:: mambular.models.ResNetRegressor
76+
:members:
77+
:undoc-members:
78+
:inherited-members:
79+
80+
.. autoclass:: mambular.models.ResNetLSS
81+
:members:
82+
:undoc-members:
83+
:inherited-members:
84+
85+
.. autoclass:: mambular.models.SklearnBaseClassifier
86+
:members:
87+
:undoc-members:
88+
:inherited-members:
89+
90+
.. autoclass:: mambular.models.SklearnBaseLSS
91+
:members:
92+
:undoc-members:
93+
:inherited-members:
94+
95+
.. autoclass:: mambular.models.SklearnBaseRegressor
96+
:members:
97+
:undoc-members:
98+
:inherited-members:

‎docs/api/models/index.rst‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,26 @@ Models
88
This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.
99

1010
======================================= =======================================================================================================
11-
Modules Description
11+
Modules Description
1212
======================================= =======================================================================================================
13-
:class:`MambularClassifier` Multi-class and binary classification tasks.
14-
:class:`MambularLSS` Various statistical distribution families for different types of regression and classification tasks.
15-
:class:`EmbeddingMambularClassifier` Specialized classification module for complex protein sequence data.
16-
:class:`EmbeddingMambularRegressor` Specialized regression module for complex protein sequence data.
17-
:class:`MambularRegressor` Regression tasks.
13+
:class:`MambularClassifier` Multi-class and binary classification tasks.
14+
:class:`MambularRegressor` Regression tasks.
15+
:class:`MambularLSS` Various statistical distribution families for different types of regression and classification tasks.
16+
:class:`FTTransformerClassifier` FT transformer for classification tasks.
17+
:class:`FTTransformerRegressor` FT transformer for regression tasks.
18+
:class:`FTTransformerLSS` Various statistical distribution families for different types of regression and classification tasks.
19+
:class:`MLPClassifier` Multi-class and binary classification tasks.
20+
:class:`MLPRegressor` MLP for regression tasks.
21+
:class:`MLPLSS` Various statistical distribution families for different types of regression and classification tasks.
22+
:class:`TabTransformerClassifier` TabTransformer for classification tasks.
23+
:class:`TabTransformerRegressor` TabTransformer for regression tasks.
24+
:class:`TabTransformerLSS` TabTransformer for distributional tasks.
25+
:class:`ResNetClassifier` Multi-class and binary classification tasks using ResNet.
26+
:class:`ResNetRegressor` Regression tasks using ResNet.
27+
:class:`ResNetLSS` Distributional tasks using ResNet.
28+
:class:`SklearnBaseClassifier` Base class for classification tasks.
29+
:class:`SklearnBaseLSS` Base class for distributional tasks.
30+
:class:`SklearnBaseRegressor` Base class for regression tasks.
1831
======================================= =======================================================================================================
1932

2033
.. toctree::

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
api/models/index
3434
api/base_models/index
3535
api/utils/index
36+
api/data_utils/index
3637

3738

3839
.. toctree::

‎docs/installation.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,10 @@ pip install .
1212
Note: Make sure you in the same directory where `setup.py` file resides.
1313

1414
### Installation from PyPi:
15+
The package is available on PyPi. You can install it using the following command:
1516

16-
**Note:**This package is so far not available in PyPi, expected to release soon!
17+
```bash```bash
18+
pip install mambular
19+
```
20+
21+
PyPi link: [mambular](https://pypi.org/project/mambular/)

0 commit comments

Comments
 (0)