Merge pull request #173 from basf/doc-fix

adjust docs to new version
basf · Dec 4, 2024 · 7dc4d06 · 7dc4d06
2 parents bbc9b36 + 1c18c84
commit 7dc4d06
Show file tree

Hide file tree

Showing 9 changed files with 588 additions and 142 deletions.
diff --git a/docs/api/base_models/BaseModels.rst b/docs/api/base_models/BaseModels.rst
@@ -28,3 +28,23 @@ mambular.base_models
 .. autoclass:: mambular.base_models.TabTransformer
     :members:
     :no-inherited-members:
+
+.. autoclass:: mambular.base_models.TabulaRNN
+    :members:
+    :no-inherited-members:
+
+.. autoclass:: mambular.base_models.MambAttention
+    :members:
+    :no-inherited-members:
+
+.. autoclass:: mambular.base_models.TabM
+    :members:
+    :no-inherited-members:
+
+.. autoclass:: mambular.base_models.NODE
+    :members:
+    :no-inherited-members:
+
+.. autoclass:: mambular.base_models.NDTF
+    :members:
+    :no-inherited-members:
diff --git a/docs/api/base_models/index.rst b/docs/api/base_models/index.rst
@@ -5,25 +5,27 @@
 BaseModels
 ==========
 
-This module provides base classes for the Mambular models.
+This module provides foundational classes and architectures for Mambular models, including various neural network architectures tailored for tabular data.
 
 =========================================    =======================================================================================================
 Modules                                       Description
 =========================================    =======================================================================================================
-:class:`BaseModel`                            Initializes the BaseModel with given hyperparameters
-:class:`TaskModel`                            PyTorch Lightning Module for training and evaluating a model
-:class:`Mambular`                             PyTorch model for tasks utilizing the Mamba architecture and various normalization techniques
-:class:`MLP`                                  Initializes the MLP model with the given configuration
-:class:`ResNet`                               ResNet model for structured data
-:class:`FTTransformer`                        PyTorch model for tasks utilizing the Transformer architecture and various normalization techniques
-:class:`TabTransformer`                       PyTorch model for tasks utilizing the Transformer architecture and various normalization techniques
+:class:`BaseModel`                            Abstract base class defining the core structure and initialization logic for Mambular models.
+:class:`TaskModel`                            PyTorch Lightning module for managing model training, validation, and testing workflows.
+:class:`Mambular`                             Flexible neural network model leveraging the Mamba architecture with configurable normalization techniques for tabular data.
+:class:`MLP`                                  Multi-layer perceptron (MLP) model designed for tabular tasks, initialized with a custom configuration.
+:class:`ResNet`                               Deep residual network (ResNet) model optimized for structured/tabular datasets.
+:class:`FTTransformer`                        Feature Tokenizer (FTTransformer) model for tabular tasks, incorporating advanced embedding and normalization techniques.
+:class:`TabTransformer`                       TabTransformer model leveraging attention mechanisms for tabular data processing.
+:class:`NODE`                                 Neural Oblivious Decision Ensembles (NODE) for tabular tasks, combining decision tree logic with deep learning.
+:class:`TabM`                                 TabM architecture designed for tabular data, implementing batch-ensembling MLP techniques.
+:class:`NDTF`                                 Neural Decision Tree Forest (NDTF) model for tabular tasks, blending decision tree concepts with neural networks.
+:class:`TabulaRNN`                            Recurrent neural network (RNN) model, including LSTM and GRU architectures, tailored for sequential or time-series tabular data.
+:class:`MambAttention`                        Attention-based architecture for tabular tasks, combining feature importance weighting with advanced normalization techniques.
 =========================================    =======================================================================================================
 
 
 .. toctree::
    :maxdepth: 1
 
    BaseModels
