Skip to content

Commit

Permalink
remove instructions for adding new environments to gym (openai#1458)
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherhesse authored Apr 29, 2019
1 parent d638d5e commit 86f21ad
Showing 1 changed file with 0 additions and 24 deletions.
24 changes: 0 additions & 24 deletions docs/creating-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,27 +70,3 @@
```

* After you have installed your package with `pip install -e gym-foo`, you can create an instance of the environment with `gym.make('gym_foo:foo-v0')`

## How to add new environments to Gym, within this repo (not recommended for new environments)

1. Write your environment in an existing collection or a new collection. All collections are subfolders of `/gym/envs`.
2. Import your environment into the `__init__.py` file of the collection. This file will be located at `/gym/envs/my_collection/__init__.py`. Add `from gym.envs.my_collection.my_awesome_env import MyEnv` to this file.
3. Register your env in `/gym/envs/__init__.py`:

```
register(
id='MyEnv-v0',
entry_point='gym.envs.my_collection:MyEnv',
)
```

4. Add your environment to the scoreboard in `/gym/scoreboard/__init__.py`:

```
add_task(
id='MyEnv-v0',
summary="Super cool environment",
group='my_collection',
contributor='mygithubhandle',
)
```

0 comments on commit 86f21ad

Please sign in to comment.