Skip to content

Commit afc77cf

Browse files
committed
Fix README and environment.yml
1 parent b4c2618 commit afc77cf

2 files changed

Lines changed: 36 additions & 9 deletions

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,31 @@ In the Procgen benchmark, algorithms are trained on a fixed number of level seed
2323
Approaches that help RL performance IID often do not transfer to OOD, even by small distribution shifts. As RL algorithms are inherently learning with non-stationary targets and typically deployed with sim2real transfer, we believe that evaluating OOD is far more valuable to the research community.
2424

2525

26+
<br>
27+
2628
## Installation
2729

30+
The following instructions assume you have `conda` installed.
31+
If you do not have `conda`, you can install it from [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
32+
2833

2934

35+
```bash
36+
cd /path/to/your/clone/of/procgen-ood
37+
conda create -n procgen_ood -f environment.yml
38+
conda activate procgen_ood
39+
pip install -e . # install the package in editable mode
40+
```
3041

42+
Verify the installation by running the following command:
43+
44+
```bash
45+
python -m procgen.interactive --env-name coinrun
46+
```
3147

3248

3349

50+
<br>
3451

3552
## Holdout Types
3653

@@ -61,9 +78,14 @@ The supported holdout types during training and/or evaluation are `all`, `backgr
6178
| | ~~chaser~~ | | | | | |
6279
| | ~~plunder~~ | | | | | |
6380

64-
> [!NOTE] **NOTE:** The behavior of holdout type "all" is **game specific!** Holdout type "all" independently samples all other supported types.
81+
> [!NOTE]
82+
> The behavior of holdout type "all" is **game specific!** Holdout type "all" independently samples all other supported types.
6583
> - E.g., `coinrun` with holdout type "all" will independently sample each of \["background", "agent", "enemy", "platform"\] variables using the accompanying `--[train/eval]-holdout-frac 0.1` argument.
6684
> In contrast, `bigfish` only supports randomizing over "enemy" & "background".
85+
> - As seen in the table above, `chaser` and `plunder` do not support any holdout types.
86+
87+
88+
<br>
6789

6890
## Environment Options
6991

@@ -104,6 +126,7 @@ env = gym.make(
104126
> - If you just want the frames instead of the window, pass `render_mode="rgb_array"`.
105127
106128

129+
<br>
107130

108131
# License
109132

@@ -112,6 +135,9 @@ This project contains two different licenses for different parts of the code:
112135
- The original code, which was forked from [Procgen](https://github.com/openai/procgen/tree/5e1dbf341d291eff40d1f9e0c0a0d5003643aebf), is licensed under the MIT license. You can find the MIT license in the `LICENSE-MIT` file.
113136
- All modifications and additions made by Kevin Corder, Song Park, DEVCOM Army Research Laboratory, and/or Parsons Corporation are licensed under the CC0 1.0 Universal license. See the `LICENSE-CC0` file for details.
114137

138+
139+
<br>
140+
115141
# Citation
116142

117143
To cite this project in your work, please use the following Bibtex:

environment.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@ channels:
22
- conda-forge
33

44
dependencies:
5-
- python=3.7.3
5+
- python=3.7
66
# https://www.anaconda.com/utilizing-the-new-compilers-in-anaconda-distribution-5/
7-
- c-compiler=1.3.0
8-
- cmake=3.21.3
9-
- qt=5.12.5 # conda-forge does not have 5.13.2 available
7+
- c-compiler=1.3
8+
- cmake=3.21
9+
- qt=5.12 # conda-forge does not have 5.13.2 available
1010
- pip
11+
- moderngl
1112
- pip:
12-
- gym3==0.3.3
13-
- numpy==1.17.2
14-
- gym==0.15.3
15-
- filelock==3.0.10
13+
- gym3==0.3
14+
- numpy==1.17
15+
- gym
16+
- filelock==3.0

0 commit comments

Comments
 (0)