Skip to content

Commit 46df5e7

Browse files
AnFreThAnFreTh
authored
Merge pull request #174 from basf/doc-fix
Doc fix - version bump
2 parents 0a829f6 + 269019f commit 46df5e7

File tree

10 files changed

+589
-143
lines changed

10 files changed

+589
-143
lines changed

‎docs/api/base_models/BaseModels.rst

+20
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,23 @@ mambular.base_models
2828
.. autoclass:: mambular.base_models.TabTransformer
2929
:members:
3030
:no-inherited-members:
31+
32+
.. autoclass:: mambular.base_models.TabulaRNN
33+
:members:
34+
:no-inherited-members:
35+
36+
.. autoclass:: mambular.base_models.MambAttention
37+
:members:
38+
:no-inherited-members:
39+
40+
.. autoclass:: mambular.base_models.TabM
41+
:members:
42+
:no-inherited-members:
43+
44+
.. autoclass:: mambular.base_models.NODE
45+
:members:
46+
:no-inherited-members:
47+
48+
.. autoclass:: mambular.base_models.NDTF
49+
:members:
50+
:no-inherited-members:

‎docs/api/base_models/index.rst

+13-11
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,27 @@
55
BaseModels
66
==========
77

8-
This module provides base classes for the Mambular models.
8+
This module provides foundational classes and architectures for Mambular models, including various neural network architectures tailored for tabular data.
99

1010
========================================= =======================================================================================================
1111
Modules Description
1212
========================================= =======================================================================================================
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
13+
:class:`BaseModel` Abstract base class defining the core structure and initialization logic for Mambular models.
14+
:class:`TaskModel` PyTorch Lightning module for managing model training, validation, and testing workflows.
15+
:class:`Mambular` Flexible neural network model leveraging the Mamba architecture with configurable normalization techniques for tabular data.
16+
:class:`MLP` Multi-layer perceptron (MLP) model designed for tabular tasks, initialized with a custom configuration.
17+
:class:`ResNet` Deep residual network (ResNet) model optimized for structured/tabular datasets.
18+
:class:`FTTransformer` Feature Tokenizer (FTTransformer) model for tabular tasks, incorporating advanced embedding and normalization techniques.
19+
:class:`TabTransformer` TabTransformer model leveraging attention mechanisms for tabular data processing.
20+
:class:`NODE` Neural Oblivious Decision Ensembles (NODE) for tabular tasks, combining decision tree logic with deep learning.
21+
:class:`TabM` TabM architecture designed for tabular data, implementing batch-ensembling MLP techniques.
22+
:class:`NDTF` Neural Decision Tree Forest (NDTF) model for tabular tasks, blending decision tree concepts with neural networks.
23+
:class:`TabulaRNN` Recurrent neural network (RNN) model, including LSTM and GRU architectures, tailored for sequential or time-series tabular data.
24+
:class:`MambAttention` Attention-based architecture for tabular tasks, combining feature importance weighting with advanced normalization techniques.
2025
========================================= =======================================================================================================
2126

2227

2328
.. toctree::
2429
:maxdepth: 1
2530

2631
BaseModels
27-
28-
29-

‎docs/api/configs/Configurations.rst

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Configurations
2+
===============
3+
4+
.. autoclass:: mambular.configs.DefaultMambularConfig
5+
:members:
6+
:undoc-members:
7+
8+
.. autoclass:: mambular.configs.DefaultFTTransformerConfig
9+
:members:
10+
:undoc-members:
11+
12+
.. autoclass:: mambular.configs.DefaultResNetConfig
13+
:members:
14+
:undoc-members:
15+
16+
.. autoclass:: mambular.configs.DefaultMLPConfig
17+
:members:
18+
:undoc-members:
19+
20+
.. autoclass:: mambular.configs.DefaultTabTransformerConfig
21+
:members:
22+
:undoc-members:
23+
24+
.. autoclass:: mambular.configs.DefaultMambaTabConfig
25+
:members:
26+
:undoc-members:
27+
28+
.. autoclass:: mambular.configs.DefaultTabulaRNNConfig
29+
:members:
30+
:undoc-members:
31+
32+
.. autoclass:: mambular.configs.DefaultMambAttentionConfig
33+
:members:
34+
:undoc-members:
35+
36+
.. autoclass:: mambular.configs.DefaultNDTFConfig
37+
:members:
38+
:undoc-members:
39+
40+
.. autoclass:: mambular.configs.DefaultNODEConfig
41+
:members:
42+
:undoc-members:
43+
44+
.. autoclass:: mambular.configs.DefaultTabMConfig
45+
:members:
46+
:undoc-members:

