Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@weissecj
weissecj committed May 27, 2024
1 parent 276b350 commit 51c3ada
Show file tree
Hide file tree
Showing 30 changed files with 21 additions and 66 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file renamed docs/_build/doctrees/mamba.doctree → docs/_build/doctrees/mambular.doctree
View file
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/base_models/classifier.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/base_models/distributional.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/base_models/embedding_classifier.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/base_models/embedding_regressor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/base_models/regressor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/models/sklearn_classifier.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/models/sklearn_distributional.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/models/sklearn_embedding_classifier.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/models/sklearn_embedding_regressor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/mambular/models/sklearn_regressor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. mdinclude:: mamba.md
.. mdinclude:: mambular.md

.. toctree::
:name: Getting Started
Expand Down
0 docs/mamba.md → docs/_build/html/_sources/mambular.md.txt
View file
File renamed without changes.
1 change: 0 additions & 1 deletion docs/_build/html/api/base_models/BaseModels.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/api/base_models/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/api/models/Models.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/api/models/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quickstart</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
</ul>
Expand Down
13 changes: 6 additions & 7 deletions docs/_build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Mambular: Tabular Deep Learning with Mamba Architectures" href="mamba.html" />
<link rel="next" title="Installation" href="installation.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -55,7 +55,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
</ul>
Expand Down Expand Up @@ -114,11 +113,11 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
</pre></div>
</div>
</section>
<section id="advanced-preprocessing-for-optimal-performance">
<h2>Advanced Preprocessing for Optimal Performance<a class="headerlink" href="#advanced-preprocessing-for-optimal-performance" title="Permalink to this heading"></a></h2>
<section id="preprocessing">
<h2>Preprocessing<a class="headerlink" href="#preprocessing" title="Permalink to this heading"></a></h2>
<p>Mambular elevates the preprocessing stage of model development, employing a sophisticated suite of techniques to ensure your data is in the best shape for the Mamba architectures. Our preprocessing module is designed to be both powerful and intuitive, offering a range of options to transform your tabular data efficiently.</p>
<section id="intelligent-data-type-detection-and-transformation">
<h3>Intelligent Data Type Detection and Transformation<a class="headerlink" href="#intelligent-data-type-detection-and-transformation" title="Permalink to this heading"></a></h3>
<section id="data-type-detection-and-transformation">
<h3>Data Type Detection and Transformation<a class="headerlink" href="#data-type-detection-and-transformation" title="Permalink to this heading"></a></h3>
<p>Mambular automatically identifies the type of each feature in your dataset, applying the most suitable transformations to numerical and categorical variables. This includes:</p>
<ul class="simple">
<li><p><strong>Ordinal Encoding</strong>: Categorical features are seamlessly transformed into numerical values, preserving their inherent order and making them model-ready.</p></li>
Expand Down Expand Up @@ -236,7 +235,7 @@ <h3>Getting Started with MambularLSS:<a class="headerlink" href="#getting-starte
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="mamba.html" class="btn btn-neutral float-right" title="Mambular: Tabular Deep Learning with Mamba Architectures" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
5 changes: 2 additions & 3 deletions docs/_build/html/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Quickstart" href="quickstart.html" />
<link rel="prev" title="Mambular: Tabular Deep Learning with Mamba Architectures" href="mamba.html" />
<link rel="prev" title="Mambular: Tabular Deep Learning with Mamba Architectures" href="index.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -56,7 +56,6 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="mamba.html">Mambular: Tabular Deep Learning with Mamba Architectures</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
</ul>
Expand Down Expand Up @@ -106,7 +105,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="mamba.html" class="btn btn-neutral float-left" title="Mambular: Tabular Deep Learning with Mamba Architectures" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="index.html" class="btn btn-neutral float-left" title="Mambular: Tabular Deep Learning with Mamba Architectures" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="quickstart.html" class="btn btn-neutral float-right" title="Quickstart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
Loading

0 comments on commit 51c3ada

Please sign in to comment.