-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Theresa Eimer: Merge pull request #102 from automl/development
- Loading branch information
Github Actions
committed
Aug 9, 2023
1 parent
f8303f4
commit 4a40c5b
Showing
190 changed files
with
36,288 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+14.9 KB
main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_acrobot.doctree
Binary file not shown.
Binary file added
BIN
+14.9 KB
main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_cartpole.doctree
Binary file not shown.
Binary file added
BIN
+15.1 KB
main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincar.doctree
Binary file not shown.
Binary file added
BIN
+15.7 KB
main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_mountaincarcontinuous.doctree
Binary file not shown.
Binary file added
BIN
+14.9 KB
main/.doctrees/api/carl.envs.gymnasium.classic_control.carl_pendulum.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+33.7 KB
main/.doctrees/source/environments/environment_families/box2d.doctree
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+41.6 KB
main/.doctrees/source/environments/environment_families/classic_control.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+7.49 KB
main/.doctrees/source/environments/environment_families/toad_gan.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 — 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">-></span> <span class="nb">bool</span><span class="p">:</span> | ||
<span class="w"> </span><span class="sd">"""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"> """</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">"once"</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">"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."</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">"Box2D"</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">"brax"</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">"py4j"</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">"dm_control"</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">"distance"</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"> | ||
© 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> |
Oops, something went wrong.