You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-1Lines changed: 27 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,14 +23,31 @@ In the Procgen benchmark, algorithms are trained on a fixed number of level seed
23
23
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.
24
24
25
25
26
+
<br>
27
+
26
28
## Installation
27
29
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
+
28
33
29
34
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
+
```
30
41
42
+
Verify the installation by running the following command:
43
+
44
+
```bash
45
+
python -m procgen.interactive --env-name coinrun
46
+
```
31
47
32
48
33
49
50
+
<br>
34
51
35
52
## Holdout Types
36
53
@@ -61,9 +78,14 @@ The supported holdout types during training and/or evaluation are `all`, `backgr
61
78
||~~chaser~~||||||
62
79
||~~plunder~~||||||
63
80
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.
65
83
> - 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.
66
84
> 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>
67
89
68
90
## Environment Options
69
91
@@ -104,6 +126,7 @@ env = gym.make(
104
126
> - If you just want the frames instead of the window, pass `render_mode="rgb_array"`.
105
127
106
128
129
+
<br>
107
130
108
131
# License
109
132
@@ -112,6 +135,9 @@ This project contains two different licenses for different parts of the code:
112
135
- 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.
113
136
- 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.
114
137
138
+
139
+
<br>
140
+
115
141
# Citation
116
142
117
143
To cite this project in your work, please use the following Bibtex:
0 commit comments