Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Pointers to BenchMARL #1710

Merged
merged 5 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -683,6 +683,12 @@ As mentioned above, a list of open contributions can be found in [here](https://

Contributors are recommended to install [pre-commit hooks](https://pre-commit.com/) (using `pre-commit install`). pre-commit will check for linting related issues when the code is committed locally. You can disable th check by appending `-n` to your commit command: `git commit -m <commit message> -n`

## Ecosystem

Here are some projects that are part of the TorchRL ecosystem:
- [BenchMARL](https://github.com/facebookresearch/BenchMARL): a benchmarking library where you can train and compare MARL algorithms, tasks, and models using TorchRL!



## Disclaimer

Expand Down
6 changes: 6 additions & 0 deletions examples/multiagent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ In this folder we provide a set of multi-agent example scripts using the [VMAS](

For more details on the experiment setup and the environments please refer to the corresponding section of the appendix in the [TorchRL paper](https://arxiv.org/abs/2306.00577).

> [!NOTE]
> We have just released [BenchMARL](https://github.com/facebookresearch/BenchMARL), a benchmarking library where you
> can train and compare MARL algorithms, tasks, and models using TorchRL!
> Check out [how easy it is to use it.](https://colab.research.google.com/github/facebookresearch/BenchMARL/blob/main/notebooks/run.ipynb)


## Using the scripts

### Install
Expand Down
7 changes: 7 additions & 0 deletions tutorials/sphinx-tutorials/multiagent_ppo.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
===============================================================
**Author**: `Matteo Bettini <https://github.com/matteobettini>`_

.. note::

We have just released `BenchMARL <https://github.com/facebookresearch/BenchMARL>`__, a benchmarking library where you
can train and compare MARL algorithms, tasks, and models using TorchRL!
Check out `how easy it is to use it <https://colab.research.google.com/github/facebookresearch/BenchMARL/blob/main/notebooks/run.ipynb>`__.


This tutorial demonstrates how to use PyTorch and :py:mod:`torchrl` to
solve a Multi-Agent Reinforcement Learning (MARL) problem.

Expand Down
Loading