157 lines
7.8 KiB
HTML
157 lines
7.8 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<title>API — Fancy Gym 0.2 documentation</title>
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/style.css" type="text/css" />
|
|||
|
|
<link rel="shortcut icon" href="_static/icon.svg"/>
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/sphinx_highlight.js"></script>
|
|||
|
|
<script src="_static/js/theme.js"></script>
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="fancy_gym.register" href="generated/fancy_gym.register.html" />
|
|||
|
|
<link rel="prev" title="Replanning Example" href="examples/replanning_envs.html" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home">
|
|||
|
|
Fancy Gym
|
|||
|
|
<img src="_static/icon.svg" class="logo" alt="Logo"/>
|
|||
|
|
</a>
|
|||
|
|
<div class="version">
|
|||
|
|
0.2
|
|||
|
|
</div>
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|||
|
|
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="guide/installation.html">Installation</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="guide/episodic_rl.html">What is Episodic RL?</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="guide/basic_usage.html">Basic Usage</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="guide/upgrading_envs.html">Creating new MP Environments</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="envs/fancy/index.html">Fancy</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="envs/dmc.html">DeepMind Control (DMC)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="envs/meta.html">Metaworld</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="envs/open_ai.html">Gymnasium</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/general.html">General Usage Examples</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/dmc.html">DeepMind Control Examples</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/metaworld.html">Metaworld Examples</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/open_ai.html">OpenAI Envs Examples</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/movement_primitives.html">Movement Primitives Examples</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/mp_params_tuning.html">MP Params Tuning Example</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/pd_control_gain_tuning.html">PD Control Gain Tuning Example</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/replanning_envs.html">Replanning Example</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="generated/fancy_gym.register.html">fancy_gym.register</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="generated/fancy_gym.upgrade.html">fancy_gym.upgrade</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">Fancy Gym</a>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
<div role="navigation" aria-label="Page navigation">
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|||
|
|
<li class="breadcrumb-item active">API</li>
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
<a href="https://github.com/ALRhub/fancy_gym/blob/release/docs/source/api.rst" class="fa fa-github"> Edit on GitHub</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<section id="api">
|
|||
|
|
<h1>API<a class="headerlink" href="#api" title="Permalink to this heading"></a></h1>
|
|||
|
|
<table class="autosummary longtable docutils align-default">
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="generated/fancy_gym.register.html#fancy_gym.register" title="fancy_gym.register"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fancy_gym.register</span></code></a>(id[, entry_point, ...])</p></td>
|
|||
|
|
<td><p>Registers a Gymnasium environment, including Movement Primitives (MP) versions.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><a class="reference internal" href="generated/fancy_gym.upgrade.html#fancy_gym.upgrade" title="fancy_gym.upgrade"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fancy_gym.upgrade</span></code></a>(id[, mp_wrapper, ...])</p></td>
|
|||
|
|
<td><p>Upgrades an existing Gymnasium environment to include Movement Primitives (MP) versions.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="examples/replanning_envs.html" class="btn btn-neutral float-left" title="Replanning Example" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
<a href="generated/fancy_gym.register.html" class="btn btn-neutral float-right" title="fancy_gym.register" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>© Copyright 2020-2024, Fabian Otto, Onur Celik, Dominik Roth, Hongyi Zhou.</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
<script>
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|