‎docs/api/configs/index.rst

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
.. -*- mode: rst -*-
2+
3+
.. currentmodule:: mambular.configs
4+
5+
Configurations
6+
==============
7+
8+
This module provides default configurations for Mambular models. Each configuration is implemented as a dataclass, offering a structured way to define model-specific hyperparameters.
9+
10+
Mambular
11+
--------
12+
======================================= =======================================================================================================
13+
Dataclass Description
14+
======================================= =======================================================================================================
15+
:class:`DefaultMambularConfig` Default configuration for the Mambular model.
16+
======================================= =======================================================================================================
17+
18+
FTTransformer
19+
-------------
20+
======================================= =======================================================================================================
21+
Dataclass Description
22+
======================================= =======================================================================================================
23+
:class:`DefaultFTTransformerConfig` Default configuration for the FTTransformer model.
24+
======================================= =======================================================================================================
25+
26+
ResNet
27+
------
28+
======================================= =======================================================================================================
29+
Dataclass Description
30+
======================================= =======================================================================================================
31+
:class:`DefaultResNetConfig` Default configuration for the ResNet model.
32+
======================================= =======================================================================================================
33+
34+
MLP
35+
---
36+
======================================= =======================================================================================================
37+
Dataclass Description
38+
======================================= =======================================================================================================
39+
:class:`DefaultMLPConfig` Default configuration for the MLP model.
40+
======================================= =======================================================================================================
41+
42+
TabTransformer
43+
--------------
44+
======================================= =======================================================================================================
45+
Dataclass Description
46+
======================================= =======================================================================================================
47+
:class:`DefaultTabTransformerConfig` Default configuration for the TabTransformer model.
48+
======================================= =======================================================================================================
49+
50+
MambaTab
51+
--------
52+
======================================= =======================================================================================================
53+
Dataclass Description
54+
======================================= =======================================================================================================
55+
:class:`DefaultMambaTabConfig` Default configuration for the MambaTab model.
56+
======================================= =======================================================================================================
57+
58+
RNN
59+
---
60+
======================================= =======================================================================================================
61+
Dataclass Description
62+
======================================= =======================================================================================================
63+
:class:`DefaultTabulaRNNConfig` Default configuration for RNN models (LSTM, GRU).
64+
======================================= =======================================================================================================
65+
66+
MambAttention
67+
-------------
68+
======================================= =======================================================================================================
69+
Dataclass Description
70+
======================================= =======================================================================================================
71+
:class:`DefaultMambAttentionConfig` Default configuration for the MambAttention model.
72+
======================================= =======================================================================================================
73+
74+
NDTF
75+
----
76+
======================================= =======================================================================================================
77+
Dataclass Description
78+
======================================= =======================================================================================================
79+
:class:`DefaultNDTFConfig` Default configuration for the Neural Decision Tree Forest (NDTF) model.
80+
======================================= =======================================================================================================
81+
82+
NODE
83+
----
84+
======================================= =======================================================================================================
85+
Dataclass Description
86+
======================================= =======================================================================================================
87+
:class:`DefaultNODEConfig` Default configuration for the Neural Oblivious Decision Ensembles (NODE) model.
88+
======================================= =======================================================================================================
89+
90+
TabM
91+
----
92+
======================================= =======================================================================================================
93+
Dataclass Description
94+
======================================= =======================================================================================================
95+
:class:`DefaultTabMConfig` Default configuration for the TabM model (Batch-Ensembling MLP).
96+
======================================= =======================================================================================================
97+
98+
.. toctree::
99+
:maxdepth: 1
100+
101+
Configurations

‎docs/api/models/Models.rst

+48
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ mambular.models
7373
:members:
7474
:undoc-members:
7575

76+
.. autoclass:: mambular.models.MambAttentionClassifier
77+
:members:
78+
:undoc-members:
79+
80+
.. autoclass:: mambular.models.MambAttentionRegressor
81+
:members:
82+
:undoc-members:
83+
84+
.. autoclass:: mambular.models.MambAttentionLSS
85+
:members:
86+
:undoc-members:
87+
7688
.. autoclass:: mambular.models.TabulaRNNClassifier
7789
:members:
7890
:undoc-members:
@@ -85,6 +97,42 @@ mambular.models
8597
:members:
8698
:undoc-members:
8799

100+
.. autoclass:: mambular.models.TabMClassifier
101+
:members:
102+
:inherited-members:
103+
104+
.. autoclass:: mambular.models.TabMRegressor
105+
:members:
106+
:inherited-members:
107+
108+
.. autoclass:: mambular.models.TabMLSS
109+
:members:
110+
:undoc-members:
111+
112+
.. autoclass:: mambular.models.NODEClassifier
113+
:members:
114+
:inherited-members:
115+
116+
.. autoclass:: mambular.models.NODERegressor
117+
:members:
118+
:inherited-members:
119+
120+
.. autoclass:: mambular.models.NODELSS
121+
:members:
122+
:undoc-members:
123+
124+
.. autoclass:: mambular.models.NDTFClassifier
125+
:members:
126+
:inherited-members:
127+
128+
.. autoclass:: mambular.models.NDTFRegressor
129+
:members:
130+
:inherited-members:
131+
132+
.. autoclass:: mambular.models.NDTFLSS
133+
:members:
134+
:undoc-members:
135+
88136
.. autoclass:: mambular.models.SklearnBaseClassifier
89137
:members:
90138
:undoc-members:

0 commit comments

Comments
 (0)