-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
644ba75
commit 00faabf
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,58 @@ | ||
Installation | ||
============ | ||
|
||
|
||
Install TorchRL | ||
--------------- | ||
|
||
You can install TorchRL from PyPi. | ||
|
||
.. code-block:: console | ||
pip install torchrl | ||
For more details, or for installing nightly versions, see the | ||
`TorchRL installation guide <https://github.com/pytorch/rl#installation>`_. | ||
|
||
Install BenchMARL | ||
----------------- | ||
|
||
You can just install it from github | ||
|
||
.. code-block:: console | ||
pip install benchmarl | ||
Or also clone it locally to access the configs and scripts | ||
.. code-block:: console | ||
git clone https://github.com/facebookresearch/BenchMARL.git | ||
pip install -e BenchMARL | ||
Install environments | ||
-------------------- | ||
|
||
All enviornment dependencies are optional in BenchMARL and can be installed separately. | ||
|
||
VMAS | ||
^^^^ | ||
|
||
.. code-block:: console | ||
pip install vmas | ||
PettingZoo | ||
^^^^^^^^^^ | ||
|
||
.. code-block:: console | ||
pip install "pettingzoo[all]" | ||
SMACv2 | ||
^^^^^^ | ||
|
||
Follow the instructions on the environment `repository <https://github.com/oxwhirl/smacv2>`_. | ||
|
||
`Here <https://github.com/facebookresearch/BenchMARL/blob/main/.github/unittest/install_smacv2.sh>`_ | ||
is how we install it on linux. |