diff --git a/README.md b/README.md index 93a0554a..b59166cd 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue.svg)](https://www.python.org/downloads/) pypi version [![Downloads](https://static.pepy.tech/personalized-badge/benchmarl?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/benchmarl) -[![Discord Shield](https://dcbadge.vercel.app/api/server/2XJdEenU?style=flat)](https://discord.gg/2XJdEenU) +[![Discord Shield](https://dcbadge.vercel.app/api/server/zcTf2xRC7t?style=flat)](https://discord.gg/zcTf2xRC7t) ```bash python benchmarl/run.py algorithm=mappo task=vmas/balance diff --git a/docs/source/index.rst b/docs/source/index.rst index c7924a59..e3d60141 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,6 +33,7 @@ to check how your new research compares to existing ones, or if you just want to the domain and want to easily take a picture of the landscape. .. discord_button:: + https://discord.gg/zcTf2xRC7t .. toctree:: :maxdepth: 1 @@ -52,10 +53,3 @@ the domain and want to easily take a picture of the landscape. concepts/extending concepts/configuring concepts/features - -.. toctree:: - :maxdepth: 1 - :caption: Package Reference - - modules/root - modules/algorithms diff --git a/docs/source/modules/algorithms.rst b/docs/source/modules/algorithms.rst deleted file mode 100644 index 4e22f3d8..00000000 --- a/docs/source/modules/algorithms.rst +++ /dev/null @@ -1,33 +0,0 @@ - -benchmarl.algorithms -==================== - -.. contents:: Contents - :local: - -Common ------- -.. currentmodule:: benchmarl.algorithms - -.. autosummary:: - :nosignatures: - :toctree: ../generated - :template: autosummary/class.rst - - {% for name in benchmarl.algorithms.common %} - {{ name }} - {% endfor %} - -Algorithms ----------- - -.. currentmodule:: benchmarl.algorithms - -.. autosummary:: - :nosignatures: - :toctree: ../generated - :template: autosummary/class.rst - - {% for name in benchmarl.algorithms.classes %} - {{ name }} - {% endfor %} diff --git a/docs/source/modules/root.rst b/docs/source/modules/root.rst deleted file mode 100644 index 00a15048..00000000 --- a/docs/source/modules/root.rst +++ /dev/null @@ -1,18 +0,0 @@ -benchmarl -========= - - -.. automodule:: benchmarl.benchmark - :members: - -.. automodule:: benchmarl.eval_results - :members: - -.. automodule:: benchmarl.hydra_config - :members: - -.. automodule:: benchmarl.run - :members: - -.. automodule:: benchmarl.utils - :members: diff --git a/docs/source/usage/running.rst b/docs/source/usage/running.rst index 4d2b8fa1..0302c88b 100644 --- a/docs/source/usage/running.rst +++ b/docs/source/usage/running.rst @@ -1,2 +1,20 @@ Running ======= + +Experiments are launched with a [default configuration](benchmarl/conf) that +can be overridden in many ways. +To learn how to customize and override configurations +please refer to the [configuring section](#configuring). + +Command line +------------ + +To launch an experiment from the command line you can do + +.. code-block:: console + + python benchmarl/run.py algorithm=mappo task=vmas/balance + + +.. example_button:: + ciao