build based on f7ee313

dev/index.html

@@ -10,4 +10,4 @@
   title = {{EvoLP.jl: A Playground for Evolutionary Computation in Julia}},
   url = {https://ceur-ws.org/Vol-3431/},
   year = {2023}
-}</code></pre><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>EvoLP started as a toolbox for internal use by PhD students of <a href="https://www.ntnu.edu/ailab/ai-lab">NTNU&#39;s Open AI Lab</a>, and whose funding is provided by <a href="https://prosjektbanken.forskningsradet.no/en/project/FORISS/311284">Project no. 311284</a> by <a href="https://www.forskningsradet.no/">The Research Council of Norway</a>.</p><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>EvoLP is licensed under the <a href="https://github.com/ntnu-ai-lab/EvoLP/blob/main/LICENSE">MIT License</a> which makes it free and open source.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quickstart.html">Quick start »</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="Monday 20 May 2024 14:55">Monday 20 May 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><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>EvoLP started as a toolbox for internal use by PhD students of <a href="https://www.ntnu.edu/ailab/ai-lab">NTNU&#39;s Open AI Lab</a>, and whose funding is provided by <a href="https://prosjektbanken.forskningsradet.no/en/project/FORISS/311284">Project no. 311284</a> by <a href="https://www.forskningsradet.no/">The Research Council of Norway</a>.</p><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>EvoLP is licensed under the <a href="https://github.com/ntnu-ai-lab/EvoLP/blob/main/LICENSE">MIT License</a> which makes it free and open source.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quickstart.html">Quick start »</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="Monday 20 May 2024 15:08">Monday 20 May 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/man/quickstart.html

@@ -3,4 +3,4 @@
 julia&gt; Pkg.add(&quot;EvoLP&quot;)</code></pre><p>Alternatively, you can enter <code>Pkg</code> mode by pressing the <code>]</code> key and then add EvoLP like so:</p><pre><code class="language-julia hljs">] # upon typing ], the prompt changes (in place) to: pkg&gt;
 add EvoLP</code></pre><p>Once EvoLP is installed, you can use all the building blocks by importing/using it at the top of your code:</p><pre><code class="language-julia hljs">using EvoLP
 
-# your code here</code></pre><h2 id="The-general-workflow"><a class="docs-heading-anchor" href="#The-general-workflow">The general workflow</a><a id="The-general-workflow-1"></a><a class="docs-heading-anchor-permalink" href="#The-general-workflow" title="Permalink"></a></h2><p>A common workflow in EvoLP is somewhat similar to this:</p><ol><li>Use a <a href="generators.html">generator</a> for initialising your population.</li><li>Code your objective or use a <a href="testfunctions.html">test benchmark function</a>.</li><li>Depending on your objective function and individual representation, choose appropriate <a href="selection.html">selectors</a>, <a href="cross.html">recombinators</a> and <a href="mutation.html">mutators</a>.</li><li>Use a <a href="algorithms.html">built-in algorithm</a> or code your own. Roughly:<ul><li>Evaluate your population.</li><li>Use <a href="selection.html#EvoLP.select"><code>select</code></a> and <a href="cross.html#EvoLP.cross"><code>cross</code></a> to generate new solutions.</li><li>Stochastically alter new solutions using <a href="mutation.html#EvoLP.mutate"><code>mutate</code></a>.</li><li>Evaluate the new population members and select the survivors.</li><li>Optionally compute statistic and log them in the <a href="logbook.html">Logbook</a>.</li><li>Return the <a href="results.html">results</a>.</li></ul></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../index.html">« Introduction</a><a class="docs-footer-nextpage" href="algorithms.html">Algorithms »</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="Monday 20 May 2024 14:55">Monday 20 May 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+# your code here</code></pre><h2 id="The-general-workflow"><a class="docs-heading-anchor" href="#The-general-workflow">The general workflow</a><a id="The-general-workflow-1"></a><a class="docs-heading-anchor-permalink" href="#The-general-workflow" title="Permalink"></a></h2><p>A common workflow in EvoLP is somewhat similar to this:</p><ol><li>Use a <a href="generators.html">generator</a> for initialising your population.</li><li>Code your objective or use a <a href="testfunctions.html">test benchmark function</a>.</li><li>Depending on your objective function and individual representation, choose appropriate <a href="selection.html">selectors</a>, <a href="cross.html">recombinators</a> and <a href="mutation.html">mutators</a>.</li><li>Use a <a href="algorithms.html">built-in algorithm</a> or code your own. Roughly:<ul><li>Evaluate your population.</li><li>Use <a href="selection.html#EvoLP.select"><code>select</code></a> and <a href="cross.html#EvoLP.cross"><code>cross</code></a> to generate new solutions.</li><li>Stochastically alter new solutions using <a href="mutation.html#EvoLP.mutate"><code>mutate</code></a>.</li><li>Evaluate the new population members and select the survivors.</li><li>Optionally compute statistic and log them in the <a href="logbook.html">Logbook</a>.</li><li>Return the <a href="results.html">results</a>.</li></ul></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../index.html">« Introduction</a><a class="docs-footer-nextpage" href="algorithms.html">Algorithms »</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="Monday 20 May 2024 15:08">Monday 20 May 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>