Final? touches to the docs

This commit is contained in:
Dominik Moritz Roth 2024-01-23 17:42:13 +01:00
parent 6d583a36f4
commit 59c980e495
13 changed files with 12 additions and 12 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -1,7 +1,7 @@
AirHockey
=========
Fancy Gym provides access to a range of environments for the Robot Air Hockey Challenge, facilitating research in robot learning. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.
Fancy Gym provides access to a range of environments for the `Robot Air Hockey Challenge <https://air-hockey-challenge.robot-learning.net/>`_. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.
The environments available through Fancy Gym allow for the development of agents capable of performing tasks with different levels of complexity. These tasks include hitting and defending in air hockey with both three degrees of freedom (3 DoF) and seven degrees of freedom (7 DoF) configurations. The 7 DoF tasks are based on the KUKA iiwa14 robot model, which is used in the simulations to represent a higher level of control complexity akin to real-world settings.

View File

@ -32,7 +32,7 @@ Variations of this environment are available, differing in reward structures and
<img src="../../_static/imgs/env_gifs/Table_Tennis.gif" style="margin: 5%; width: 45%;">
</div>
The table tennis task offers a dynamic and interactive environment designed for the development and testing of reinforcement learning (RL) systems. Using a robotic arm equipped with seven degrees of freedom (DoFs), the challenge is to respond to incoming balls and return them accurately to a specified goal location on the opponent's side of the table.
The table tennis task offers a robotic arm equipped with seven degrees of freedom (DoFs). The task is to respond to incoming balls and return them accurately to a specified goal location on the opponent's side of the table.
The context space for this environment includes the initial ball position, with x-coordinates ranging from -1 to -0.2 meters and y-coordinates from -0.65 to 0.65 meters, and the goal position with x-coordinates between -1.2 to -0.2 meters and y-coordinates from -0.6 to 0.6 meters. The full observation space comprises the sine and cosine values of the joint angles, the joint velocities, and the ball's velocity, providing comprehensive information for the RL system to base its decisions on.
@ -118,4 +118,4 @@ No longer used?
## MP Environments
Many of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.
Most of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.

View File

