.. -*- 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).
=======================================    =======================================================================================================

SAINT
-----
=======================================    =======================================================================================================
Dataclass                                   Description
=======================================    =======================================================================================================
:class:`DefaultSAINTConfig`                 Default configuration for the SAINT model.
=======================================    =======================================================================================================

.. toctree::
   :maxdepth: 1

   Configurations
