build based on 92f2b33

dev/examples/parameterized_function/index.html

@@ -42,8 +42,8 @@
 );</code></pre><p>Now, let&#39;s set up the machine and fit it:</p><pre><code class="language-julia hljs">mach = machine(model, X, y)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">untrained Machine; caches model-specific representations of data
   model: SRRegressor(defaults = nothing, …)
   args: 
-    1:	Source @527 ⏎ ScientificTypesBase.Table{Union{AbstractVector{ScientificTypesBase.Continuous}, AbstractVector{ScientificTypesBase.Count}}}
-    2:	Source @172 ⏎ AbstractVector{ScientificTypesBase.Continuous}
+    1:	Source @464 ⏎ ScientificTypesBase.Table{Union{AbstractVector{ScientificTypesBase.Continuous}, AbstractVector{ScientificTypesBase.Count}}}
+    2:	Source @369 ⏎ AbstractVector{ScientificTypesBase.Continuous}
 </code></pre><p>At this point, you would run:</p><pre><code class="language-julia hljs">fit!(mach)</code></pre><p>You can extract the best expression and parameters with:</p><pre><code class="language-julia hljs">report(mach).equations[end]</code></pre><h2 id="Key-Takeaways"><a class="docs-heading-anchor" href="#Key-Takeaways">Key Takeaways</a><a id="Key-Takeaways-1"></a><a class="docs-heading-anchor-permalink" href="#Key-Takeaways" title="Permalink"></a></h2><ol><li><a href="../../types/#DynamicExpressions.ParametricExpressionModule.ParametricExpression"><code>ParametricExpression</code></a>s allows us to discover symbolic expressions with optimizable parameters</li><li>The parameters can capture class-dependent variations in the underlying model</li></ol><p>This approach is particularly useful when you suspect your data follows a common functional form, but with varying parameters across different conditions or class!</p><hr/><details>
 <summary> Show raw source code </summary><pre><code class="language-julia hljs">#=
 # Learning Parameterized Expressions
@@ -141,4 +141,4 @@
 
 This approach is particularly useful when you suspect your data follows a common
 functional form, but with varying parameters across different conditions or class!
-=#</code></pre><p>which uses Literate.jl to generate this page.</p></details></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../template_expression/">« Template Expressions</a><a class="docs-footer-nextpage" href="../../api/">API »</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="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 0.27.25 on <span class="colophon-date" title="Friday 8 November 2024 03:18">Friday 8 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+=#</code></pre><p>which uses Literate.jl to generate this page.</p></details></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../template_expression/">« Template Expressions</a><a class="docs-footer-nextpage" href="../../api/">API »</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="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 0.27.25 on <span class="colophon-date" title="Saturday 9 November 2024 20:45">Saturday 9 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/template_expression/index.html

@@ -119,8 +119,8 @@
 );</code></pre><p>Note how we also have to define the custom <code>elementwise_loss</code> function. This is because our <code>combine_vectors</code> function returns a <code>Force</code> struct, so we need to combine it against the truth!</p><p>Next, we can set up our machine and fit:</p><pre><code class="language-julia hljs">mach = machine(model, X, y)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">untrained Machine; caches model-specific representations of data
   model: SRRegressor(defaults = nothing, …)
   args: 
-    1:	Source @354 ⏎ ScientificTypesBase.Table{AbstractVector{ScientificTypesBase.Continuous}}
-    2:	Source @137 ⏎ AbstractVector{ScientificTypesBase.Unknown}
+    1:	Source @231 ⏎ ScientificTypesBase.Table{AbstractVector{ScientificTypesBase.Continuous}}
+    2:	Source @221 ⏎ AbstractVector{ScientificTypesBase.Unknown}
 </code></pre><p>At this point, you would run:</p><pre><code class="language-julia hljs">fit!(mach)</code></pre><p>which should print using your <code>combine_strings</code> function during the search. The final result is accessible with:</p><pre><code class="language-julia hljs">report(mach)</code></pre><p>which would return a named tuple of the fitted results, including the <code>.equations</code> field, which is a vector of <code>TemplateExpression</code> objects that dominated the Pareto front.</p><hr/><details>
 <summary> Show raw source code </summary><pre><code class="language-julia hljs">#=
 # Searching with template expressions
