1+
2+
3+ <!DOCTYPE html>
4+
5+
6+ < html lang ="en " data-content_root ="" >
7+
8+ < head >
9+ < meta charset ="utf-8 " />
10+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
11+ < title > Overview: module code — mambular</ title >
12+
13+
14+
15+ < script data-cfasync ="false ">
16+ document . documentElement . dataset . mode = localStorage . getItem ( "mode" ) || "" ;
17+ document . documentElement . dataset . theme = localStorage . getItem ( "theme" ) || "light" ;
18+ </ script >
19+
20+ <!-- Loaded before other Sphinx assets -->
21+ < link href ="../_static/styles/theme.css?digest=8d27b9dea8ad943066ae " rel ="stylesheet " />
22+ < link href ="../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae " rel ="stylesheet " />
23+ < link href ="../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae " rel ="stylesheet " />
24+
25+
26+ < link href ="../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae " rel ="stylesheet " />
27+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2 " />
28+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2 " />
29+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2 " />
30+
31+ < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css " />
32+ < link rel ="stylesheet " type ="text/css " href ="../_static/styles/sphinx-book-theme.css " />
33+ < link rel ="stylesheet " type ="text/css " href ="../_static/copybutton.css " />
34+ < link rel ="stylesheet " type ="text/css " href ="../_static/togglebutton.css " />
35+
36+ <!-- Pre-loaded scripts that we'll load fully later -->
37+ < link rel ="preload " as ="script " href ="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae " />
38+ < link rel ="preload " as ="script " href ="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae " />
39+ < script src ="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae "> </ script >
40+
41+ < script src ="../_static/jquery.js "> </ script >
42+ < script src ="../_static/_sphinx_javascript_frameworks_compat.js "> </ script >
43+ < script data-url_root ="../ " id ="documentation_options " src ="../_static/documentation_options.js "> </ script >
44+ < script src ="../_static/doctools.js "> </ script >
45+ < script src ="../_static/sphinx_highlight.js "> </ script >
46+ < script src ="../_static/clipboard.min.js "> </ script >
47+ < script src ="../_static/copybutton.js "> </ script >
48+ < script > let toggleHintShow = 'Click to show' ; </ script >
49+ < script > let toggleHintHide = 'Click to hide' ; </ script >
50+ < script > let toggleOpenOnPrint = 'true' ; </ script >
51+ < script src ="../_static/togglebutton.js "> </ script >
52+ < script src ="../_static/scripts/sphinx-book-theme.js "> </ script >
53+ < script > var togglebuttonSelector = '.toggle, .admonition.dropdown' ; </ script >
54+ < script crossorigin ="anonymous " integrity ="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA= " src ="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js "> </ script >
55+ < script > DOCUMENTATION_OPTIONS . pagename = '_modules/index' ; </ script >
56+ < link rel ="index " title ="Index " href ="../genindex.html " />
57+ < link rel ="search " title ="Search " href ="../search.html " />
58+ < meta name ="viewport " content ="width=device-width, initial-scale=1 "/>
59+ < meta name ="docsearch:language " content ="en "/>
60+ < meta name ="docbuild:last-update " content ="2024-06-03 "/>
61+ </ head >
62+
63+
64+ < body data-bs-spy ="scroll " data-bs-target =".bd-toc-nav " data-offset ="180 " data-bs-root-margin ="0px 0px -60% " data-default-mode ="">
65+
66+
67+
68+ < a id ="pst-skip-link " class ="skip-link " href ="#main-content "> Skip to main content</ a >
69+
70+ < div id ="pst-scroll-pixel-helper "> </ div >
71+
72+ < button type ="button " class ="btn rounded-pill " id ="pst-back-to-top ">
73+ < i class ="fa-solid fa-arrow-up "> </ i >
74+ Back to top
75+ </ button >
76+
77+
78+ < input type ="checkbox "
79+ class ="sidebar-toggle "
80+ name ="__primary "
81+ id ="__primary "/>
82+ < label class ="overlay overlay-primary " for ="__primary "> </ label >
83+
84+ < input type ="checkbox "
85+ class ="sidebar-toggle "
86+ name ="__secondary "
87+ id ="__secondary "/>
88+ < label class ="overlay overlay-secondary " for ="__secondary "> </ label >
89+
90+ < div class ="search-button__wrapper ">
91+ < div class ="search-button__overlay "> </ div >
92+ < div class ="search-button__search-container ">
93+ < form class ="bd-search d-flex align-items-center "
94+ action ="../search.html "
95+ method ="get ">
96+ < i class ="fa-solid fa-magnifying-glass "> </ i >
97+ < input type ="search "
98+ class ="form-control "
99+ name ="q "
100+ id ="search-input "
101+ placeholder ="Search... "
102+ aria-label ="Search... "
103+ autocomplete ="off "
104+ autocorrect ="off "
105+ autocapitalize ="off "
106+ spellcheck ="false "/>
107+ < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd > K</ kbd > </ span >
108+ </ form > </ div >
109+ </ div >
110+
111+ < header class ="bd-header navbar navbar-expand-lg bd-navbar ">
112+ </ header >
113+
114+
115+ < div class ="bd-container ">
116+ < div class ="bd-container__inner bd-page-width ">
117+
118+
119+
120+
121+
122+ < div class ="bd-sidebar-primary bd-sidebar ">
123+
124+
125+
126+ < div class ="sidebar-header-items sidebar-primary__section ">
127+
128+
129+
130+
131+ </ div >
132+
133+ < div class ="sidebar-primary-items__start sidebar-primary__section ">
134+ < div class ="sidebar-primary-item ">
135+
136+
137+
138+ < a class ="navbar-brand logo " href ="../index.html ">
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+ < img src ="../_static/mamba_tabular.jpg " class ="logo__image only-light " alt ="mambular - Home "/>
150+ < script > document . write ( `<img src="../_static/mamba_tabular.jpg" class="logo__image only-dark" alt="mambular - Home"/>` ) ; </ script >
151+
152+
153+ </ a > </ div >
154+ < div class ="sidebar-primary-item ">
155+
156+ < script >
157+ document . write ( `
158+ <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
159+ <i class="fa-solid fa-magnifying-glass"></i>
160+ <span class="search-button__default-text">Search</span>
161+ <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
162+ </button>
163+ ` ) ;
164+ </ script > </ div >
165+ < div class ="sidebar-primary-item "> < nav class ="bd-links bd-docs-nav " aria-label ="Main ">
166+ < div class ="bd-toc-item navbar-nav active ">
167+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> Getting Started</ span > </ p >
168+ < ul class ="nav bd-sidenav ">
169+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../installation.html "> Installation</ a > </ li >
170+ </ ul >
171+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> Examples</ span > </ p >
172+ < ul class ="nav bd-sidenav ">
173+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../examples/classification.html "> Classification</ a > </ li >
174+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../examples/regression.html "> Regression</ a > </ li >
175+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../examples/embedding.html "> Embedding</ a > </ li >
176+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../examples/distributional.html "> Distributional</ a > </ li >
177+ </ ul >
178+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> API Reference</ span > </ p >
179+ < ul class ="nav bd-sidenav ">
180+ < li class ="toctree-l1 has-children "> < a class ="reference internal " href ="../api/models/index.html "> Models</ a > < input class ="toctree-checkbox " id ="toctree-checkbox-1 " name ="toctree-checkbox-1 " type ="checkbox "/> < label class ="toctree-toggle " for ="toctree-checkbox-1 "> < i class ="fa-solid fa-chevron-down "> </ i > </ label > < ul >
181+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../api/models/Models.html "> mambular.models</ a > </ li >
182+ </ ul >
183+ </ li >
184+ < li class ="toctree-l1 has-children "> < a class ="reference internal " href ="../api/base_models/index.html "> BaseModels</ a > < input class ="toctree-checkbox " id ="toctree-checkbox-2 " name ="toctree-checkbox-2 " type ="checkbox "/> < label class ="toctree-toggle " for ="toctree-checkbox-2 "> < i class ="fa-solid fa-chevron-down "> </ i > </ label > < ul >
185+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../api/base_models/BaseModels.html "> mambular.base_models</ a > </ li >
186+ </ ul >
187+ </ li >
188+ < li class ="toctree-l1 has-children "> < a class ="reference internal " href ="../api/utils/index.html "> Utils</ a > < input class ="toctree-checkbox " id ="toctree-checkbox-3 " name ="toctree-checkbox-3 " type ="checkbox "/> < label class ="toctree-toggle " for ="toctree-checkbox-3 "> < i class ="fa-solid fa-chevron-down "> </ i > </ label > < ul >
189+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../api/utils/Preprocessor.html "> mambular.utils</ a > </ li >
190+ </ ul >
191+ </ li >
192+ </ ul >
193+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> Developer Guide</ span > </ p >
194+ < ul class ="nav bd-sidenav ">
195+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../codeofconduct.html "> Code of Conduct</ a > </ li >
196+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../development.html "> Contribute</ a > </ li >
197+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../release.html "> Build and release</ a > </ li >
198+ </ ul >
199+
200+ </ div >
201+ </ nav > </ div >
202+ </ div >
203+
204+
205+ < div class ="sidebar-primary-items__end sidebar-primary__section ">
206+ </ div >
207+
208+ < div id ="rtd-footer-container "> </ div >
209+
210+
211+ </ div >
212+
213+ < main id ="main-content " class ="bd-main ">
214+
215+
216+
217+ < div class ="sbt-scroll-pixel-helper "> </ div >
218+
219+ < div class ="bd-content ">
220+ < div class ="bd-article-container ">
221+
222+ < div class ="bd-header-article ">
223+ < div class ="header-article-items header-article__inner ">
224+
225+ < div class ="header-article-items__start ">
226+
227+ < div class ="header-article-item "> < label class ="sidebar-toggle primary-toggle btn btn-sm " for ="__primary " title ="Toggle primary sidebar " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
228+ < span class ="fa-solid fa-bars "> </ span >
229+ </ label > </ div >
230+
231+ </ div >
232+
233+
234+ < div class ="header-article-items__end ">
235+
236+ < div class ="header-article-item ">
237+
238+ < div class ="article-header-buttons ">
239+
240+
241+
242+ < button onclick ="toggleFullScreen() "
243+ class ="btn btn-sm btn-fullscreen-button "
244+ title ="Fullscreen mode "
245+ data-bs-placement ="bottom " data-bs-toggle ="tooltip "
246+ >
247+
248+
249+ < span class ="btn__icon-container ">
250+ < i class ="fas fa-expand "> </ i >
251+ </ span >
252+
253+ </ button >
254+
255+
256+
257+ < script >
258+ document . write ( `
259+ <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
260+ <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
261+ <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
262+ <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
263+ </button>
264+ ` ) ;
265+ </ script >
266+
267+
268+ < script >
269+ document . write ( `
270+ <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
271+ <i class="fa-solid fa-magnifying-glass fa-lg"></i>
272+ </button>
273+ ` ) ;
274+ </ script >
275+
276+ </ div > </ div >
277+
278+ </ div >
279+
280+ </ div >
281+ </ div >
282+
283+
284+
285+ < div id ="jb-print-docs-body " class ="onlyprint ">
286+ < h1 > </ h1 >
287+ <!-- Table of contents -->
288+ < div id ="print-main-content ">
289+ < div id ="jb-print-toc ">
290+
291+ </ div >
292+ </ div >
293+ </ div >
294+
295+
296+
297+ < div id ="searchbox "> </ div >
298+ < article class ="bd-article ">
299+
300+ < h1 > All modules for which code is available</ h1 >
301+ < ul > < li > < a href ="mambular/base_models/classifier.html "> mambular.base_models.classifier</ a > </ li >
302+ < li > < a href ="mambular/base_models/distributional.html "> mambular.base_models.distributional</ a > </ li >
303+ < li > < a href ="mambular/base_models/embedding_classifier.html "> mambular.base_models.embedding_classifier</ a > </ li >
304+ < li > < a href ="mambular/base_models/embedding_regressor.html "> mambular.base_models.embedding_regressor</ a > </ li >
305+ < li > < a href ="mambular/base_models/regressor.html "> mambular.base_models.regressor</ a > </ li >
306+ < li > < a href ="mambular/models/sklearn_classifier.html "> mambular.models.sklearn_classifier</ a > </ li >
307+ < li > < a href ="mambular/models/sklearn_distributional.html "> mambular.models.sklearn_distributional</ a > </ li >
308+ < li > < a href ="mambular/models/sklearn_embedding_classifier.html "> mambular.models.sklearn_embedding_classifier</ a > </ li >
309+ < li > < a href ="mambular/models/sklearn_embedding_regressor.html "> mambular.models.sklearn_embedding_regressor</ a > </ li >
310+ < li > < a href ="mambular/models/sklearn_regressor.html "> mambular.models.sklearn_regressor</ a > </ li >
311+ < li > < a href ="mambular/utils/preprocessor.html "> mambular.utils.preprocessor</ a > </ li >
312+ </ ul >
313+
314+ </ article >
315+
316+
317+
318+
319+
320+
321+ < footer class ="prev-next-footer ">
322+
323+ < div class ="prev-next-area ">
324+ </ div >
325+ </ footer >
326+
327+ </ div >
328+
329+
330+
331+ < div class ="bd-sidebar-secondary bd-toc "> </ div >
332+
333+
334+ </ div >
335+ < footer class ="bd-footer-content ">
336+
337+ < div class ="bd-footer-content__inner container ">
338+
339+ < div class ="footer-item ">
340+
341+ < p class ="component-author ">
342+ By Anton Frederik Thielmann, Manish Kumar, Christoph Weisser, Benjamin Saefken, Soheila Samiee
343+ </ p >
344+
345+ </ div >
346+
347+ < div class ="footer-item ">
348+
349+
350+ < p class ="copyright ">
351+
352+ © Copyright 2024, Christoph Weisser.
353+ < br />
354+
355+ </ p >
356+
357+ </ div >
358+
359+ < div class ="footer-item ">
360+ < p class ="last-updated ">
361+ Last updated on 2024-06-03.
362+ < br />
363+ </ p >
364+ </ div >
365+
366+ < div class ="footer-item ">
367+
368+ </ div >
369+
370+ </ div >
371+ </ footer >
372+
373+
374+ </ main >
375+ </ div >
376+ </ div >
377+
378+ <!-- Scripts loaded after <body> so the DOM is not blocked -->
379+ < script src ="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae "> </ script >
380+ < script src ="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae "> </ script >
381+
382+ < footer class ="bd-footer ">
383+ </ footer >
384+ </ body >
385+ </ html >
0 commit comments