build based on a7d1dcb

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-08-16T19:07:00","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-10-25T09:53:31","documenter_version":"1.7.0"}}

dev/Api_v2_developer.html

@@ -38,4 +38,4 @@
         found || error("Keyword \"$kw\" is not part of this model.")
     end
     return m
-end</code></pre><p>So, in order to implement a new model we need to:</p><ul><li>implement its struct and constructor</li><li>implement the relative <code>ModelHyperParametersSet</code>, <code>ModelLearnedParametersSet</code> and eventually <code>ModelOptionsSet</code>.</li><li>define <code>fit!(model, X, [y])</code>, <code>predict(model,X)</code> and eventually <code>inverse_predict(model,X)</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Api_v2_user.html">« Introduction for user</a><a class="docs-footer-nextpage" href="StyleGuide_templates.html">Style guide »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Friday 16 August 2024 19:07">Friday 16 August 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>So, in order to implement a new model we need to:</p><ul><li>implement its struct and constructor</li><li>implement the relative <code>ModelHyperParametersSet</code>, <code>ModelLearnedParametersSet</code> and eventually <code>ModelOptionsSet</code>.</li><li>define <code>fit!(model, X, [y])</code>, <code>predict(model,X)</code> and eventually <code>inverse_predict(model,X)</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Api_v2_user.html">« Introduction for user</a><a class="docs-footer-nextpage" href="StyleGuide_templates.html">Style guide »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 25 October 2024 09:53">Friday 25 October 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/StyleGuide_templates.html

@@ -70,4 +70,4 @@
 
 Detailed description on the module objectives, content and organisation
 
-&quot;&quot;&quot;</code></pre><h2 id="Internal-links"><a class="docs-heading-anchor" href="#Internal-links">Internal links</a><a id="Internal-links-1"></a><a class="docs-heading-anchor-permalink" href="#Internal-links" title="Permalink"></a></h2><p>To refer to a documented object: <code>[`NAME`](@ref)</code> or <code>[`NAME`](@ref manual_id)</code>. In particular for internal links use <code>[`?NAME`](@ref ?NAME)</code></p><p>To create an id manually: <code>[Title](@id manual_id)</code></p><h2 id="Data-organisation"><a class="docs-heading-anchor" href="#Data-organisation">Data organisation</a><a id="Data-organisation-1"></a><a class="docs-heading-anchor-permalink" href="#Data-organisation" title="Permalink"></a></h2><ul><li>While some functions provide a <code>dims</code> parameter, most BetaML algorithms expect the input data layout with observations organised by rows and fields/features by columns.</li><li>While some algorithms accept as input DataFrames, the usage of standard arrays is encourages (if the data is passed to the function as dataframe, it may be converted to standard arrays somewhere inside inner loops, leading to great inefficiencies).</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Api_v2_developer.html">« API implementation</a><a class="docs-footer-nextpage" href="Api.html">The Api module »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Friday 16 August 2024 19:07">Friday 16 August 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+&quot;&quot;&quot;</code></pre><h2 id="Internal-links"><a class="docs-heading-anchor" href="#Internal-links">Internal links</a><a id="Internal-links-1"></a><a class="docs-heading-anchor-permalink" href="#Internal-links" title="Permalink"></a></h2><p>To refer to a documented object: <code>[`NAME`](@ref)</code> or <code>[`NAME`](@ref manual_id)</code>. In particular for internal links use <code>[`?NAME`](@ref ?NAME)</code></p><p>To create an id manually: <code>[Title](@id manual_id)</code></p><h2 id="Data-organisation"><a class="docs-heading-anchor" href="#Data-organisation">Data organisation</a><a id="Data-organisation-1"></a><a class="docs-heading-anchor-permalink" href="#Data-organisation" title="Permalink"></a></h2><ul><li>While some functions provide a <code>dims</code> parameter, most BetaML algorithms expect the input data layout with observations organised by rows and fields/features by columns.</li><li>While some algorithms accept as input DataFrames, the usage of standard arrays is encourages (if the data is passed to the function as dataframe, it may be converted to standard arrays somewhere inside inner loops, leading to great inefficiencies).</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Api_v2_developer.html">« API implementation</a><a class="docs-footer-nextpage" href="Api.html">The Api module »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 25 October 2024 09:53">Friday 25 October 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -103,4 +103,4 @@
 # Prediction assessment
 relative_mean_error_train = relative_mean_error(ytrain,ŷtrain) # 0.039
 relative_mean_error_test  = relative_mean_error(ytest,ŷtest)   # 0.076
