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.

Sign up for GitHub

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

Jump to bottom

[Readme] #26

Merged
merged 3 commits into from
Oct 12, 2023
Merged

[Readme] #26

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad1ed8b
amend
matteobettini Oct 12, 2023
c504b3d
amend
matteobettini Oct 12, 2023
673c4b5
amend
matteobettini Oct 12, 2023
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
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ python benchmarl/run.py algorithm=mappo task=vmas/balance
```

[![Examples](https://img.shields.io/badge/Examples-blue.svg)](examples) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/facebookresearch/BenchMARL/blob/main/notebooks/run.ipynb)
<!--
[![Static Badge](https://img.shields.io/badge/Benchmarks-Wandb-yellow)]()
-->
[![Static Badge](https://img.shields.io/badge/Benchmarks-Wandb-yellow)](https://wandb.ai/benchmarl/public/reportlist)

### What is BenchMARL 🧐?

Expand Down Expand Up @@ -48,6 +46,7 @@ the domain and want to easily take a picture of the landscape.
+ [Install](#install)
+ [Run](#run)
* [Concept](#concept)
* [Fine-tuned public benchmarks](#fine-tuned-public-benchmarks)
* [Reporting and plotting](#reporting-and-plotting)
* [Extending](#extending)
* [Configuring](#configuring)
Expand Down Expand Up @@ -254,7 +253,7 @@ And the ones that are _work in progress_
| [GNN](https://github.com/facebookresearch/BenchMARL/pull/18) | Yes | Yes | No |
| CNN | Yes | Yes | Yes |

## Fine-tuned configurations
## Fine-tuned public benchmarks
> [!WARNING]
> This section is under a work in progress. We are constantly working on fine-tuning
> our experiments to enable our users to have access to state-of-the-art benchmarks.
Expand All @@ -264,9 +263,12 @@ In the [fine_tuned](fine_tuned) folder we are collecting some tested hyperparame
specific environments to enable users to bootstrap their benchmarking.
You can just run the scripts in this folder to automatically use the proposed hyperparameters.

Currently available are:
We will tune benchmarks for you and publish the config and benchmarking plots on
[Wandb](https://wandb.ai/benchmarl/public/reportlist) publicly

- **VMAS**: [![Conf](https://img.shields.io/badge/Conf-purple.svg)](fine_tuned/vmas/conf/config.yaml) <!-- [![Static Badge](https://img.shields.io/badge/Plots-Wandb-yellow)]() -->
Currently available ones are:

- **VMAS**: [![Conf](https://img.shields.io/badge/Conf-purple.svg)](fine_tuned/vmas/conf/config.yaml) [![Static Badge](https://img.shields.io/badge/Benchmarks-Wandb-yellow)](https://api.wandb.ai/links/benchmarl/xf5h3p3m)

## Reporting and plotting

Expand Down