Skip to content

Commit

Permalink
build based on df648d6
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 16, 2024
1 parent 12e4ea1 commit 2961bc0
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions dev/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@
dimensional_constraint_penalty=10^5,
)
mach = machine(model, X, y)
fit!(mach)</code></pre><p>You can observe that all expressions with a loss under our penalty are dimensionally consistent! (The <code>&quot;[?]&quot;</code> indicates free units in a constant, which can cancel out other units in the expression.) For example,</p><pre><code class="language-julia hljs">&quot;y[m s⁻² kg] = (M[kg] * 2.6353e-22[?])&quot;</code></pre><p>would indicate that the expression is dimensionally consistent, with a constant <code>&quot;2.6353e-22[m s⁻²]&quot;</code>.</p><p>Note that you can also search for dimensionless units by settings <code>dimensionless_constants_only</code> to <code>true</code>.</p><h2 id=".-Additional-features"><a class="docs-heading-anchor" href="#.-Additional-features">7. Additional features</a><a id=".-Additional-features-1"></a><a class="docs-heading-anchor-permalink" href="#.-Additional-features" title="Permalink"></a></h2><p>For the many other features available in SymbolicRegression.jl, check out the API page for <code>Options</code>. You might also find it useful to browse the documentation for the Python frontend <a href="http://astroautomata.com/PySR">PySR</a>, which has additional documentation. In particular, the <a href="http://astroautomata.com/PySR/tuning">tuning page</a> is useful for improving search performance.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="Sunday 16 June 2024 01:02">Sunday 16 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
fit!(mach)</code></pre><p>You can observe that all expressions with a loss under our penalty are dimensionally consistent! (The <code>&quot;[?]&quot;</code> indicates free units in a constant, which can cancel out other units in the expression.) For example,</p><pre><code class="language-julia hljs">&quot;y[m s⁻² kg] = (M[kg] * 2.6353e-22[?])&quot;</code></pre><p>would indicate that the expression is dimensionally consistent, with a constant <code>&quot;2.6353e-22[m s⁻²]&quot;</code>.</p><p>Note that you can also search for dimensionless units by settings <code>dimensionless_constants_only</code> to <code>true</code>.</p><h2 id=".-Additional-features"><a class="docs-heading-anchor" href="#.-Additional-features">7. Additional features</a><a id=".-Additional-features-1"></a><a class="docs-heading-anchor-permalink" href="#.-Additional-features" title="Permalink"></a></h2><p>For the many other features available in SymbolicRegression.jl, check out the API page for <code>Options</code>. You might also find it useful to browse the documentation for the Python frontend <a href="http://astroautomata.com/PySR">PySR</a>, which has additional documentation. In particular, the <a href="http://astroautomata.com/PySR/tuning">tuning page</a> is useful for improving search performance.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="Sunday 16 June 2024 01:03">Sunday 16 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,4 @@
for line in $(cat $f | grep -e &#39;import \.\.&#39; -e &#39;import \.&#39;); do
echo $(echo $line | vims -s &#39;dwf:d$&#39; -t &#39;%s/^\.*//g&#39; &#39;%s/Module//g&#39;) $(basename &quot;$f&quot; .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://astroautomata.com/SymbolicRegression.jl/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/#.-Additional-features">7. Additional features</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/#equation_search">equation_search</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/#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/">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="Sunday 16 June 2024 01:02">Sunday 16 June 2024</span>. Using Julia version 1.10.4.</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://astroautomata.com/SymbolicRegression.jl/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/#.-Additional-features">7. Additional features</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/#equation_search">equation_search</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/#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/">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="Sunday 16 June 2024 01:03">Sunday 16 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 2961bc0

Please sign in to comment.