Skip to content

Commit

Permalink
Bumps minor 0.4.0, regenerate documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoFara committed Jun 21, 2023
1 parent 867deda commit 713c8a7
Show file tree
Hide file tree
Showing 25 changed files with 535 additions and 578 deletions.
Binary file modified docs/doctrees/api/dynamiclinkage.doctree
Binary file not shown.
Binary file modified docs/doctrees/api/geneticoptimizer.doctree
Binary file not shown.
Binary file modified docs/doctrees/api/physicsengine.doctree
Binary file not shown.
Binary file modified docs/doctrees/changeloglink.doctree
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/doctrees/readmelink.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 121c273cf36d6a3810e35e3ad995fcd0
config: 6be4f58d4969d3be4f2c315dec086350
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.3.1',
VERSION: '0.4.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/html/api/dynamiclinkage.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dynamiclinkage &mdash; LeggedSnake 0.3.1 documentation</title>
<title>dynamiclinkage &mdash; LeggedSnake 0.4.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -257,7 +257,7 @@ <h1>dynamiclinkage<a class="headerlink" href="#dynamiclinkage" title="Permalink
<dl class="py method">
<dt class="sig sig-object py" id="leggedsnake.dynamiclinkage.DynamicLinkage.build_load">
<span class="sig-name descname"><span class="pre">build_load</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_mass</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#leggedsnake.dynamiclinkage.DynamicLinkage.build_load" title="Permalink to this definition"></a></dt>
<dd><p>Create the load this linkage have to carry.</p>
<dd><p>Create the load this linkage has to carry.</p>
</dd></dl>

<dl class="py method">
Expand Down
228 changes: 91 additions & 137 deletions docs/html/api/geneticoptimizer.html

Large diffs are not rendered by default.

