Theresa Eimer: Merge pull request #102 from automl/development

automl · Aug 9, 2023 · 4a40c5b · 4a40c5b
1 parent f8303f4
commit 4a40c5b
Show file tree

Hide file tree

Showing 190 changed files with 36,288 additions and 0 deletions.
diff --git a/main/.buildinfo b/main/.buildinfo
@@ -0,0 +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: 1c187739092ee7b3f19e2b93d9e6e9f2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/.doctrees/api.doctree b/main/.doctrees/api.doctree
diff --git a/main/.doctrees/api/carl.envs.carl_env.doctree b/main/.doctrees/api/carl.envs.carl_env.doctree
diff --git a/main/.doctrees/api/carl.envs.doctree b/main/.doctrees/api/carl.envs.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.carl_gymnasium_env.doctree b/main/.doctrees/api/carl.envs.gymnasium.carl_gymnasium_env.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_acrobot.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_acrobot.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_cartpole.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_cartpole.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincar.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincar.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincarcontinuous.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincarcontinuous.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_pendulum.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_pendulum.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.classic_control.doctree b/main/.doctrees/api/carl.envs.gymnasium.classic_control.doctree
diff --git a/main/.doctrees/api/carl.envs.gymnasium.doctree b/main/.doctrees/api/carl.envs.gymnasium.doctree
diff --git a/main/.doctrees/api/carl.envs.mario.doctree b/main/.doctrees/api/carl.envs.mario.doctree
diff --git a/main/.doctrees/api/carl.envs.mario.level_image_gen.doctree b/main/.doctrees/api/carl.envs.mario.level_image_gen.doctree
diff --git a/main/.doctrees/api/carl.envs.mario.mario_game.doctree b/main/.doctrees/api/carl.envs.mario.mario_game.doctree
diff --git a/main/.doctrees/api/carl.envs.mario.models.doctree b/main/.doctrees/api/carl.envs.mario.models.doctree
diff --git a/main/.doctrees/api/carl.envs.mario.reachabillity.doctree b/main/.doctrees/api/carl.envs.mario.reachabillity.doctree
diff --git a/main/.doctrees/api/carl.envs.rna.carl_rna_definitions.doctree b/main/.doctrees/api/carl.envs.rna.carl_rna_definitions.doctree
diff --git a/main/.doctrees/api/carl.envs.rna.doctree b/main/.doctrees/api/carl.envs.rna.doctree
diff --git a/main/.doctrees/api/carl.envs.rna.parse_dot_brackets.doctree b/main/.doctrees/api/carl.envs.rna.parse_dot_brackets.doctree
diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
diff --git a/main/.doctrees/source/api/autoapi_link.doctree b/main/.doctrees/source/api/autoapi_link.doctree
diff --git a/main/.doctrees/source/api/index.doctree b/main/.doctrees/source/api/index.doctree
diff --git a/main/.doctrees/source/cite.doctree b/main/.doctrees/source/cite.doctree
diff --git a/main/.doctrees/source/environments/benchmark_properties.doctree b/main/.doctrees/source/environments/benchmark_properties.doctree
diff --git a/main/.doctrees/source/environments/carl_env.doctree b/main/.doctrees/source/environments/carl_env.doctree
diff --git a/main/.doctrees/source/environments/carlify.doctree b/main/.doctrees/source/environments/carlify.doctree
diff --git a/main/.doctrees/source/environments/environment_families/box2d.doctree b/main/.doctrees/source/environments/environment_families/box2d.doctree
diff --git a/main/.doctrees/source/environments/environment_families/brax.doctree b/main/.doctrees/source/environments/environment_families/brax.doctree
diff --git a/main/.doctrees/source/environments/environment_families/classic_control.doctree b/main/.doctrees/source/environments/environment_families/classic_control.doctree
diff --git a/main/.doctrees/source/environments/environment_families/dmc.doctree b/main/.doctrees/source/environments/environment_families/dmc.doctree
diff --git a/main/.doctrees/source/environments/environment_families/index.doctree b/main/.doctrees/source/environments/environment_families/index.doctree
diff --git a/main/.doctrees/source/environments/environment_families/rna.doctree b/main/.doctrees/source/environments/environment_families/rna.doctree
diff --git a/main/.doctrees/source/environments/environment_families/toad_gan.doctree b/main/.doctrees/source/environments/environment_families/toad_gan.doctree
diff --git a/main/.doctrees/source/environments/index.doctree b/main/.doctrees/source/environments/index.doctree
diff --git a/main/.doctrees/source/getting_started/index.doctree b/main/.doctrees/source/getting_started/index.doctree
diff --git a/main/.doctrees/source/getting_started/installation.doctree b/main/.doctrees/source/getting_started/installation.doctree
diff --git a/main/.doctrees/source/getting_started/quickstart.doctree b/main/.doctrees/source/getting_started/quickstart.doctree
diff --git a/main/.doctrees/source/license.doctree b/main/.doctrees/source/license.doctree
diff --git a/main/.doctrees/source/references.doctree b/main/.doctrees/source/references.doctree
diff --git a/main/_images/acrobot.jpeg b/main/_images/acrobot.jpeg
diff --git a/main/_images/ant.png b/main/_images/ant.png
diff --git a/main/_images/bipedalwalker.jpeg b/main/_images/bipedalwalker.jpeg
diff --git a/main/_images/cartpole.jpeg b/main/_images/cartpole.jpeg
diff --git a/main/_images/envs_overview.png b/main/_images/envs_overview.png
diff --git a/main/_images/fetch.png b/main/_images/fetch.png
diff --git a/main/_images/finger.jpg b/main/_images/finger.jpg
diff --git a/main/_images/fish.jpg b/main/_images/fish.jpg
diff --git a/main/_images/grasp.png b/main/_images/grasp.png
diff --git a/main/_images/halfcheetah.png b/main/_images/halfcheetah.png
diff --git a/main/_images/humanoid.png b/main/_images/humanoid.png
diff --git a/main/_images/learna.png b/main/_images/learna.png
diff --git a/main/_images/lunarlander.jpeg b/main/_images/lunarlander.jpeg
diff --git a/main/_images/mountaincar.jpeg b/main/_images/mountaincar.jpeg
diff --git a/main/_images/pendulum.jpeg b/main/_images/pendulum.jpeg
diff --git a/main/_images/quadruped.jpg b/main/_images/quadruped.jpg
diff --git a/main/_images/radar_env_space.png b/main/_images/radar_env_space.png
diff --git a/main/_images/supermario.png b/main/_images/supermario.png
diff --git a/main/_images/ur5e.png b/main/_images/ur5e.png
diff --git a/main/_images/vehicleracing.png b/main/_images/vehicleracing.png
diff --git a/main/_images/walker.jpg b/main/_images/walker.jpg
diff --git a/main/_modules/carl/envs.html b/main/_modules/carl/envs.html
@@ -0,0 +1,355 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>carl.envs &#8212; CARL Documentation 1.0.0 documentation</title>
+
+  <link href="../../_static/css/theme.css" rel="stylesheet">
+  <link href="../../_static/css/index.ac9c05f7c49ca1e1f876c6e36360ea26.css" rel="stylesheet">
+
+
+  <link rel="stylesheet"
+    href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
+  <link rel="preload" as="font" type="font/woff2" crossorigin
+    href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
+  <link rel="preload" as="font" type="font/woff2" crossorigin
+    href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
+
+
+
+
+
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css?v=2eb4fb78" />
+
+  <link rel="preload" as="script" href="../../_static/js/index.9ea38e314b9e6d9dab77.js">
+
+    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=367f7090"></script>
+    <script src="../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="docsearch:language" content="en">
+
+
+    <!-- Google Analytics -->
+
+  </head>
+  <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
+
+    <div class="container-fluid" id="banner"></div>
+
+
+    <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
+
+  <div id="navbar-start">
+
+
+  <a class="navbar-brand" href="../../index.html">
+  <!-- <p class="title">CARL Documentation</p> -->
+  </a>
+
+
+  </div>
+
+  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
+    <span class="navbar-toggler-icon"></span>
+  </button>
+
+
+  <div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
+    <div id="navbar-center" class="mr-auto">
+
+    </div>
+
+    <div id="navbar-end">
+
+      <div class="navbar-end-item">
+        <ul id="navbar-icon-links" class="navbar-nav" aria-label="">
+        <li class="nav-item">
+          <a class="nav-link" href="https://github.com/automl/automl_sphinx_theme" rel="noopener" target="_blank" title="GitHub">
+            <span><i class="fab fa-github-square"></i></span>
+            <label class="sr-only">GitHub</label>
+          </a>
+        </li>
+        <li class="nav-item">
+          <a class="nav-link" href="https://twitter.com/automl_org?lang=de" rel="noopener" target="_blank" title="Twitter">
+            <span><i class="fab fa-twitter-square"></i></span>
+            <label class="sr-only">Twitter</label>
+          </a>
+        </li>
+      </ul>
+      </div>
+
+      <div class="navbar-end-item">
+        <div class="dropdown mt-1">
+    <button type="button" class="btn btn-secondary btn-md navbar-btn dropdown-toggle" id="dLabelMore"
+        data-toggle="dropdown">
+        v1.0.0
+        <span class="caret"></span>
+    </button>
+    <div class="dropdown-menu list-group-flush py-0" aria-labelledby="dLabelMore">
+        <a class="list-group-item list-group-item-action" href="#">v1.0.0 (stable)</a>
+    </div>
+</div>
+      </div>
+
+      <div class="navbar-end-item">
+        <form class="bd-search align-items-center" action="../../search.html" method="get" style="width: 100%;">
+  <i class="icon fas fa-search"></i>
+  <input type="search" class="form-control btn btn-md" name="q" id="search-input"
+    placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off">
+</form>
+      </div>
+
+    </div>
+  </div>
+</div>
+    </nav>
+
+
+    <div class="container-xl">
+      <div class="row">
+
+
+            <!-- Only show if we have sidebars configured, else just a small margin  -->
+            <div class="col-12 col-md-3 bd-sidebar"><h4 class="mt-0 mb-0"><a href="../../index.html">CARL Documentation</a></h4>
+<div class="mb-3">v1.0.0</div><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
+  <div class="bd-toc-item active">
+    <ul class="nav bd-sidenav">
+ <li class="toctree-l1 has-children">
+  <a class="reference internal" href="../../source/getting_started/index.html">
+   Getting Started
+  </a>
+  <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
+  <label for="toctree-checkbox-1">
+   <i class="fas fa-chevron-down">
+   </i>
+  </label>
+  <ul>
+   <li class="toctree-l2">
+    <a class="reference internal" href="../../source/getting_started/installation.html">
+     Installing CARL
+    </a>
+   </li>
+   <li class="toctree-l2">
+    <a class="reference internal" href="../../source/getting_started/quickstart.html">
+     Quickstart
+    </a>
+   </li>
+  </ul>
+ </li>
+ <li class="toctree-l1 has-children">
+  <a class="reference internal" href="../../source/environments/index.html">
+   Environments
+  </a>
+  <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
+  <label for="toctree-checkbox-2">
+   <i class="fas fa-chevron-down">
+   </i>
+  </label>
+  <ul>
+   <li class="toctree-l2">
+    <a class="reference internal" href="../../source/environments/carl_env.html">
+     The CARL Environment
+    </a>
+   </li>
+   <li class="toctree-l2 has-children">
+    <a class="reference internal" href="../../source/environments/environment_families/index.html">
+     Environment Families
+    </a>
+    <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
+    <label for="toctree-checkbox-3">
+     <i class="fas fa-chevron-down">
+     </i>
+    </label>
+    <ul>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/classic_control.html">
+       CARL Classic Control Environments
+      </a>
+     </li>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/box2d.html">
+       CARL Box 2D Environments
+      </a>
+     </li>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/brax.html">
+       CARL Brax Environments
+      </a>
+     </li>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/dmc.html">
+       CARL DMC Environments
+      </a>
+     </li>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/toad_gan.html">
+       CARL Mario Environment
+      </a>
+     </li>
+     <li class="toctree-l3">
+      <a class="reference internal" href="../../source/environments/environment_families/rna.html">
+       CARL RNA Design Environment
+      </a>
+     </li>
+    </ul>
+   </li>
+   <li class="toctree-l2">
+    <a class="reference internal" href="../../source/environments/benchmark_properties.html">
+     Benchmark Properties
+    </a>
+   </li>
+   <li class="toctree-l2">
+    <a class="reference internal" href="../../source/environments/carlify.html">
+     CARLify your Environment
+    </a>
+   </li>
+  </ul>
+ </li>
+ <li class="toctree-l1 has-children">
+  <a class="reference internal" href="../../source/api/index.html">
+   API Reference
+  </a>
+  <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/>
+  <label for="toctree-checkbox-4">
+   <i class="fas fa-chevron-down">
+   </i>
+  </label>
+  <ul class="simple">
+  </ul>
+ </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../../source/cite.html">
+   Citing CARL
+  </a>
+ </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../../source/license.html">
+   License
+  </a>
+ </li>
+ <li class="toctree-l1">
+  <a class="reference internal" href="../../source/references.html">
+   References
+  </a>
+ </li>
+</ul>
+
+  </div>
+</nav>
+            </div>
+
+
+
+
+          <div class="d-none d-xl-block col-xl-2 bd-toc">
+
+          </div>
+
+
+
+
+
+
+          <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
+
+              <div>
+
+  <h1>Source code for carl.envs</h1><div class="highlight"><pre>
+<span></span><span class="c1"># flake8: noqa: F401</span>
+<span class="c1"># Modular imports</span>
+<span class="kn">import</span> <span class="nn">importlib.util</span> <span class="k">as</span> <span class="nn">iutil</span>
+<span class="kn">import</span> <span class="nn">warnings</span>
+
+<span class="c1"># Classic control is in gym and thus necessary for the base version to run</span>
+<span class="kn">from</span> <span class="nn">carl.envs.gymnasium</span> <span class="kn">import</span> <span class="o">*</span>
+
+
+<div class="viewcode-block" id="check_spec"><a class="viewcode-back" href="../../api/carl.envs.html#carl.envs.check_spec">[docs]</a><span class="k">def</span> <span class="nf">check_spec</span><span class="p">(</span><span class="n">spec_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Check if the spec is installed</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    spec_name : str</span>
+<span class="sd">        Name of package that is necessary for the environment suite.</span>
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    bool</span>
+<span class="sd">        Whether the spec was found.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">spec</span> <span class="o">=</span> <span class="n">iutil</span><span class="o">.</span><span class="n">find_spec</span><span class="p">(</span><span class="n">spec_name</span><span class="p">)</span>
+    <span class="n">found</span> <span class="o">=</span> <span class="n">spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
+        <span class="k">with</span> <span class="n">warnings</span><span class="o">.</span><span class="n">catch_warnings</span><span class="p">():</span>
+            <span class="n">warnings</span><span class="o">.</span><span class="n">simplefilter</span><span class="p">(</span><span class="s2">&quot;once&quot;</span><span class="p">)</span>
+            <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
+                <span class="sa">f</span><span class="s2">&quot;Module </span><span class="si">{</span><span class="n">spec_name</span><span class="si">}</span><span class="s2"> not found. If you want to use these environments, please follow the installation guide.&quot;</span>
+            <span class="p">)</span>
+    <span class="k">return</span> <span class="n">found</span></div>
+
+
+<span class="c1"># Environment loading</span>
+<span class="n">found</span> <span class="o">=</span> <span class="n">check_spec</span><span class="p">(</span><span class="s2">&quot;Box2D&quot;</span><span class="p">)</span>
+<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">carl.envs.gymnasium.box2d</span> <span class="kn">import</span> <span class="o">*</span>
+
+<span class="n">found</span> <span class="o">=</span> <span class="n">check_spec</span><span class="p">(</span><span class="s2">&quot;brax&quot;</span><span class="p">)</span>
+<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">carl.envs.brax</span> <span class="kn">import</span> <span class="o">*</span>
+
+<span class="n">found</span> <span class="o">=</span> <span class="n">check_spec</span><span class="p">(</span><span class="s2">&quot;py4j&quot;</span><span class="p">)</span>
+<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">carl.envs.mario</span> <span class="kn">import</span> <span class="o">*</span>
+
+<span class="n">found</span> <span class="o">=</span> <span class="n">check_spec</span><span class="p">(</span><span class="s2">&quot;dm_control&quot;</span><span class="p">)</span>
+<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">carl.envs.dmc</span> <span class="kn">import</span> <span class="o">*</span>
+
+<span class="n">found</span> <span class="o">=</span> <span class="n">check_spec</span><span class="p">(</span><span class="s2">&quot;distance&quot;</span><span class="p">)</span>
+<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">carl.envs.rna</span> <span class="kn">import</span> <span class="o">*</span>
+</pre></div>
+
+              </div>
+
+
+              <!-- Previous / next buttons -->
+<div class='prev-next-area'>
+</div>
+
+          </main>
+
+
+      </div>
+    </div>
+
+  <script src="../../_static/js/index.9ea38e314b9e6d9dab77.js"></script>
+<footer class="footer mt-5 mt-md-0">
+  <div class="container">
+
+    <div class="footer-item">
+      <p class="copyright">
+    &copy; Copyright 
+    Copyright 2023, AutoML.org Freiburg-Hannover
+.<br>
+</p>
+    </div>
+
+    <div class="footer-item">
+      <p class="sphinx-version">
+Created using <a href="http://sphinx-doc.org/">Sphinx</a>
+7.1.2. Template is modified version of <a
+href="https://pydata-sphinx-theme.readthedocs.io">PyData Sphinx Theme</a>. <br>
+</p>
+    </div>
+
+  </div>
+</footer>
+  </body>
+</html>