@@ -408,4 +408,4 @@
 which would return a named tuple of the fitted results,
 including the `.equations` field, which is a vector
 of `TemplateExpression` objects that dominated the Pareto front.
-=#</code></pre><p>which uses Literate.jl to generate this page.</p></details></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Short Examples</a><a class="docs-footer-nextpage" href="../parameterized_function/">Parameterized Expressions »</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="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 0.27.25 on <span class="colophon-date" title="Friday 8 November 2024 03:18">Friday 8 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+=#</code></pre><p>which uses Literate.jl to generate this page.</p></details></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Short Examples</a><a class="docs-footer-nextpage" href="../parameterized_function/">Parameterized Expressions »</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="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 0.27.25 on <span class="colophon-date" title="Saturday 9 November 2024 20:45">Saturday 9 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -277,4 +277,4 @@
     for line in $(cat $f | grep -e 'import \.\.' -e 'import \.' -e 'using \.' -e 'using \.\.'); do
         echo $(echo $line | vims -s 'dwf:d$' -t '%s/^\.*//g' '%s/Module//g') $(basename "$f" .jl);
     done;
-done | vims -l &#39;f a--&gt; &#39; | sort</code></pre><h2 id="Search-options"><a class="docs-heading-anchor" href="#Search-options">Search options</a><a id="Search-options-1"></a><a class="docs-heading-anchor-permalink" href="#Search-options" title="Permalink"></a></h2><p>See https://ai.damtp.cam.ac.uk/symbolicregression/stable/api/#Options</p><h1 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h1><ul><li><a href="examples/#Toy-Examples-with-Code">Toy Examples with Code</a></li><li class="no-marker"><ul><li><a href="examples/#.-Simple-search">1. Simple search</a></li><li><a href="examples/#.-Custom-operator">2. Custom operator</a></li><li><a href="examples/#.-Multiple-outputs">3. Multiple outputs</a></li><li><a href="examples/#.-Plotting-an-expression">4. Plotting an expression</a></li><li><a href="examples/#.-Other-types">5. Other types</a></li><li><a href="examples/#.-Dimensional-constraints">6. Dimensional constraints</a></li><li><a href="examples/#.-Working-with-Expressions">7. Working with Expressions</a></li><li><a href="examples/#.-Template-Expressions">8. Template Expressions</a></li><li><a href="examples/#.-Additional-features">9. Additional features</a></li></ul></li><li><a href="examples/template_expression/#Searching-with-template-expressions">Searching with template expressions</a></li><li class="no-marker"><ul><li><a href="examples/template_expression/#The-Physical-Problem">The Physical Problem</a></li></ul></li><li><a href="api/#API">API</a></li><li class="no-marker"><ul><li><a href="api/#MLJ-interface">MLJ interface</a></li><li><a href="api/#Low-Level-API">Low-Level API</a></li><li><a href="api/#Options">Options</a></li><li><a href="api/#Printing">Printing</a></li><li><a href="api/#Evaluation">Evaluation</a></li><li><a href="api/#Derivatives">Derivatives</a></li><li><a href="api/#SymbolicUtils.jl-interface">SymbolicUtils.jl interface</a></li><li><a href="api/#Pareto-frontier">Pareto frontier</a></li></ul></li><li><a href="types/#Types">Types</a></li><li class="no-marker"><ul><li><a href="types/#Equations">Equations</a></li><li><a href="types/#Expressions">Expressions</a></li><li><a href="types/#Parametric-Expressions">Parametric Expressions</a></li><li><a href="types/#Template-Expressions">Template Expressions</a></li><li><a href="types/#Population">Population</a></li><li><a href="types/#Population-members">Population members</a></li><li><a href="types/#Hall-of-Fame">Hall of Fame</a></li><li><a href="types/#Dataset">Dataset</a></li></ul></li><li><a href="losses/#Losses">Losses</a></li><li class="no-marker"><ul><li><a href="losses/#Regression">Regression</a></li><li><a href="losses/#Classification">Classification</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index_base/">« Contents</a><a class="docs-footer-nextpage" href="examples/">Short Examples »</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="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 0.27.25 on <span class="colophon-date" title="Friday 8 November 2024 03:18">Friday 8 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+done | vims -l &#39;f a--&gt; &#39; | sort</code></pre><h2 id="Search-options"><a class="docs-heading-anchor" href="#Search-options">Search options</a><a id="Search-options-1"></a><a class="docs-heading-anchor-permalink" href="#Search-options" title="Permalink"></a></h2><p>See https://ai.damtp.cam.ac.uk/symbolicregression/stable/api/#Options</p><h1 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h1><ul><li><a href="examples/#Toy-Examples-with-Code">Toy Examples with Code</a></li><li class="no-marker"><ul><li><a href="examples/#.-Simple-search">1. Simple search</a></li><li><a href="examples/#.-Custom-operator">2. Custom operator</a></li><li><a href="examples/#.-Multiple-outputs">3. Multiple outputs</a></li><li><a href="examples/#.-Plotting-an-expression">4. Plotting an expression</a></li><li><a href="examples/#.-Other-types">5. Other types</a></li><li><a href="examples/#.-Dimensional-constraints">6. Dimensional constraints</a></li><li><a href="examples/#.-Working-with-Expressions">7. Working with Expressions</a></li><li><a href="examples/#.-Template-Expressions">8. Template Expressions</a></li><li><a href="examples/#.-Logging-with-TensorBoard">9. Logging with TensorBoard</a></li><li><a href="examples/#.-Additional-features">10. Additional features</a></li></ul></li><li><a href="examples/template_expression/#Searching-with-template-expressions">Searching with template expressions</a></li><li class="no-marker"><ul><li><a href="examples/template_expression/#The-Physical-Problem">The Physical Problem</a></li></ul></li><li><a href="api/#API">API</a></li><li class="no-marker"><ul><li><a href="api/#MLJ-interface">MLJ interface</a></li><li><a href="api/#Low-Level-API">Low-Level API</a></li><li><a href="api/#Options">Options</a></li><li><a href="api/#Printing">Printing</a></li><li><a href="api/#Evaluation">Evaluation</a></li><li><a href="api/#Derivatives">Derivatives</a></li><li><a href="api/#SymbolicUtils.jl-interface">SymbolicUtils.jl interface</a></li><li><a href="api/#Pareto-frontier">Pareto frontier</a></li><li><a href="api/#Logging">Logging</a></li></ul></li><li><a href="types/#Types">Types</a></li><li class="no-marker"><ul><li><a href="types/#Equations">Equations</a></li><li><a href="types/#Expressions">Expressions</a></li><li><a href="types/#Parametric-Expressions">Parametric Expressions</a></li><li><a href="types/#Template-Expressions">Template Expressions</a></li><li><a href="types/#Population">Population</a></li><li><a href="types/#Population-members">Population members</a></li><li><a href="types/#Hall-of-Fame">Hall of Fame</a></li><li><a href="types/#Dataset">Dataset</a></li></ul></li><li><a href="losses/#Losses">Losses</a></li><li class="no-marker"><ul><li><a href="losses/#Regression">Regression</a></li><li><a href="losses/#Classification">Classification</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index_base/">« Contents</a><a class="docs-footer-nextpage" href="examples/">Short Examples »</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="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 0.27.25 on <span class="colophon-date" title="Saturday 9 November 2024 20:45">Saturday 9 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>