Skip to content

Commit f68cf8a

Browse files
authored
Update README.md
1 parent c5c0afd commit f68cf8a

File tree

1 file changed

+10
-28
lines changed

1 file changed

+10
-28
lines changed

README.md

+10-28
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
22

3-
## Important notice
4-
5-
### Due to issues with the domain registration, the documentation has been moved to [https://www.gymlibrary.dev/](https://www.gymlibrary.dev/) as opposed to the old .ml address.
6-
73
## Gymnasium
84

9-
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. Since its release, Gym's API has become the field standard for doing this.
10-
11-
Gym documentation website is at [https://www.gymlibrary.dev/](https://www.gymlibrary.dev/), and you can propose fixes and changes to it [here](https://github.com/Farama-Foundation/gym-docs).
5+
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 the maintainers, and is where future maintenance will occur going forward
126

13-
Gym also has a discord server for development purposes that you can join here: https://discord.gg/nHg2JRN489
7+
Gym documentation website is at [gymnasium.farama.org](https://gymnasium.farama.org), and a discord server you can join (which we use to coordinate development work) here: https://discord.gg/nHg2JRN489
148

159
## Installation
1610

17-
To install the base Gym library, use `pip install gym`.
11+
To install the base Gymnasium library, use `pip install gymnasium`.
1812

19-
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.
13+
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 gym[all]` to install all dependencies.
2014

21-
We support Python 3.7, 3.8, 3.9 and 3.10 on Linux and macOS. We will accept PRs related to Windows, but do not officially support it.
15+
We support and test for Python 3.7, 3.8, 3.9 and 3.10 on Linux and macOS. We will accept PRs related to Windows, but do not officially support it.
2216

2317
## API
2418

25-
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:
19+
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:
2620

2721
```python
2822
import gymnasium as gym
@@ -44,29 +38,17 @@ env.close()
4438
* [RL Baselines3 Zoo](https://github.com/DLR-RM/rl-baselines3-zoo) builds upon SB3, containing optimal hyperparameters for Gym environments as well as code to easily find new ones.
4539
* [Tianshou](https://github.com/thu-ml/tianshou) is a learning library that's geared towards very experienced users and is design to allow for ease in complex algorithm modifications.
4640
* [RLlib](https://docs.ray.io/en/latest/rllib/index.html) is a learning library that allows for distributed training and inference and supports an extraordinarily large number of features throughout the reinforcement learning space.
47-
* [PettingZoo](https://github.com/Farama-Foundation/PettingZoo) is like Gym, but for environments with multiple agents.
41+
* [PettingZoo](https://github.com/Farama-Foundation/PettingZoo) is like Gymnasium, but for environments and an API multiple agents.
4842

4943
## Environment Versioning
5044

51-
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.
45+
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 inherent from Gym.
5246

53-
## MuJoCo Environments
5447

55-
The latest "\_v4" and future versions of the MuJoCo environments will no longer depend on `mujoco-py`. Instead `mujoco` will be the required dependency for future gymnasiumMuJoCo environment versions. Old gymnasiumMuJoCo environment versions that depend on `mujoco-py` will still be kept but unmaintained.
56-
To install the dependencies for the latest gymnasium MuJoCo environments use `pip install gym[mujoco]`. Dependencies for old MuJoCo environments can still be installed by `pip install gym[mujoco_py]`.
48+
## Development Roadmap
5749

58-
## Citation
50+
We have a roadmap for future development work for Gymnasium available here:: https://github.com/Farama-Foundation/Gymnasium/issues/12
5951

60-
A whitepaper from when Gym just came out is available https://arxiv.org/pdf/1606.01540, and can be cited with the following bibtex entry:
61-
62-
```
63-
@misc{1606.01540,
64-
Author = {Greg Brockman and Vicki Cheung and Ludwig Pettersson and Jonas Schneider and John Schulman and Jie Tang and Wojciech Zaremba},
65-
Title = {OpenAI Gym},
66-
Year = {2016},
67-
Eprint = {arXiv:1606.01540},
68-
}
69-
```
7052

7153
## Release Notes
7254

0 commit comments

Comments
 (0)