108 changes: 19 additions & 89 deletions docs/html/api/physicsengine.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/api/utility.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>utility &mdash; LeggedSnake 0.3.1 documentation</title>
<title>utility &mdash; LeggedSnake 0.4.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/api/walker.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>walker &mdash; LeggedSnake 0.3.1 documentation</title>
<title>walker &mdash; LeggedSnake 0.4.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
89 changes: 88 additions & 1 deletion docs/html/changeloglink.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; LeggedSnake 0.3.1 documentation</title>
<title>Changelog &mdash; LeggedSnake 0.4.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -46,6 +46,14 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="readmelink.html">Readme</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#unreleased">[Unreleased]</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#deprecated">Deprecated</a></li>
<li class="toctree-l3"><a class="reference internal" href="#removed">Removed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id1">[0.3.1] - 2023-06-14</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added-in-0-3-1">Added in 0.3.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#changed-in-0-3-1">Changed in 0.3.1</a></li>
Expand Down Expand Up @@ -161,6 +169,85 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
<p>All notable changes to the LeggedSnake will be documented in this file.</p>
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
<section id="unreleased">
<h2>[Unreleased]<a class="headerlink" href="#unreleased" title="Permalink to this heading"></a></h2>
<section id="added">
<h3>Added<a class="headerlink" href="#added" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>View all walkers!</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">show_all_walkers</span></code> in <code class="docutils literal notranslate"><span class="pre">docs/examples/strider.py</span></code> let you see all walkers in one simulation!</p></li>
<li><p>You can set the color of walkers during display.</p></li>
</ul>
</li>
<li><p>Genetic optimization:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">GeneticOptimization</span></code> class in <code class="docutils literal notranslate"><span class="pre">geneticoptimizer.py</span></code> that will replace the previous functional paradigm.</p></li>
<li><p>The average score is now displayed.</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">VisualWorld</span></code> has a new method called <code class="docutils literal notranslate"><span class="pre">reload_visuals</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">show_evolution.py</span></code> is a new script plotting various data about the Walkers population’s evolution during
genetic optimization.</p></li>
<li><p>In <code class="docutils literal notranslate"><span class="pre">docs/examples/strider.py</span></code> we recommend to use <code class="docutils literal notranslate"><span class="pre">total_distance</span></code> as the fitness function.</p></li>
</ul>
</section>
<section id="changed">
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Genetic optimization:</p>
<ul>
<li><p>During genetic optimization, population is now stable at max_pop (it used to fluctuate a lot).</p></li>
<li><p>Genetic optimization do no longer display all dimensions in the progress bar.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">startnstop</span></code> argument may now be the name of the file to use (a string).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">max_genetic_distance</span></code> was changed from 0.7 to 10. Results are much better now!</p></li>
</ul>
</li>
<li><p>Visuals:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">update</span></code> method of <code class="docutils literal notranslate"><span class="pre">VisualWorld</span></code> replaced by <code class="docutils literal notranslate"><span class="pre">visual_update</span></code>. It clearly separates physics and display time.</p></li>
<li><p>Frame rate and physics speed are now independent parameters.</p></li>
<li><p>Visuals go to a new file <code class="docutils literal notranslate"><span class="pre">worldvisualizer.py</span></code>.</p></li>
<li><p>Camera parameters should now be accessed from <code class="docutils literal notranslate"><span class="pre">CAMERA</span></code> instead of <code class="docutils literal notranslate"><span class="pre">params[&quot;camera&quot;]</span></code>.</p></li>
<li><p>The camera feels more cinematic.</p></li>
</ul>
</li>
<li><p>You can define a custom load when using <code class="docutils literal notranslate"><span class="pre">World.add_linkage</span></code> or <code class="docutils literal notranslate"><span class="pre">VisualWorld.add_linkage</span></code>. The default is 0.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> updated with the data of <code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code>. This is now the recommended metadata for the project.</p></li>
<li><p>In <code class="docutils literal notranslate"><span class="pre">docs/example/strider.py</span></code>, simulation time was increased from 30 seconds to 40. It was just not enough.</p></li>
</ul>
</section>
<section id="fixed">
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Documentation of <code class="docutils literal notranslate"><span class="pre">evolutionary_optimization_builtin</span></code> was wrong: returned data were in order (fitness, dimensions, position),
but (fitness, position, dimensions) was indicated.</p></li>
<li><p>After a genetic optimization, the example script was assigning wrong data to the demo walker.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">kwargs_switcher</span></code> from <code class="docutils literal notranslate"><span class="pre">geneticoptimizer.py</span></code> do no longer pop (destroy) argument from the input dictionary.</p></li>
</ul>
</section>
<section id="deprecated">
<h3>Deprecated<a class="headerlink" href="#deprecated" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code> should no longer be used, as it is replaced by <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>.</p></li>
</ul>
</section>
<section id="removed">
<h3>Removed<a class="headerlink" href="#removed" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">evolutionary_optimization</span></code> function is removed. Use <code class="docutils literal notranslate"><span class="pre">GeneticOptimization</span></code> class instead.</p>
<ul>
<li><p>You can no longer use the argument “init_pop” to change the size of the initial population.
It now always set to max_pop.</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">time_coef</span></code>, <code class="docutils literal notranslate"><span class="pre">calc_rate</span></code> and <code class="docutils literal notranslate"><span class="pre">max_sub</span></code> parameters of <code class="docutils literal notranslate"><span class="pre">params[&quot;simul&quot;]</span></code> replaced by a unique
<code class="docutils literal notranslate"><span class="pre">physics_period</span></code> set to 0.02 (s).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">leggedsnake/Population</span> <span class="pre">evolution.json</span></code> removed.
It contained data about an evolution run and is not relevant for users.</p></li>
</ul>
</section>
</section>
<section id="id1">
<h2>[0.3.1] - 2023-06-14<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<p>Starting from 0.3.1, we won’t include “-alpha” or “-beta” in the naming scheme,
Expand Down

0 comments on commit 713c8a7

Please sign in to comment.