build based on 15340c1

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-03T03:32:42","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-03T03:35:13","documenter_version":"1.7.0"}}

dev/anatomy_of_an_implementation/index.html

@@ -68,13 +68,13 @@
 ytrain = y[train]
 model = fit(algorithm, (Xtrain, ytrain))  # `fit(algorithm, Xtrain, ytrain)` will also work
 ŷ = predict(model, Tables.subset(X, test))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">4-element Vector{Float64}:
- 1.7787839661879423
- 1.474736217080038
- 0.8258896239485449
- 0.8872860616793237</code></pre><p>Extracting coefficients:</p><pre><code class="language-julia hljs">LearnAPI.coefficients(model)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">3-element Vector{Pair{Symbol, Float64}}:
- :a =&gt; 1.3075877481847373
- :b =&gt; 0.7281276945713715
- :c =&gt; 1.251451735167346</code></pre><p>Serialization/deserialization:</p><pre><code class="language-julia hljs">using Serialization
+ 3.1200819968645677
+ 1.3058374044936492
+ 3.1093884946089787
+ 0.4275542762330104</code></pre><p>Extracting coefficients:</p><pre><code class="language-julia hljs">LearnAPI.coefficients(model)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">3-element Vector{Pair{Symbol, Float64}}:
+ :a =&gt; 1.8733889088746318
+ :b =&gt; 0.11444988311319655
+ :c =&gt; 1.8143489770611856</code></pre><p>Serialization/deserialization:</p><pre><code class="language-julia hljs">using Serialization
 small_model = minimize(model)
 filename = tempname()
 serialize(filename, small_model)</code></pre><pre><code class="language-julia hljs">recovered_model = deserialize(filename)
@@ -124,7 +124,7 @@
 model = fit(algorithm, MLUtils.getobs(observations_for_fit, train))
 observations_for_predict = obs(model, X)
 ẑ = predict(model, MLUtils.getobs(observations_for_predict, test))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">4-element Vector{Float64}:
- 2.038937874999595
- 2.039772619460228
- 2.185727075357462
- 3.169261028759361</code></pre><pre><code class="language-julia hljs">@assert ẑ == ŷ</code></pre><p>For an application of <a href="../obs/#LearnAPI.obs"><code>obs</code></a> to efficient cross-validation, see <a href="../obs/#obs_workflows">here</a>.</p><hr/><p>¹ In LearnAPI.jl a <em>table</em> is any object <code>X</code> implementing the <a href="https://tables.juliadata.org/dev/">Tables.jl</a> interface, additionally satisfying <code>Tables.istable(X) == true</code> and implementing <code>DataAPI.nrow</code> (and whence <code>MLUtils.numobs</code>). Tables that are also (unnamed) tuples are disallowed.</p><p>² An implementation can provide further accessor functions, if necessary, but like the native ones, they must be included in the <a href="../traits/#LearnAPI.functions"><code>LearnAPI.functions</code></a> declaration.</p><p>³ The last index must be the observation index.</p><p>⁴ The <code>data = (X, y)</code> pattern implemented here is not the only supported pattern. For, example, <code>data</code> might be a single table containing both features and target variable. In this case, it will be necessary to overload <a href="../target_weights_features/#LearnAPI.features"><code>LearnAPI.features</code></a> in addition to <a href="../target_weights_features/#LearnAPI.target"><code>LearnAPI.target</code></a>; the name of the target column would need to be a hyperparameter.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">Overview »</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="Thursday 3 October 2024 03:32">Thursday 3 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 2.071540862735006
+ 2.203838455483823
+ 0.49668895250195255
+ 2.2997395734156787</code></pre><pre><code class="language-julia hljs">@assert ẑ == ŷ</code></pre><p>For an application of <a href="../obs/#LearnAPI.obs"><code>obs</code></a> to efficient cross-validation, see <a href="../obs/#obs_workflows">here</a>.</p><hr/><p>¹ In LearnAPI.jl a <em>table</em> is any object <code>X</code> implementing the <a href="https://tables.juliadata.org/dev/">Tables.jl</a> interface, additionally satisfying <code>Tables.istable(X) == true</code> and implementing <code>DataAPI.nrow</code> (and whence <code>MLUtils.numobs</code>). Tables that are also (unnamed) tuples are disallowed.</p><p>² An implementation can provide further accessor functions, if necessary, but like the native ones, they must be included in the <a href="../traits/#LearnAPI.functions"><code>LearnAPI.functions</code></a> declaration.</p><p>³ The last index must be the observation index.</p><p>⁴ The <code>data = (X, y)</code> pattern implemented here is not the only supported pattern. For, example, <code>data</code> might be a single table containing both features and target variable. In this case, it will be necessary to overload <a href="../target_weights_features/#LearnAPI.features"><code>LearnAPI.features</code></a> in addition to <a href="../target_weights_features/#LearnAPI.target"><code>LearnAPI.target</code></a>; the name of the target column would need to be a hyperparameter.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">Overview »</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="Thursday 3 October 2024 03:35">Thursday 3 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>