-scatter(ytest,ŷtest,xlabel=&quot;Actual&quot;,ylabel=&quot;Estimated&quot;,label=nothing,title=&quot;Est vs. obs MPG (test set)&quot;)</code></pre><p><img src="assets/mpg_EstVsObs.png" alt="results"/></p><ul><li><strong>Further examples</strong></li></ul><p>Finally, you may want to give a look at the <a href="https://github.com/sylvaticus/BetaML.jl/tree/master/test">&quot;test&quot; folder</a>. While the primary objective of the scripts under the &quot;test&quot; folder is to provide automatic testing of the BetaML toolkit, they can also be used to see how functions should be called, as virtually all functions provided by BetaML are tested there.</p><h2 id="Benchmarks"><a class="docs-heading-anchor" href="#Benchmarks">Benchmarks</a><a id="Benchmarks-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmarks" title="Permalink"></a></h2><p>A page summarising some basic benchmarks for BetaML and other leading Julia ML libraries is available <a href="@ref benchmarks">here</a>.</p><h2 id="Acknowledgements"><a class="docs-heading-anchor" href="#Acknowledgements">Acknowledgements</a><a id="Acknowledgements-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgements" title="Permalink"></a></h2><p>The development of this package at the <em>Bureau d&#39;Economie Théorique et Appliquée</em> (BETA, Nancy) was supported by the French National Research Agency through the <a href="http://mycor.nancy.inra.fr/ARBRE/">Laboratory of Excellence ARBRE</a>, a part of the “Investissements d&#39;Avenir” Program (ANR 11 – LABX-0002-01).</p><p><a href="hhttp://www.beta-umr7522.fr/"><img src="assets/logos_betaumr.png" alt="BLogos"/></a></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/Betaml_tutorial_getting_started.html">Getting started »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Friday 16 August 2024 19:07">Friday 16 August 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+scatter(ytest,ŷtest,xlabel=&quot;Actual&quot;,ylabel=&quot;Estimated&quot;,label=nothing,title=&quot;Est vs. obs MPG (test set)&quot;)</code></pre><p><img src="assets/mpg_EstVsObs.png" alt="results"/></p><ul><li><strong>Further examples</strong></li></ul><p>Finally, you may want to give a look at the <a href="https://github.com/sylvaticus/BetaML.jl/tree/master/test">&quot;test&quot; folder</a>. While the primary objective of the scripts under the &quot;test&quot; folder is to provide automatic testing of the BetaML toolkit, they can also be used to see how functions should be called, as virtually all functions provided by BetaML are tested there.</p><h2 id="Benchmarks"><a class="docs-heading-anchor" href="#Benchmarks">Benchmarks</a><a id="Benchmarks-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmarks" title="Permalink"></a></h2><p>A page summarising some basic benchmarks for BetaML and other leading Julia ML libraries is available <a href="@ref benchmarks">here</a>.</p><h2 id="Acknowledgements"><a class="docs-heading-anchor" href="#Acknowledgements">Acknowledgements</a><a id="Acknowledgements-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgements" title="Permalink"></a></h2><p>The development of this package at the <em>Bureau d&#39;Economie Théorique et Appliquée</em> (BETA, Nancy) was supported by the French National Research Agency through the <a href="http://mycor.nancy.inra.fr/ARBRE/">Laboratory of Excellence ARBRE</a>, a part of the “Investissements d&#39;Avenir” Program (ANR 11 – LABX-0002-01).</p><p><a href="hhttp://www.beta-umr7522.fr/"><img src="assets/logos_betaumr.png" alt="BLogos"/></a></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/Betaml_tutorial_getting_started.html">Getting started »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 25 October 2024 09:53">Friday 25 October 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>