Gymnasium  by Farama-Foundation

Python API standard for single-agent reinforcement learning environments

created 2 years ago
9,759 stars

Top 5.2% on sourcepulse

GitHubView on GitHub
Project Summary

Gymnasium provides a standardized API for single-agent reinforcement learning environments, serving as a successor to OpenAI's Gym. It offers a comprehensive suite of reference environments and utilities, enabling consistent development and comparison of RL algorithms for researchers and practitioners.

How It Works

Gymnasium models environments as Python classes, abstracting the interaction loop into simple reset() and step() methods. This design promotes interoperability between diverse RL algorithms and environments, facilitating reproducible research and easier algorithm benchmarking. The library enforces strict environment versioning (e.g., "-v0") to ensure reproducibility.

Quick Start & Requirements

  • Install base library: pip install gymnasium
  • Install environment dependencies: pip install "gymnasium[atari]" or pip install "gymnasium[all]"
  • Supported Python versions: 3.8-3.12 on Linux and macOS. Windows support is accepted via PRs but not officially tested.
  • Documentation: https://gymnasium.farama.org/
  • Discord: https://discord.gg/bnJ6kubTg6

Highlighted Details

  • Includes diverse environment families: Classic Control, Box2D, Toy Text, MuJoCo, and Atari.
  • Strict environment versioning for reproducibility.
  • Integrates with related libraries like CleanRL and PettingZoo.
  • Offers a citation for academic use.

Maintenance & Community

Maintained by the Farama Foundation, the project actively coordinates development on Discord. Financial contributions are welcomed to support ongoing development.

Licensing & Compatibility

The library is released under the Apache 2.0 license, permitting commercial use and integration with closed-source projects.

Limitations & Caveats

While Gymnasium supports Linux and macOS, official support for Windows is limited to PR acceptance. Some environment dependencies may be challenging to install on certain systems.

Health Check
Last commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
7
Issues (30d)
4
Star History
770 stars in the last 90 days

Explore Similar Projects

Starred by Chip Huyen Chip Huyen(Author of AI Engineering, Designing Machine Learning Systems), Thomas Wolf Thomas Wolf(Cofounder of Hugging Face), and
1 more.

stable-baselines3 by DLR-RM

0.5%
11k
PyTorch library for reinforcement learning algorithm implementations
created 5 years ago
updated 1 week ago
Feedback? Help us improve.