Skip to content

Commit

Permalink
build based on 68f69b4
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 19, 2024
1 parent 3d9a817 commit b983335
Show file tree
Hide file tree
Showing 47 changed files with 3,880 additions and 3,873 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-03-18T12:33:20","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-03-19T14:59:10","documenter_version":"1.3.0"}}
8 changes: 4 additions & 4 deletions dev/Api.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/Api_v2_developer.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/Api_v2_user.html
View file

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions dev/Benchmarks.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Benchmarks · BetaML.jl Documentation</title><meta name="title" content="Benchmarks · BetaML.jl Documentation"/><meta property="og:title" content="Benchmarks · BetaML.jl Documentation"/><meta property="twitter:title" content="Benchmarks · BetaML.jl Documentation"/><meta name="description" content="Documentation for BetaML.jl Documentation."/><meta property="og:description" content="Documentation for BetaML.jl Documentation."/><meta property="twitter:description" content="Documentation for BetaML.jl Documentation."/><script async src="https://www.googletagmanager.com/gtag/js?id=G-JYKX8QY5JW"></script><script> window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-JYKX8QY5JW', {'page_path': location.pathname + location.search + location.hash});
</script><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">BetaML.jl Documentation</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="index.html">Index</a></li><li><span class="tocitem">Tutorial</span><ul><li><a class="tocitem" href="tutorials/Betaml_tutorial_getting_started.html">Getting started</a></li><li><input class="collapse-toggle" id="menuitem-2-2" type="checkbox"/><label class="tocitem" for="menuitem-2-2"><span class="docs-label">Classification - cars</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="tutorials/Classification - cars/betaml_tutorial_classification_cars.html">A classification task when labels are known - determining the country of origin of cars given the cars characteristics</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-3" type="checkbox"/><label class="tocitem" for="menuitem-2-3"><span class="docs-label">Regression - bike sharing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="tutorials/Regression - bike sharing/betaml_tutorial_regression_sharingBikes.html">A regression task: the prediction of bike sharing demand</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-4" type="checkbox"/><label class="tocitem" for="menuitem-2-4"><span class="docs-label">Clustering - Iris</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="tutorials/Clustering - Iris/betaml_tutorial_cluster_iris.html">A clustering task: the prediction of plant species from floreal measures (the iris dataset)</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-5" type="checkbox"/><label class="tocitem" for="menuitem-2-5"><span class="docs-label">Multi-branch neural network</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="tutorials/Multi-branch neural network/betaml_tutorial_multibranch_nn.html">A deep neural network with multi-branch architecture</a></li></ul></li></ul></li><li><span class="tocitem">API (Reference manual)</span><ul><li><input class="collapse-toggle" id="menuitem-3-1" type="checkbox"/><label class="tocitem" for="menuitem-3-1"><span class="docs-label">API V2 (current)</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="Api_v2_user.html">Introduction for user</a></li><li><input class="collapse-toggle" id="menuitem-3-1-2" type="checkbox"/><label class="tocitem" for="menuitem-3-1-2"><span class="docs-label">For developers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="Api_v2_developer.html">API implementation</a></li><li><a class="tocitem" href="StyleGuide_templates.html">Style guide</a></li></ul></li><li><a class="tocitem" href="Api.html">The Api module</a></li></ul></li><li><a class="tocitem" href="Perceptron.html">Perceptron</a></li><li><a class="tocitem" href="Trees.html">Trees</a></li><li><a class="tocitem" href="Nn.html">Nn</a></li><li><a class="tocitem" href="Clustering.html">Clustering</a></li><li><a class="tocitem" href="GMM.html">GMM</a></li><li><a class="tocitem" href="Imputation.html">Imputation</a></li><li><a class="tocitem" href="Utils.html">Utils</a></li></ul></li><li><a class="tocitem" href="MLJ_interface.html">MLJ interface</a></li><li class="is-active"><a class="tocitem" href="Benchmarks.html">Benchmarks</a><ul class="internal"><li><a class="tocitem" href="#Benchmark-setup"><span>Benchmark setup</span></a></li><li><a class="tocitem" href="#Regression"><span>Regression</span></a></li><li><a class="tocitem" href="#Classification"><span>Classification</span></a></li><li><a class="tocitem" href="#Clustering"><span>Clustering</span></a></li><li><a class="tocitem" href="#Missing-imputation"><span>Missing imputation</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="Benchmarks.html">Benchmarks</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="Benchmarks.html">Benchmarks</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/sylvaticus/BetaML.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/sylvaticus/BetaML.jl/blob/master/docs/src/Benchmarks.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="BetaML-Benchmarks"><a class="docs-heading-anchor" href="#BetaML-Benchmarks">BetaML Benchmarks</a><a id="BetaML-Benchmarks-1"></a><a class="docs-heading-anchor-permalink" href="#BetaML-Benchmarks" title="Permalink"></a></h1><p>This benchmark allows to quickly check for regressions across versions. As it is run and compiled using GitHub actions, and these may be powered by different computational resources, timing results are normalized using SystemBenchmark.</p><p>This page also provides a basic comparison with other leading Julia libraries for the same algorithm, USING DEFAULT VALUES. This file is intended just for benchmarking, not much as a tutorial, and it doesn&#39;t employ a full ML workflow, just the minimum preprocessing such that the algorithms work.</p><h2 id="Benchmark-setup"><a class="docs-heading-anchor" href="#Benchmark-setup">Benchmark setup</a><a id="Benchmark-setup-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmark-setup" title="Permalink"></a></h2><pre><code class="language-julia hljs">Threads.nthreads()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">4</code></pre><pre><code class="language-julia hljs">avg_factor_to_ref</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1.7456763872216032</code></pre><h2 id="Regression"><a class="docs-heading-anchor" href="#Regression">Regression</a><a id="Regression-1"></a><a class="docs-heading-anchor-permalink" href="#Regression" title="Permalink"></a></h2><p>A simple regression over 500 points with y = x₁²-x₂+x₃²</p><pre><code class="language-julia hljs">df_regr</code></pre><div class="data-frame"><p>6 rows × 8 columns</p><table class="data-frame"><thead><tr><th></th><th>name</th><th>time</th><th>memory</th><th>allocs</th><th>mre_train</th><th>std_train</th><th>mre_test</th><th>std_test</th></tr><tr><th></th><th title="String">String</th><th title="Float64">Float64</th><th title="Int64">Int64</th><th title="Int64">Int64</th><th title="Float64">Float64</th><th title="Float64">Float64</th><th title="Float64">Float64</th><th title="Float64">Float64</th></tr></thead><tbody><tr><th>1</th><td>DT</td><td>8.38164e6</td><td>8302672</td><td>55606</td><td>0.000723725</td><td>2.76557e-5</td><td>0.0052213</td><td>0.000643395</td></tr><tr><th>2</th><td>RF</td><td>6.70826e7</td><td>115797920</td><td>997715</td><td>0.00123145</td><td>3.35691e-5</td><td>0.00309481</td><td>0.000272821</td></tr><tr><th>3</th><td>NN</td><td>1.0668e9</td><td>1048887408</td><td>11227028</td><td>0.00117329</td><td>5.52884e-5</td><td>0.00119524</td><td>0.000245931</td></tr><tr><th>4</th><td>DT (DecisionTrees.jl)</td><td>1.11167e5</td><td>73344</td><td>499</td><td>0.00648375</td><td>0.000214495</td><td>0.00878351</td><td>0.00135441</td></tr><tr><th>5</th><td>RF (DecisionTrees.jl)</td><td>3.60889e5</td><td>1007488</td><td>3418</td><td>0.00491704</td><td>0.000156499</td><td>0.0061128</td><td>0.00136698</td></tr><tr><th>6</th><td>NN (Flux.jl)</td><td>1.2503e8</td><td>215321680</td><td>1178001</td><td>0.00334591</td><td>9.90508e-5</td><td>0.0033654</td><td>9.90508e-5</td></tr></tbody></table></div><h2 id="Classification"><a class="docs-heading-anchor" href="#Classification">Classification</a><a id="Classification-1"></a><a class="docs-heading-anchor-permalink" href="#Classification" title="Permalink"></a></h2><p>A dicotomic diagnostic breast cancer classification based on the <a href="https://archive.ics.uci.edu/dataset/17/breast+cancer+wisconsin+diagnostic">Wisconsin Breast Cancer Database</a>.</p><pre><code class="language-julia hljs">df_class</code></pre><div class="data-frame"><p>9 rows × 8 columns</p><table class="data-frame"><thead><tr><th></th><th>name</th><th>time</th><th>memory</th><th>allocs</th><th>acc_train</th><th>std_train</th><th>acc_test</th><th>std_test</th></tr><tr><th></th><th title="String">String</th><th title="Float64">Float64</th><th title="Int64">Int64</th><th title="Int64">Int64</th><th title="Float64">Float64</th><th title="Float64">Float64</th><th title="Float64">Float64</th><th title="Float64">Float64</th></tr></thead><tbody><tr><th>1</th><td>DT</td><td>3.96147e8</td><td>210752976</td><td>1300623</td><td>0.999414</td><td>0.00131826</td><td>0.912155</td><td>0.0247153</td></tr><tr><th>2</th><td>RF</td><td>6.56556e8</td><td>694666080</td><td>4120493</td><td>0.99961</td><td>0.00123286</td><td>0.961341</td><td>0.0215558</td></tr><tr><th>3</th><td>NN</td><td>2.69502e9</td><td>10846554912</td><td>15040744</td><td>0.999414</td><td>0.000943449</td><td>0.97193</td><td>0.0205928</td></tr><tr><th>4</th><td>Perc</td><td>7.85226e7</td><td>352294496</td><td>620910</td><td>0.990041</td><td>0.00578215</td><td>0.957895</td><td>0.0236824</td></tr><tr><th>5</th><td>KPerc</td><td>1.06994e9</td><td>1447524096</td><td>11995132</td><td>1.0</td><td>0.0</td><td>0.940351</td><td>0.0332871</td></tr><tr><th>6</th><td>Peg</td><td>1.63525e8</td><td>606676416</td><td>1378009</td><td>0.940832</td><td>0.0185063</td><td>0.938596</td><td>0.0312195</td></tr><tr><th>7</th><td>DT (DT.jl)</td><td>3.57919e6</td><td>56928</td><td>242</td><td>1.0</td><td>0.0</td><td>0.928008</td><td>0.0424737</td></tr><tr><th>8</th><td>RF (DT.jl)</td><td>1.21079e6</td><td>1789120</td><td>1804</td><td>0.990822</td><td>0.00391227</td><td>0.961341</td><td>0.0215558</td></tr><tr><th>9</th><td>NN (Flux.jl)</td><td>2.57438e8</td><td>572928080</td><td>1408801</td><td>1.0</td><td>0.0</td><td>0.964912</td><td>0.021881</td></tr></tbody></table></div><h2 id="Clustering"><a class="docs-heading-anchor" href="#Clustering">Clustering</a><a id="Clustering-1"></a><a class="docs-heading-anchor-permalink" href="#Clustering" title="Permalink"></a></h2><p>TODO :-)</p><h2 id="Missing-imputation"><a class="docs-heading-anchor" href="#Missing-imputation">Missing imputation</a><a id="Missing-imputation-1"></a><a class="docs-heading-anchor-permalink" href="#Missing-imputation" title="Permalink"></a></h2><p>TODO :-)</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="MLJ_interface.html">« MLJ interface</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 19 March 2024 14:59">Tuesday 19 March 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit b983335

Please sign in to comment.