Merge pull request #264 from basf/master

Release v1.5.0

Author: mkumar73

.gitignore

@@ -173,4 +173,4 @@ docs/_build/doctrees/*
 docs/_build/html/*
 
 
-dev/*
+dev/*

README.md

@@ -23,7 +23,7 @@ Mambular is a Python library for tabular deep learning. It includes models that
 
 <h3>⚡ What's New ⚡</h3>
 <ul>
-  <li>New Models: `Tangos`, `AutoInt`, `Trompt`</li>
+  <li>New Models: `Tangos`, `AutoInt`, `Trompt`, `ModernNCA`</li>
   <li>Pretraining optionality for suitable models.</li>
   <li>Individual preprocessing: preprocess each feature differently, use pre-trained models for categorical encoding</li>
   <li>Extract latent representations of tables</li>
@@ -82,6 +82,8 @@ Mambular is a Python package that brings the power of advanced deep learning arc
 | `AutoInt`        | Automatic Feature Interaction Learning via Self-Attentive Neural Networks introduced [here](https://arxiv.org/abs/1810.11921).                      |
 | `Trompt`        | Trompt: Towards a Better Deep Neural Network for Tabular Data introduced [here](https://arxiv.org/abs/2305.18446).                                  |
 | `Tangos`        | Tangos: Regularizing Tabular Neural Networks through Gradient Orthogonalization and Specialization introduced [here](https://openreview.net/pdf?id=n6H86gW8u0d).                                  |
+| `ModernNCA`        | Revisiting Nearest Neighbor for Tabular Data: A Deep Tabular Baseline Two Decades Later introduced [here](https://arxiv.org/abs/2407.03257).                                  |
+| `TabR` | TabR: Tabular Deep Learning Meets Nearest Neighbors in 2023 [here](https://arxiv.org/abs/2307.14338) |
 
 
 
@@ -118,8 +120,11 @@ pip install mamba-ssm
 
 <h2> Preprocessing </h2>
 
-Mambular simplifies data preprocessing with a range of tools designed for easy transformation of tabular data.
-Specify a default method, or a dictionary defining individual preprocessing methods for each feature.
+Mambular uses pretab preprocessing: https://github.com/OpenTabular/PreTab
+
+Hence, datatypes etc. are detected automatically and all preprocessing methods from pretab as well as from Sklearn.preprocessing are available.
+Additionally, you can specify that each feature is preprocessed differently, according to your requirements, by setting the `feature_preprocessing={}`argument during model initialization.
+For an overview over all available methods: [pretab](https://github.com/OpenTabular/PreTab)
 
 <h3> Data Type Detection and Transformation </h3>
 

docs/api/preprocessing/Preprocessor.rst

@@ -31,7 +31,6 @@
 
    api/models/index
    api/base_models/index
-   api/preprocessing/index
    api/data_utils/index
    api/configs/index
 

docs/api/preprocessing/index.rst

@@ -1,11 +1,10 @@
-from . import base_models, data_utils, models, preprocessing, utils
+from . import base_models, data_utils, models, utils
 from .__version__ import __version__
 
 __all__ = [
     "__version__",
     "base_models",
     "data_utils",
     "models",
-    "preprocessing",
     "utils",
 ]

docs/api/utils/Preprocessor.rst

@@ -17,5 +17,5 @@
 
 # The following line *must* be the last in the module, exactly as formatted:
 
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 

docs/index.rst

@@ -125,6 +125,8 @@ def __init__(self, num_feature_info, cat_feature_info, emb_feature_info, config)
         if self.layer_norm_after_embedding:
             self.embedding_norm = nn.LayerNorm(self.d_model)
 
+        self.feature_info = (num_feature_info, cat_feature_info, emb_feature_info)
+
     def forward(self, num_features, cat_features, emb_features):
         """Defines the forward pass of the model.
 
@@ -171,6 +173,8 @@ def forward(self, num_features, cat_features, emb_features):
 
         # Process numerical embeddings based on embedding_type
         if self.embedding_type == "plr":
+            # check pre-processing type compatibility with plr
+            self.check_plr_embedding_compatibility(self.feature_info)
             # For PLR, pass all numerical features together
             if num_features is not None:
                 num_features = torch.stack(num_features, dim=1).squeeze(
@@ -226,6 +230,21 @@ def forward(self, num_features, cat_features, emb_features):
             x = self.embedding_dropout(x)
 
         return x
+    
+    def check_plr_embedding_compatibility(self, feature_info:tuple):
+        # List of incompatible preprocessing terms for PLR embedding
+        incompatible_terms = ['ple', 'one-hot', 'polynomial', 'splines', 'sigmoid', 'rbf']
+        
+        # Iterate through each dictionary in the tuple (data)
+        for sub_dict in feature_info:
+            # Iterate through each feature in the current dictionary
+            for feature, properties in sub_dict.items():
+                preprocessing = properties.get('preprocessing', '')
+                
+                # Check for incompatible terms in the preprocessing string
+                for term in incompatible_terms:
+                    if term in preprocessing:
+                        raise ValueError(f"PLR embedding type doesn't work with the '{term}' pre-processing method.\n")
 
 
 class OneHotEncoding(nn.Module):