@ -134,7 +134,7 @@ Explore the MP-based variant (`or learn more about Movement Primitives (MPs) <gu
Citing the Project
------------------
To cite `fancy gym` in publications:
To cite `fancy_gym` in publications:
.. code:: bibtex

View File

@ -113,7 +113,7 @@
<section id="airhockey">
<h1>AirHockey<a class="headerlink" href="#airhockey" title="Permalink to this heading"></a></h1>
<p>Fancy Gym provides access to a range of environments for the Robot Air Hockey Challenge, facilitating research in robot learning. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.</p>
<p>Fancy Gym provides access to a range of environments for the <a class="reference external" href="https://air-hockey-challenge.robot-learning.net/">Robot Air Hockey Challenge</a>. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.</p>
<p>The environments available through Fancy Gym allow for the development of agents capable of performing tasks with different levels of complexity. These tasks include hitting and defending in air hockey with both three degrees of freedom (3 DoF) and seven degrees of freedom (7 DoF) configurations. The 7 DoF tasks are based on the KUKA iiwa14 robot model, which is used in the simulations to represent a higher level of control complexity akin to real-world settings.</p>
<p>Participants in the challenge are required to develop strategies that enable their robots to react and adapt within these dynamic environments. The final phase of the challenge involves a tournament where the developed agents will be tested in a comprehensive game scenario, both in simulation and, for the top teams, on actual robotic systems.</p>
<p>For detailed information on the challenge, including rules, stages, and submission requirements, please visit the <a class="reference external" href="https://air-hockey-challenge.robot-learning.net/">official Robot Air Hockey Challenge website</a>.</p>

View File

@ -172,7 +172,7 @@
<div class='center'>
<img src="../../_static/imgs/env_gifs/Table_Tennis.gif" style="margin: 5%; width: 45%;">
</div>
<p>The table tennis task offers a dynamic and interactive environment designed for the development and testing of reinforcement learning (RL) systems. Using a robotic arm equipped with seven degrees of freedom (DoFs), the challenge is to respond to incoming balls and return them accurately to a specified goal location on the opponents side of the table.</p>
<p>The table tennis task offers a robotic arm equipped with seven degrees of freedom (DoFs). The task is to respond to incoming balls and return them accurately to a specified goal location on the opponents side of the table.</p>
<p>The context space for this environment includes the initial ball position, with x-coordinates ranging from -1 to -0.2 meters and y-coordinates from -0.65 to 0.65 meters, and the goal position with x-coordinates between -1.2 to -0.2 meters and y-coordinates from -0.6 to 0.6 meters. The full observation space comprises the sine and cosine values of the joint angles, the joint velocities, and the balls velocity, providing comprehensive information for the RL system to base its decisions on.</p>
<p>A task is considered successfully completed when the returned ball not only lands on the opponents side of the table but also within a tight margin of 20 centimeters from the goal location. The reward function is designed to reflect various conditions of play, including whether the ball was hit, if it landed on the table, and the proximity of the balls landing position to the goal location.</p>
<p>Variations of the table tennis environment are available to cater to different research needs. These variations maintain the foundational challenge of precise ball return while providing additional complexity for RL algorithms to overcome.</p>
@ -405,7 +405,7 @@ No longer used?
</section>
<section id="mp-environments">
<h2>MP Environments<a class="headerlink" href="#mp-environments" title="Permalink to this heading"></a></h2>
<p>Many of these envs also exist as MP-variants. Refer to them using <code class="docutils literal notranslate"><span class="pre">fancy_DMP/&lt;name&gt;</span></code> <code class="docutils literal notranslate"><span class="pre">fancy_ProMP/&lt;name&gt;</span></code> or <code class="docutils literal notranslate"><span class="pre">fancy_ProDMP/&lt;name&gt;</span></code>.</p>
<p>Most of these envs also exist as MP-variants. Refer to them using <code class="docutils literal notranslate"><span class="pre">fancy_DMP/&lt;name&gt;</span></code> <code class="docutils literal notranslate"><span class="pre">fancy_ProMP/&lt;name&gt;</span></code> or <code class="docutils literal notranslate"><span class="pre">fancy_ProDMP/&lt;name&gt;</span></code>.</p>
</section>
</section>

View File

@ -269,7 +269,7 @@ PRs to integrate these environments into <code class="docutils literal notransla
</section>
<section id="citing-the-project">
<h2>Citing the Project<a class="headerlink" href="#citing-the-project" title="Permalink to this heading"></a></h2>
<p>To cite <cite>fancy gym</cite> in publications:</p>
<p>To cite <cite>fancy_gym</cite> in publications:</p>
<div class="highlight-bibtex notranslate"><div class="highlight"><pre><span></span><span class="nc">@software</span><span class="p">{</span><span class="nl">fancy_gym</span><span class="p">,</span>
<span class="w"> </span><span class="na">title</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Fancy Gym}</span><span class="p">,</span>
<span class="w"> </span><span class="na">author</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Otto, Fabian and Celik, Onur and Roth, Dominik and Zhou, Hongyi}</span><span class="p">,</span>

File diff suppressed because one or more lines are too long

View File

@ -1,7 +1,7 @@
AirHockey
=========
Fancy Gym provides access to a range of environments for the Robot Air Hockey Challenge, facilitating research in robot learning. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.
Fancy Gym provides access to a range of environments for the `Robot Air Hockey Challenge <https://air-hockey-challenge.robot-learning.net/>`_. The challenge aims to close the gap between simulated learning and real-world application by focusing on various aspects of robotic operation, such as dealing with disturbances, observation noise, safety, and actuator limitations.
The environments available through Fancy Gym allow for the development of agents capable of performing tasks with different levels of complexity. These tasks include hitting and defending in air hockey with both three degrees of freedom (3 DoF) and seven degrees of freedom (7 DoF) configurations. The 7 DoF tasks are based on the KUKA iiwa14 robot model, which is used in the simulations to represent a higher level of control complexity akin to real-world settings.

View File

@ -32,7 +32,7 @@ Variations of this environment are available, differing in reward structures and
<img src="../../_static/imgs/env_gifs/Table_Tennis.gif" style="margin: 5%; width: 45%;">
</div>
The table tennis task offers a dynamic and interactive environment designed for the development and testing of reinforcement learning (RL) systems. Using a robotic arm equipped with seven degrees of freedom (DoFs), the challenge is to respond to incoming balls and return them accurately to a specified goal location on the opponent's side of the table.
The table tennis task offers a robotic arm equipped with seven degrees of freedom (DoFs). The task is to respond to incoming balls and return them accurately to a specified goal location on the opponent's side of the table.
The context space for this environment includes the initial ball position, with x-coordinates ranging from -1 to -0.2 meters and y-coordinates from -0.65 to 0.65 meters, and the goal position with x-coordinates between -1.2 to -0.2 meters and y-coordinates from -0.6 to 0.6 meters. The full observation space comprises the sine and cosine values of the joint angles, the joint velocities, and the ball's velocity, providing comprehensive information for the RL system to base its decisions on.
@ -118,4 +118,4 @@ No longer used?
## MP Environments
Many of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.
Most of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.