Skip to content

Commit 00c8f54

Browse files
committed
updating docs
1 parent 1ef78ea commit 00c8f54

3 files changed

Lines changed: 387 additions & 355 deletions

File tree

docs/api/models/Models.rst

Lines changed: 98 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,98 @@
1-
mambular.models
2-
===============
3-
4-
.. autoclass:: mambular.models.MambularClassifier
5-
:members:
6-
:inherited-members:
7-
8-
.. autoclass:: mambular.models.MambularRegressor
9-
:members:
10-
:inherited-members:
11-
12-
.. autoclass:: mambular.models.MambularLSS
13-
:members:
14-
:undoc-members:
15-
16-
.. autoclass:: mambular.models.FTTransformerClassifier
17-
:members:
18-
:undoc-members:
19-
20-
.. autoclass:: mambular.models.FTTransformerRegressor
21-
:members:
22-
:undoc-members:
23-
24-
.. autoclass:: mambular.models.FTTransformerLSS
25-
:members:
26-
:undoc-members:
27-
28-
.. autoclass:: mambular.models.MLPClassifier
29-
:members:
30-
:undoc-members:
31-
32-
.. autoclass:: mambular.models.MLPRegressor
33-
:members:
34-
:undoc-members:
35-
36-
.. autoclass:: mambular.models.MLPLSS
37-
:members:
38-
:undoc-members:
39-
40-
.. autoclass:: mambular.models.TabTransformerClassifier
41-
:members:
42-
:undoc-members:
43-
44-
.. autoclass:: mambular.models.TabTransformerRegressor
45-
:members:
46-
:undoc-members:
47-
48-
.. autoclass:: mambular.models.TabTransformerLSS
49-
:members:
50-
:undoc-members:
51-
52-
.. autoclass:: mambular.models.ResNetClassifier
53-
:members:
54-
:undoc-members:
55-
56-
.. autoclass:: mambular.models.ResNetRegressor
57-
:members:
58-
:undoc-members:
59-
60-
.. autoclass:: mambular.models.ResNetLSS
61-
:members:
62-
:undoc-members:
63-
64-
.. autoclass:: mambular.models.SklearnBaseClassifier
65-
:members:
66-
:undoc-members:
67-
68-
.. autoclass:: mambular.models.SklearnBaseLSS
69-
:members:
70-
:undoc-members:
71-
72-
.. autoclass:: mambular.models.SklearnBaseRegressor
73-
:members:
74-
:undoc-members:
1+
mambular.models
2+
===============
3+
4+
.. autoclass:: mambular.models.MambularClassifier
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: mambular.models.MambularRegressor
9+
:members:
10+
:inherited-members:
11+
12+
.. autoclass:: mambular.models.MambularLSS
13+
:members:
14+
:undoc-members:
15+
16+
.. autoclass:: mambular.models.FTTransformerClassifier
17+
:members:
18+
:undoc-members:
19+
20+
.. autoclass:: mambular.models.FTTransformerRegressor
21+
:members:
22+
:undoc-members:
23+
24+
.. autoclass:: mambular.models.FTTransformerLSS
25+
:members:
26+
:undoc-members:
27+
28+
.. autoclass:: mambular.models.MLPClassifier
29+
:members:
30+
:undoc-members:
31+
32+
.. autoclass:: mambular.models.MLPRegressor
33+
:members:
34+
:undoc-members:
35+
36+
.. autoclass:: mambular.models.MLPLSS
37+
:members:
38+
:undoc-members:
39+
40+
.. autoclass:: mambular.models.TabTransformerClassifier
41+
:members:
42+
:undoc-members:
43+
44+
.. autoclass:: mambular.models.TabTransformerRegressor
45+
:members:
46+
:undoc-members:
47+
48+
.. autoclass:: mambular.models.TabTransformerLSS
49+
:members:
50+
:undoc-members:
51+
52+
.. autoclass:: mambular.models.ResNetClassifier
53+
:members:
54+
:undoc-members:
55+
56+
.. autoclass:: mambular.models.ResNetRegressor
57+
:members:
58+
:undoc-members:
59+
60+
.. autoclass:: mambular.models.ResNetLSS
61+
:members:
62+
:undoc-members:
63+
64+
.. autoclass:: mambular.models.MambaTabClassifier
65+
:members:
66+
:undoc-members:
67+
68+
.. autoclass:: mambular.models.MambaTabRegressor
69+
:members:
70+
:undoc-members:
71+
72+
.. autoclass:: mambular.models.MambaTabLSS
73+
:members:
74+
:undoc-members:
75+
76+
.. autoclass:: mambular.models.TabulaRNNClassifier
77+
:members:
78+
:undoc-members:
79+
80+
.. autoclass:: mambular.models.TabulaRNNRegressor
81+
:members:
82+
:undoc-members:
83+
84+
.. autoclass:: mambular.models.TabulaRNNLSS
85+
:members:
86+
:undoc-members:
87+
88+
.. autoclass:: mambular.models.SklearnBaseClassifier
89+
:members:
90+
:undoc-members:
91+
92+
.. autoclass:: mambular.models.SklearnBaseLSS
93+
:members:
94+
:undoc-members:
95+
96+
.. autoclass:: mambular.models.SklearnBaseRegressor
97+
:members:
98+
:undoc-members:

docs/api/models/index.rst

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
1-
.. -*- mode: rst -*-
2-
3-
.. currentmodule:: mambular.models
4-
5-
Models
6-
======
7-
8-
This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.
9-
10-
======================================= =======================================================================================================
11-
Modules Description
12-
======================================= =======================================================================================================
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.
31-
======================================= =======================================================================================================
32-
33-
.. toctree::
34-
:maxdepth: 1
35-
36-
Models
37-
1+
.. -*- mode: rst -*-
2+
3+
.. currentmodule:: mambular.models
4+
5+
Models
6+
======
7+
8+
This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.
9+
10+
======================================= =======================================================================================================
11+
Modules Description
12+
======================================= =======================================================================================================
13+
:class:`MambularClassifier` Multi-class and binary classification tasks with a sequential Mambular Model.
14+
:class:`MambularRegressor` Regression tasks with a sequential Mambular Model.
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:`MambaTabClassifier` Multi-class and binary classification tasks using MambaTab.
29+
:class:`MambaTabRegressor` Regression tasks using MambaTab.
30+
:class:`MambaTabLSS` Distributional tasks using MambaTab.
31+
:class:`TabulaRNNClassifier` Multi-class and binary classification tasks using a RNN.
32+
:class:`TabulaRNNRegressor` Regression tasks using a RNN.
33+
:class:`TabulaRNNLSS` Distributional tasks using a RNN.
34+
:class:`SklearnBaseClassifier` Base class for classification tasks.
35+
:class:`SklearnBaseLSS` Base class for distributional tasks.
36+
:class:`SklearnBaseRegressor` Base class for regression tasks.
37+
======================================= =======================================================================================================
38+
39+
.. toctree::
40+
:maxdepth: 1
41+
42+
Models
43+

0 commit comments

Comments
 (0)