Gymnasium README

The project's README from github.com/Farama-Foundation/Gymnasium. As one markdown file: README.md.

Python PyPI arXiv pre-commit License Code style: black

Gymnasium 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. This is a fork of OpenAI's Gym library by its maintainers (OpenAI handed over maintenance a few years ago to an outside team), and is where future maintenance will occur going forward.

The documentation website is at gymnasium.farama.org, and we have a public discord server (which we also use to coordinate development work) that you can join here: https://discord.gg/bnJ6kubTg6

Environments

Gymnasium includes the following families of environments along with a wide variety of third-party environments

Installation

To install the base Gymnasium library, use pip install gymnasium

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 "gymnasium[atari]" or use pip install "gymnasium[all]" to install all dependencies.

API

The Gymnasium 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 gymnasium as gym
env = gym.make("CartPole-v1")

observation, info = env.reset(seed=42)
for _ in range(1000):
    action = env.action_space.sample()
    observation, reward, terminated, truncated, info = env.step(action)

    if terminated or truncated:
        observation, info = env.reset()
env.close()

Please note that this is an incomplete list, and just includes libraries that the maintainers most commonly point newcomers to when asked for recommendations.

Environment Versioning

Gymnasium 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. These were inherited from Gym.

Contributing

We welcome contributions from the community! Please see our CONTRIBUTING.md for details on how to get started.

Support Gymnasium's Development

If you are financially able to do so and would like to support the development of Gymnasium, please join others in the community in donating to us.

Citation

You can cite Gymnasium using our related paper (https://arxiv.org/abs/2407.17032) as:

@article{towers2024gymnasium,
  title={Gymnasium: A Standard Interface for Reinforcement Learning Environments},
  author={Towers, Mark and Kwiatkowski, Ariel and Terry, Jordan and Balis, John U and De Cola, Gianluca and Deleu, Tristan and Goul{\~a}o, Manuel and Kallinteris, Andreas and Krimmel, Markus and KG, Arjun and others},
  journal={arXiv preprint arXiv:2407.17032},
  year={2024}
}

Gymnasium (Farama-Foundation/Gymnasium)

Searching Database…

12.7K ·GitHub
Что это такое?Gymnasium — это библиотека Python с открытым исходным кодом, которая предоставляет стандартный API для сред обучения с подкреплением с одним агентом, а также набор популярных эталонных сред. Это поддерживаемый форк OpenAI Gym: разработка продолжилась после того, как OpenAI передала проект.
Это фреймворк или просто набор готовых сред?И то, и другое: стандартный API (классы сред на Python с методами reset/step), который может использовать любой алгоритм RL, плюс коллекция готовых эталонных сред, таких как Classic Control, Box2D, MuJoCo и Atari.
Как установить и начать использовать среду?Установите базовую библиотеку командой 'pip install gymnasium', затем создайте экземпляр среды и взаимодействуйте с ним, например со средой 'CartPole-v1'.
Нужны ли дополнительные пакеты для отдельных семейств сред, например Atari или MuJoCo?Да, базовая установка не включает зависимости всех семейств сред: дополнительные пакеты ставятся отдельно для каждого семейства, например 'pip install "gymnasium[atari]"', или 'pip install "gymnasium[all]"' для всего сразу.
Будет ли старый код, написанный для сред Gym, работать здесь без изменений?Не обязательно: среды строго версионируются суффиксами вроде '-v0', а сторонние среды могут быть рассчитаны на более старую версию API, поэтому может понадобиться 'applyenvcompatibility' в gymnasium.make, чтобы обеспечить совместимость.
Какие семейства сред входят в состав по умолчанию?Classic Control, Box2D, Toy Text, MuJoCo и Atari, а также множество совместимых сторонних сред.
Зачем нужно версионирование сред?Gymnasium строго версионирует среды (например, '-v0', '-v1'), поэтому любое изменение, влияющее на результаты обучения, приводит к новой версии. Это обеспечивает воспроизводимость результатов и исключает незаметные изменения в поведении.
Есть ли связанные библиотеки, построенные на основе Gymnasium?CleanRL предлагает эталонные реализации алгоритмов RL с использованием API Gymnasium, а PettingZoo расширяет тот же принцип API на среды с несколькими агентами.
Зачем это создали, вместо того чтобы просто использовать OpenAI Gym?Несколько лет назад OpenAI передала поддержку Gym внешней команде. Gymnasium — форк этой команды, где теперь ведётся вся дальнейшая разработка и поддержка.
Size
444.5 MB
Stars
12.7K
Age
4y
Commits · 90 Days