Skip to content

Commit

Permalink
Merge pull request #113 from basf/master
Browse files Browse the repository at this point in the history
version 0.2.2
  • Loading branch information
AnFreTh authored Aug 13, 2024
2 parents 94f3d0c + 3068e8f commit 6b4c7ff
Show file tree
Hide file tree
Showing 12 changed files with 679 additions and 357 deletions.
172 changes: 98 additions & 74 deletions docs/api/models/Models.rst
Original file line number Diff line number Diff line change
@@ -1,74 +1,98 @@
mambular.models
===============

.. autoclass:: mambular.models.MambularClassifier
:members:
:inherited-members:

.. autoclass:: mambular.models.MambularRegressor
:members:
:inherited-members:

.. autoclass:: mambular.models.MambularLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseRegressor
:members:
:undoc-members:
mambular.models
===============

.. autoclass:: mambular.models.MambularClassifier
:members:
:inherited-members:

.. autoclass:: mambular.models.MambularRegressor
:members:
:inherited-members:

.. autoclass:: mambular.models.MambularLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.FTTransformerLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.MLPLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.TabTransformerLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.ResNetLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.MambaTabClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.MambaTabRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.MambaTabLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.TabulaRNNClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.TabulaRNNRegressor
:members:
:undoc-members:

.. autoclass:: mambular.models.TabulaRNNLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseClassifier
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseLSS
:members:
:undoc-members:

.. autoclass:: mambular.models.SklearnBaseRegressor
:members:
:undoc-members:
80 changes: 43 additions & 37 deletions docs/api/models/index.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
.. -*- mode: rst -*-
.. currentmodule:: mambular.models

Models
======

This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.

======================================= =======================================================================================================
Modules Description
======================================= =======================================================================================================
:class:`MambularClassifier` Multi-class and binary classification tasks.
:class:`MambularRegressor` Regression tasks.
:class:`MambularLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`FTTransformerClassifier` FT transformer for classification tasks.
:class:`FTTransformerRegressor` FT transformer for regression tasks.
:class:`FTTransformerLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`MLPClassifier` Multi-class and binary classification tasks.
:class:`MLPRegressor` MLP for regression tasks.
:class:`MLPLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`TabTransformerClassifier` TabTransformer for classification tasks.
:class:`TabTransformerRegressor` TabTransformer for regression tasks.
:class:`TabTransformerLSS` TabTransformer for distributional tasks.
:class:`ResNetClassifier` Multi-class and binary classification tasks using ResNet.
:class:`ResNetRegressor` Regression tasks using ResNet.
:class:`ResNetLSS` Distributional tasks using ResNet.
:class:`SklearnBaseClassifier` Base class for classification tasks.
:class:`SklearnBaseLSS` Base class for distributional tasks.
:class:`SklearnBaseRegressor` Base class for regression tasks.
======================================= =======================================================================================================

.. toctree::
:maxdepth: 1

Models

.. -*- mode: rst -*-
.. currentmodule:: mambular.models

Models
======

This module provides classes for the Mambular models that adhere to scikit-learn's `BaseEstimator` interface.

======================================= =======================================================================================================
Modules Description
======================================= =======================================================================================================
:class:`MambularClassifier` Multi-class and binary classification tasks with a sequential Mambular Model.
:class:`MambularRegressor` Regression tasks with a sequential Mambular Model.
:class:`MambularLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`FTTransformerClassifier` FT transformer for classification tasks.
:class:`FTTransformerRegressor` FT transformer for regression tasks.
:class:`FTTransformerLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`MLPClassifier` Multi-class and binary classification tasks.
:class:`MLPRegressor` MLP for regression tasks.
:class:`MLPLSS` Various statistical distribution families for different types of regression and classification tasks.
:class:`TabTransformerClassifier` TabTransformer for classification tasks.
:class:`TabTransformerRegressor` TabTransformer for regression tasks.
:class:`TabTransformerLSS` TabTransformer for distributional tasks.
:class:`ResNetClassifier` Multi-class and binary classification tasks using ResNet.
:class:`ResNetRegressor` Regression tasks using ResNet.
:class:`ResNetLSS` Distributional tasks using ResNet.
:class:`MambaTabClassifier` Multi-class and binary classification tasks using MambaTab.
:class:`MambaTabRegressor` Regression tasks using MambaTab.
:class:`MambaTabLSS` Distributional tasks using MambaTab.
:class:`TabulaRNNClassifier` Multi-class and binary classification tasks using a RNN.
:class:`TabulaRNNRegressor` Regression tasks using a RNN.
:class:`TabulaRNNLSS` Distributional tasks using a RNN.
:class:`SklearnBaseClassifier` Base class for classification tasks.
:class:`SklearnBaseLSS` Base class for distributional tasks.
:class:`SklearnBaseRegressor` Base class for regression tasks.
======================================= =======================================================================================================

.. toctree::
:maxdepth: 1

Models

Loading

0 comments on commit 6b4c7ff

Please sign in to comment.