Skip to content

Commit f280a35

Browse files
jzleibocopybara-github
authored andcommitted
Delete outdated PettingZoo example.
Context: #269 PiperOrigin-RevId: 755801265 Change-Id: I827581a29680a24835679016457905c6e83e072f
1 parent b7c6fb6 commit f280a35

File tree

5 files changed

+21
-342
lines changed

5 files changed

+21
-342
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@
22

33
*A suite of test scenarios for multi-agent reinforcement learning.*
44

5+
<!-- linter off -->
56
<!-- GITHUB -->
67
[![Python](https://img.shields.io/pypi/pyversions/dm-meltingpot.svg)](https://pypi.python.org/pypi/dm-meltingpot)
78
[![PyPI version](https://img.shields.io/pypi/v/dm-meltingpot.svg)](https://pypi.python.org/pypi/dm-meltingpot)
89
[![PyPI tests](../../actions/workflows/pypi-test.yml/badge.svg)](../../actions/workflows/pypi-test.yml)
910
[![Tests](../../actions/workflows/test-meltingpot.yml/badge.svg)](../../actions/workflows/test-meltingpot.yml)
1011
[![Examples](../../actions/workflows/test-examples.yml/badge.svg)](../../actions/workflows/test-examples.yml)
1112
<!-- /GITHUB -->
13+
<!-- linter on -->
14+
15+
<!-- disableFinding(SNIPPET_INVALID_LANGUAGE) -->
16+
<!-- disableFinding(IMAGE_ALT_TEXT_INACCESSIBLE) -->
1217

1318
<div align="center">
1419
<img src="https://github.com/google-deepmind/meltingpot/blob/main/docs/images/meltingpot_montage.gif?raw=true"
@@ -143,13 +148,12 @@ variants, which you select with the `--level_name` flag.
143148

144149
### Training agents
145150

146-
We provide two example scripts: one using
147-
[RLlib](https://github.com/ray-project/ray), and another using
148-
[PettingZoo](https://github.com/Farama-Foundation/PettingZoo) with
149-
[Stable-Baselines3](https://github.com/DLR-RM/stable-baselines3) (SB3). Note
150-
that Melting Pot is agnostic to how you train your agents, and as such, these
151-
scripts are not meant to be a suggestion on how to achieve good scores in the
152-
task suite.
151+
We provide an illustrative example script using
152+
[RLlib](https://github.com/ray-project/ray). However, note
153+
that Melting Pot is agnostic to how you train your agents, and this
154+
script is not meant to be a suggestion for how to achieve a good score
155+
in the task suite. The authors of the suite never used this example training
156+
script in their own work.
153157

154158
#### RLlib
155159

@@ -170,28 +174,13 @@ cd examples/rllib
170174
python self_play_train.py
171175
```
172176

173-
#### PettingZoo and Stable-Baselines3
174-
175-
This example uses a PettingZoo wrapper with a fully parameter shared PPO agent
176-
from SB3.
177-
178-
The PettingZoo wrapper can be used separately from SB3 and
179-
can be found [here](https://github.com/google-deepmind/meltingpot/blob/main/examples/pettingzoo/utils.py).
180-
181-
```shell
182-
cd <meltingpot_root>
183-
pip install -r examples/requirements.txt
184-
cd examples/pettingzoo
185-
python sb3_train.py
186-
```
187-
188177
## Documentation
189178

190179
Full documentation is available [here](https://github.com/google-deepmind/meltingpot/blob/main/docs/index.md).
191180

192181
## Citing Melting Pot
193182

194-
If you use Melting Pot in your work, please cite the accompanying article:
183+
If you use Melting Pot in your work, please cite the accompanying articles:
195184

196185
```bibtex
197186
@inproceedings{leibo2021meltingpot,
@@ -209,6 +198,15 @@ If you use Melting Pot in your work, please cite the accompanying article:
209198
}
210199
```
211200

201+
```bibtex
202+
@article{agapiou2022melting,
203+
title={Melting Pot 2.0},
204+
author={Agapiou, John P and Vezhnevets, Alexander Sasha and Du{\'e}{\~n}ez-Guzm{\'a}n, Edgar A and Matyas, Jayd and Mao, Yiran and Sunehag, Peter and K{\"o}ster, Raphael and Madhushani, Udari and Kopparapu, Kavya and Comanescu, Ramona and Strouse, {DJ} and Johanson, Michael B and Singh, Sukhdeep and Haas, Julia and Mordatch, Igor and Mobbs, Dean and Leibo, Joel Z},
205+
journal={arXiv preprint arXiv:2211.13746},
206+
year={2022}
207+
}
208+
```
209+
212210
## Disclaimer
213211

214212
This is not an officially supported Google product.

examples/pettingzoo/__init__.py

Lines changed: 0 additions & 13 deletions
This file was deleted.

examples/pettingzoo/sb3_train.py

Lines changed: 0 additions & 185 deletions
This file was deleted.

0 commit comments

Comments
 (0)