documentation update

basf · May 27, 2024 · 191e653 · 191e653
1 parent 670e8db
commit 191e653
Show file tree

Hide file tree

Showing 30 changed files with 70 additions and 76 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/mamba.doctree b/docs/_build/doctrees/mamba.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 35dc572e0d396c0b6127e5d298d06ab7
+config: 38dceb4103052422cce4c9687ea3bb47
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>Overview: module code &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">mamba-tabular</a>
+          <a href="../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/base_models/classifier.html b/docs/_build/html/_modules/mambular/base_models/classifier.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.base_models.classifier &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.base_models.classifier &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/base_models/distributional.html b/docs/_build/html/_modules/mambular/base_models/distributional.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.base_models.distributional &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.base_models.distributional &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/base_models/embedding_classifier.html b/docs/_build/html/_modules/mambular/base_models/embedding_classifier.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.base_models.embedding_classifier &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.base_models.embedding_classifier &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/base_models/embedding_regressor.html b/docs/_build/html/_modules/mambular/base_models/embedding_regressor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.base_models.embedding_regressor &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.base_models.embedding_regressor &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/base_models/regressor.html b/docs/_build/html/_modules/mambular/base_models/regressor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.base_models.regressor &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.base_models.regressor &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/models/sklearn_classifier.html b/docs/_build/html/_modules/mambular/models/sklearn_classifier.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.models.sklearn_classifier &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.models.sklearn_classifier &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/models/sklearn_distributional.html b/docs/_build/html/_modules/mambular/models/sklearn_distributional.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.models.sklearn_distributional &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.models.sklearn_distributional &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/models/sklearn_embedding_classifier.html b/docs/_build/html/_modules/mambular/models/sklearn_embedding_classifier.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.models.sklearn_embedding_classifier &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.models.sklearn_embedding_classifier &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/models/sklearn_embedding_regressor.html b/docs/_build/html/_modules/mambular/models/sklearn_embedding_regressor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.models.sklearn_embedding_regressor &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.models.sklearn_embedding_regressor &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_modules/mambular/models/sklearn_regressor.html b/docs/_build/html/_modules/mambular/models/sklearn_regressor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>mambular.models.sklearn_regressor &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>mambular.models.sklearn_regressor &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
@@ -41,7 +41,7 @@
 
 
           <a href="../../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -69,7 +69,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">mamba-tabular</a>
+          <a href="../../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/_sources/mamba.md.txt b/docs/_build/html/_sources/mamba.md.txt
@@ -2,8 +2,6 @@
 
 Mambular is a Python package that brings the power of Mamba architectures to tabular data, offering a suite of deep learning models for regression, classification, and distributional regression tasks. Designed with ease of use in mind, Mambular models adhere to scikit-learn's `BaseEstimator` interface, making them highly compatible with the familiar scikit-learn ecosystem. This means you can fit, predict, and transform using Mambular models just as you would with any traditional scikit-learn model, but with the added performance and flexibility of deep learning.
 
-<img src="https://github.com/basf/mamba-tabular/blob/documentation/Mamba_Tabular_Converted.jpg" alt="Mamba Tabular" width="400"/>
-
 ## Features
 
 - **Comprehensive Model Suite**: Includes modules for regression (`MambularRegressor`), classification (`MambularClassifier`), and distributional regression (`MambularLSS`), catering to a wide range of tabular data tasks.

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '06.05.2024',
+    VERSION: '26.05.2024',
     LANGUAGE: 'english',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/api/base_models/BaseModels.html b/docs/_build/html/api/base_models/BaseModels.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Base Models &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>Base Models &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
@@ -43,7 +43,7 @@
 
 
           <a href="../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -159,7 +159,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">mamba-tabular</a>
+          <a href="../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">

diff --git a/docs/_build/html/api/base_models/index.html b/docs/_build/html/api/base_models/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>BaseModels &mdash; mamba-tabular 06.05.2024 documentation</title>
+  <title>BaseModels &mdash; mambular 26.05.2024 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
@@ -44,7 +44,7 @@
 
 
           <a href="../../index.html" class="icon icon-home">
-            mamba-tabular
+            mambular
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -75,7 +75,7 @@
 
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">mamba-tabular</a>
+          <a href="../../index.html">mambular</a>
       </nav>
 
       <div class="wy-nav-content">