Skip to content

Commit

Permalink
Amend
Browse files Browse the repository at this point in the history
  • Loading branch information
matteobettini committed Nov 22, 2023
1 parent 15b6cc3 commit 2cd5eb0
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 59 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
<a href="https://pypi.org/project/benchmarl"><img src="https://img.shields.io/pypi/v/benchmarl" alt="pypi version"></a>
[![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
Expand Down
8 changes: 1 addition & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
33 changes: 0 additions & 33 deletions docs/source/modules/algorithms.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/source/modules/root.rst

This file was deleted.

18 changes: 18 additions & 0 deletions docs/source/usage/running.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2cd5eb0

Please sign in to comment.