-
-
-
diff --git a/docs/api/configs/Configurations.rst b/docs/api/configs/Configurations.rst
@@ -0,0 +1,46 @@
+Configurations
+===============
+
+.. autoclass:: mambular.configs.DefaultMambularConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultFTTransformerConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultResNetConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultMLPConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultTabTransformerConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultMambaTabConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultTabulaRNNConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultMambAttentionConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultNDTFConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultNODEConfig
+   :members:
+   :undoc-members:
+
+.. autoclass:: mambular.configs.DefaultTabMConfig
+   :members:
+   :undoc-members:
diff --git a/docs/api/configs/index.rst b/docs/api/configs/index.rst
@@ -0,0 +1,101 @@
+.. -*- mode: rst -*-
+
+.. currentmodule:: mambular.configs
+
+Configurations
+==============
+
+This module provides default configurations for Mambular models. Each configuration is implemented as a dataclass, offering a structured way to define model-specific hyperparameters.
+
+Mambular
+--------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultMambularConfig`              Default configuration for the Mambular model.
+=======================================    =======================================================================================================
+
+FTTransformer
+-------------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultFTTransformerConfig`         Default configuration for the FTTransformer model.
+=======================================    =======================================================================================================
+
+ResNet
+------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultResNetConfig`                Default configuration for the ResNet model.
+=======================================    =======================================================================================================
+
+MLP
+---
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultMLPConfig`                   Default configuration for the MLP model.
+=======================================    =======================================================================================================
+
+TabTransformer
+--------------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultTabTransformerConfig`        Default configuration for the TabTransformer model.
+=======================================    =======================================================================================================
+
+MambaTab
+--------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultMambaTabConfig`              Default configuration for the MambaTab model.
+=======================================    =======================================================================================================
+
+RNN
+---
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultTabulaRNNConfig`             Default configuration for RNN models (LSTM, GRU).
+=======================================    =======================================================================================================
+
+MambAttention
+-------------
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultMambAttentionConfig`         Default configuration for the MambAttention model.
+=======================================    =======================================================================================================
+
+NDTF
+----
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultNDTFConfig`                  Default configuration for the Neural Decision Tree Forest (NDTF) model.
+=======================================    =======================================================================================================
+
+NODE
+----
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultNODEConfig`                  Default configuration for the Neural Oblivious Decision Ensembles (NODE) model.
+=======================================    =======================================================================================================
+
+TabM
+----
+=======================================    =======================================================================================================
+Dataclass                                   Description
+=======================================    =======================================================================================================
+:class:`DefaultTabMConfig`                  Default configuration for the TabM model (Batch-Ensembling MLP).
+=======================================    =======================================================================================================
+
+.. toctree::
+   :maxdepth: 1
+
+   Configurations
diff --git a/docs/api/models/Models.rst b/docs/api/models/Models.rst
@@ -73,6 +73,18 @@ mambular.models
     :members:
     :undoc-members:
 
+.. autoclass:: mambular.models.MambAttentionClassifier
+    :members:
+    :undoc-members:
+
+.. autoclass:: mambular.models.MambAttentionRegressor
+    :members:
+    :undoc-members:
+
+.. autoclass:: mambular.models.MambAttentionLSS
+    :members:
+    :undoc-members:
+
 .. autoclass:: mambular.models.TabulaRNNClassifier
     :members:
     :undoc-members:
@@ -85,6 +97,42 @@ mambular.models
     :members:
     :undoc-members:
 
+.. autoclass:: mambular.models.TabMClassifier
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.TabMRegressor 
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.TabMLSS
+    :members:
+    :undoc-members:
+
+.. autoclass:: mambular.models.NODEClassifier
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.NODERegressor 
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.NODELSS
+    :members:
+    :undoc-members:
+
+.. autoclass:: mambular.models.NDTFClassifier
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.NDTFRegressor 
+    :members:
+    :inherited-members:
+
+.. autoclass:: mambular.models.NDTFLSS
+    :members:
+    :undoc-members:
+
 .. autoclass:: mambular.models.SklearnBaseClassifier
     :members:
     :undoc-members: