build based on 03ccc2d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-22T21:08:38","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-02T01:51:42","documenter_version":"1.5.0"}}

dev/document_strings/index.html

@@ -22,4 +22,4 @@
 
 """
 FooRegressor
-</code></pre><p><strong>Variation to augment existing document string</strong></p><p>For models that have a native API with separate documentation, one may want to call <code>doc_header(FooRegressor, augment=true)</code> instead. In that case, the output will look like this:</p><blockquote><p>From MLJ, the <code>FooRegressor</code> type can be imported using</p><p><code>FooRegressor = @load FooRegressor pkg=FooRegressorPkg</code></p><p>Construct an instance with default hyper-parameters using the syntax <code>model = FooRegressor()</code>. Provide keyword arguments to override hyper-parameter defaults, as in <code>FooRegressor(a=...)</code>.</p></blockquote></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLJModelInterface.jl/blob/9871ba2b7a8a64c548cd941291e1c9b9d2216edd/src/metadata_utils.jl#L154-L233">source</a></section></article><h2 id="The-document-string-standard"><a class="docs-heading-anchor" href="#The-document-string-standard">The document string standard</a><a id="The-document-string-standard-1"></a><a class="docs-heading-anchor-permalink" href="#The-document-string-standard" title="Permalink"></a></h2><p>Your document string must include the following components, in order:</p><ul><li><p>A <em>header</em>, closely matching the example given above.</p></li><li><p>A <em>reference describing the algorithm</em> or an actual description of the algorithm, if necessary. Detail any non-standard aspects of the implementation. Generally, defer details on the role of hyperparameters to the &quot;Hyperparameters&quot; section (see below).</p></li><li><p>Instructions on <em>how to import the model type</em> from MLJ (because a user can already inspect the doc-string in the Model Registry, without having loaded the code-providing package).</p></li><li><p>Instructions on <em>how to instantiate</em> with default hyperparameters or with keywords.</p></li><li><p>A <em>Training data</em> section: explains how to bind a model to data in a machine with all possible signatures (eg, <code>machine(model, X, y)</code> but also <code>machine(model, X, y, w)</code> if, say, weights are supported);  the role and scitype requirements for each data argument should be itemized.</p></li><li><p>Instructions on <em>how to fit</em> the machine (in the same section).</p></li><li><p>A <em>Hyperparameters</em> section (unless there aren&#39;t any): an itemized list of the parameters, with defaults given.</p></li><li><p>An <em>Operations</em> section: each implemented operation (<code>predict</code>, <code>predict_mode</code>, <code>transform</code>, <code>inverse_transform</code>, etc ) is itemized and explained. This should include operations with no data arguments, such as <code>training_losses</code> and <code>feature_importances</code>.</p></li><li><p>A <em>Fitted parameters</em> section: To explain what is returned by <code>fitted_params(mach)</code> (the same as <code>MLJModelInterface.fitted_params(model, fitresult)</code> -  see later) with the fields of that named tuple itemized.</p></li><li><p>A <em>Report</em> section (if <code>report</code> is non-empty): To explain what, if anything, is included in the <code>report(mach)</code>  (the same as the <code>report</code> return value of <code>MLJModelInterface.fit</code>) with the fields itemized.</p></li><li><p>An optional but highly recommended <em>Examples</em> section, which includes MLJ examples, but which could also include others if the model type also implements a second &quot;local&quot; interface, i.e., defined in the same module. (Note that each module referring to a type can declare separate doc-strings which appear concatenated in doc-string queries.)</p></li><li><p>A closing <em>&quot;See also&quot;</em> sentence which includes a <code>@ref</code> link to the raw model type (if you are wrapping one).</p></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../serialization/">« Serialization</a><a class="docs-footer-nextpage" href="../convenience_methods/">Convenience methods »</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="Monday 22 July 2024 21:08">Monday 22 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p><strong>Variation to augment existing document string</strong></p><p>For models that have a native API with separate documentation, one may want to call <code>doc_header(FooRegressor, augment=true)</code> instead. In that case, the output will look like this:</p><blockquote><p>From MLJ, the <code>FooRegressor</code> type can be imported using</p><p><code>FooRegressor = @load FooRegressor pkg=FooRegressorPkg</code></p><p>Construct an instance with default hyper-parameters using the syntax <code>model = FooRegressor()</code>. Provide keyword arguments to override hyper-parameter defaults, as in <code>FooRegressor(a=...)</code>.</p></blockquote></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLJModelInterface.jl/blob/03ccc2dbdc8a87b869fad27bf550f62f8a26c005/src/metadata_utils.jl#L154-L233">source</a></section></article><h2 id="The-document-string-standard"><a class="docs-heading-anchor" href="#The-document-string-standard">The document string standard</a><a id="The-document-string-standard-1"></a><a class="docs-heading-anchor-permalink" href="#The-document-string-standard" title="Permalink"></a></h2><p>Your document string must include the following components, in order:</p><ul><li><p>A <em>header</em>, closely matching the example given above.</p></li><li><p>A <em>reference describing the algorithm</em> or an actual description of the algorithm, if necessary. Detail any non-standard aspects of the implementation. Generally, defer details on the role of hyperparameters to the &quot;Hyperparameters&quot; section (see below).</p></li><li><p>Instructions on <em>how to import the model type</em> from MLJ (because a user can already inspect the doc-string in the Model Registry, without having loaded the code-providing package).</p></li><li><p>Instructions on <em>how to instantiate</em> with default hyperparameters or with keywords.</p></li><li><p>A <em>Training data</em> section: explains how to bind a model to data in a machine with all possible signatures (eg, <code>machine(model, X, y)</code> but also <code>machine(model, X, y, w)</code> if, say, weights are supported);  the role and scitype requirements for each data argument should be itemized.</p></li><li><p>Instructions on <em>how to fit</em> the machine (in the same section).</p></li><li><p>A <em>Hyperparameters</em> section (unless there aren&#39;t any): an itemized list of the parameters, with defaults given.</p></li><li><p>An <em>Operations</em> section: each implemented operation (<code>predict</code>, <code>predict_mode</code>, <code>transform</code>, <code>inverse_transform</code>, etc ) is itemized and explained. This should include operations with no data arguments, such as <code>training_losses</code> and <code>feature_importances</code>.</p></li><li><p>A <em>Fitted parameters</em> section: To explain what is returned by <code>fitted_params(mach)</code> (the same as <code>MLJModelInterface.fitted_params(model, fitresult)</code> -  see later) with the fields of that named tuple itemized.</p></li><li><p>A <em>Report</em> section (if <code>report</code> is non-empty): To explain what, if anything, is included in the <code>report(mach)</code>  (the same as the <code>report</code> return value of <code>MLJModelInterface.fit</code>) with the fields itemized.</p></li><li><p>An optional but highly recommended <em>Examples</em> section, which includes MLJ examples, but which could also include others if the model type also implements a second &quot;local&quot; interface, i.e., defined in the same module. (Note that each module referring to a type can declare separate doc-strings which appear concatenated in doc-string queries.)</p></li><li><p>A closing <em>&quot;See also&quot;</em> sentence which includes a <code>@ref</code> link to the raw model type (if you are wrapping one).</p></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../serialization/">« Serialization</a><a class="docs-footer-nextpage" href="../convenience_methods/">Convenience methods »</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 2 August 2024 01:51">Friday 2 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>