Need help with gym?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

openai
25.5K Stars 7.3K Forks Other 1.4K Commits 108 Opened issues

Description

A toolkit for developing and comparing reinforcement learning algorithms.

Services available

!
?

Need anything else?

Contributors list

Gym

Gym is an open source Python library for developing and comparing reinforcement learning algorithms by providing a standard API to communicate between learning algorithms and environments, as well as a standard set of environments compliant with that API. Since its release, Gym's API has become the field standard for doing this.

Gym currently has two pieces of documentation: the documentation website and the FAQ. A new and more comprehensive documentation website is in the works.

Installation

To install the base Gym library, use

pip install gym
.

This does not include dependencies for all families of environments (there's a massive number, and some can be problematic to install on certain systems). You can install these dependencies for one family like

pip install gym[atari]
or use
pip install gym[all]
to install all dependencies.

We support Python 3.7, 3.8 and 3.9 on Linux and macOS. We will accept PRs related to Windows, but do not officially support it.

API

The Gym API's API models environments as simple Python

env
classes. Creating environment instances and interacting with them is very simple- here's an example using the "CartPole-v1" environment:
import gym 
env = gym.make('CartPole-v1')

env is created, now we can use it:

for episode in range(10): obs = env.reset() for step in range(50): action = env.action_space.sample() # or given a custom model, action = policy(observation) nobs, reward, done, info = env.step(action)

Notable Related Libraries

  • Stable Baselines 3 is a learning library based on the Gym API. It is our recommendation for beginners who want to start learning things quickly.
  • RL Baselines3 Zoo builds upon SB3, containing optimal hyperparameters for Gym environments as well as code to easily find new ones. Such tuning is almost always required.
  • The Autonomous Learning Library and Tianshou are two reinforcement learning libraries I like that are generally geared towards more experienced users.
  • PettingZoo is like Gym, but for environments with multiple agents.

Environment Versioning

Gym keeps strict versioning for reproducibility reasons. All environments end in a suffix like "_v0". When changes are made to environments that might impact learning results, the number is increased by one to prevent potential confusion.

Citation

A whitepaper from when OpenAI Gym just came out is available https://arxiv.org/pdf/1606.01540, and can be cited with the following bibtex entry:

@misc{1606.01540,
  Author = {Greg Brockman and Vicki Cheung and Ludwig Pettersson and Jonas Schneider and John Schulman and Jie Tang and Wojciech Zaremba},
  Title = {OpenAI Gym},
  Year = {2016},
  Eprint = {arXiv:1606.01540},
}

Release Notes

There used to be release notes for all the new Gym versions here. New release notes are being moved to releases page on GitHub, like most other libraries do. Old notes can be viewed here.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.