Files
Gymnasium/docs/index.md

120 lines
2.4 KiB
Markdown
Raw Normal View History

2022-09-13 20:27:34 +01:00
---
hide-toc: true
firstpage:
lastpage:
---
<center>
<div class="logo">
<img src="_static/img/gymnasium-text.png" width="65%" alt="Gymnasium Logo">
</div>
</center>
2022-09-13 20:27:34 +01:00
<div class="header-text">
<h2>An API standard for reinforcement learning with a diverse collection of reference environments</h2>
</div>
```{figure} _static/videos/box2d/lunar_lander.gif
:alt: Lunar Lander
:width: 500
```
2022-09-13 20:27:34 +01:00
**Gymnasium is a maintained fork of OpenAIs Gym library.** The Gymnasium interface is simple, pythonic, and capable of representing general RL problems, and has a [compatibility wrapper](content/gym_compatibility) for old Gym environments:
2022-09-13 20:27:34 +01:00
```{code-block} python
import gymnasium as gym
env = gym.make("LunarLander-v2", render_mode="human")
observation, info = env.reset(seed=42)
for _ in range(1000):
action = env.action_space.sample() # this is where you would insert your policy
observation, reward, terminated, truncated, info = env.step(action)
if terminated or truncated:
observation, info = env.reset()
2022-09-13 20:27:34 +01:00
env.close()
2022-10-03 19:01:14 +01:00
```
2022-09-13 20:27:34 +01:00
<style>
h2 {
padding-top: 0;
padding-bottom: 20px;
font-size: 28px;
margin: 0;
overflow: auto;
}
img{
vertical-align:bottom;
padding-bottom: 0;
padding-top: 0
}
.logo{
padding-left: 8%;
padding-top: 10px
}
@media (min-width: 455px) {
.header-text{
text-align: center;
}
}
@media (max-width: 455px) {
.header-text{
text-align: left;
}
}
</style>
2022-09-13 20:27:34 +01:00
```{toctree}
:hidden:
:caption: Introduction
content/basic_usage
2022-10-12 15:58:28 +01:00
content/gym_compatibility
content/migration-guide
2022-09-13 20:27:34 +01:00
```
```{toctree}
:hidden:
:caption: API
api/env
api/registry
2022-09-13 20:27:34 +01:00
api/spaces
api/wrappers
api/vector
api/utils
api/experimental
2022-09-13 20:27:34 +01:00
```
```{toctree}
:hidden:
:caption: Environments
2022-10-03 19:01:14 +01:00
environments/classic_control
environments/box2d
environments/toy_text
environments/mujoco
environments/atari
2022-10-03 19:01:14 +01:00
environments/third_party_environments
2022-09-13 20:27:34 +01:00
```
```{toctree}
:hidden:
:glob:
2022-09-13 20:27:34 +01:00
:caption: Tutorials
2023-01-11 14:00:51 -06:00
tutorials/**/index
2023-02-01 22:30:49 +00:00
Comet Tutorial <https://www.comet.com/docs/v2/integrations/ml-frameworks/gymnasium/?utm_source=gymnasium&utm_medium=partner&utm_campaign=partner_gymnasium_2023&utm_content=docs_gymnasium>
2022-09-13 20:27:34 +01:00
```
```{toctree}
:hidden:
:caption: Development
Github <https://github.com/Farama-Foundation/Gymnasium>
gymnasium_release_notes/index
gym_release_notes/index
2022-10-25 11:38:43 +01:00
Contribute to the Docs <https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md>
2022-09-13 20:27:34 +01:00
```