latest
Usage
Notebooks
Installation
Running
Citing
Concepts
Components
Public benchmarks
Reporting and plotting
Extending
Configuring
Features
Package Reference
benchmarl
benchmarl.experiment
benchmarl.benchmark
benchmarl.algorithms
benchmarl.environments
benchmarl.models
BenchMARL
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
_
_abc_impl (Algorithm attribute)
(Iddpg attribute)
(Ippo attribute)
(Iql attribute)
(Isac attribute)
(Maddpg attribute)
(Mappo attribute)
(Masac attribute)
(Qmix attribute)
(Vdn attribute)
_check_specs() (Algorithm method)
_forward() (Cnn method)
(Gnn method)
(Mlp method)
(Model method)
(SequenceModel method)
_get_loss() (Algorithm method)
(Iddpg method)
(Ippo method)
(Iql method)
(Isac method)
(Maddpg method)
(Mappo method)
(Masac method)
(Qmix method)
(Vdn method)
_get_parameters() (Algorithm method)
(Iddpg method)
(Ippo method)
(Iql method)
(Isac method)
(Maddpg method)
(Mappo method)
(Masac method)
(Qmix method)
(Vdn method)
_get_policy_for_collection() (Algorithm method)
(Iddpg method)
(Ippo method)
(Iql method)
(Isac method)
(Maddpg method)
(Mappo method)
(Masac method)
(Qmix method)
(Vdn method)
_get_policy_for_loss() (Algorithm method)
(Iddpg method)
(Ippo method)
(Iql method)
(Isac method)
(Maddpg method)
(Mappo method)
(Masac method)
(Qmix method)
(Vdn method)
_load_from_yaml() (AlgorithmConfig static method)
A
action_mask_spec() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
action_spec() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
adam_eps (ExperimentConfig attribute)
aggregate_scores() (Plotting static method)
Algorithm (class in benchmarl.algorithms)
AlgorithmConfig (class in benchmarl.algorithms)
ALLELOPATHIC_HARVEST__OPEN (MeltingPotTask attribute)
alpha_init (IsacConfig attribute)
(MasacConfig attribute)
associated_class() (AlgorithmConfig static method)
(CnnConfig static method)
(GnnConfig static method)
(IddpgConfig static method)
(IppoConfig static method)
(IqlConfig static method)
(IsacConfig static method)
(MaddpgConfig static method)
(MappoConfig static method)
(MasacConfig static method)
(MlpConfig static method)
(ModelConfig static method)
(QmixConfig static method)
(SequenceModelConfig static method)
(VdnConfig static method)
B
BACH_OR_STRAVINSKY_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
BACH_OR_STRAVINSKY_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
BALANCE (VmasTask attribute)
Benchmark (class in benchmarl.benchmark.benchmark)
benchmarl.benchmark.benchmark
module
benchmarl.eval_results
module
benchmarl.hydra_config
module
benchmarl.run
module
BOAT_RACE__EIGHT_RACES (MeltingPotTask attribute)
C
Callback (class in benchmarl.experiment)
checkpoint_interval (ExperimentConfig attribute)
CHEMISTRY__THREE_METABOLIC_CYCLES (MeltingPotTask attribute)
CHEMISTRY__THREE_METABOLIC_CYCLES_WITH_PLENTIFUL_DISTRACTORS (MeltingPotTask attribute)
CHEMISTRY__TWO_METABOLIC_CYCLES (MeltingPotTask attribute)
CHEMISTRY__TWO_METABOLIC_CYCLES_WITH_DISTRACTORS (MeltingPotTask attribute)
CHICKEN_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
CHICKEN_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
CLEAN_UP (MeltingPotTask attribute)
clip_epsilon (IppoConfig attribute)
(MappoConfig attribute)
clip_grad_norm (ExperimentConfig attribute)
clip_grad_val (ExperimentConfig attribute)
close() (Experiment method)
Cnn (class in benchmarl.models)
CnnConfig (class in benchmarl.models)
COINS (MeltingPotTask attribute)
COLLABORATIVE_COOKING__ASYMMETRIC (MeltingPotTask attribute)
COLLABORATIVE_COOKING__CIRCUIT (MeltingPotTask attribute)
COLLABORATIVE_COOKING__CRAMPED (MeltingPotTask attribute)
COLLABORATIVE_COOKING__CROWDED (MeltingPotTask attribute)
COLLABORATIVE_COOKING__FIGURE_EIGHT (MeltingPotTask attribute)
COLLABORATIVE_COOKING__FORCED (MeltingPotTask attribute)
COLLABORATIVE_COOKING__RING (MeltingPotTask attribute)
collected_frames_per_batch() (ExperimentConfig method)
COMMONS_HARVEST__CLOSED (MeltingPotTask attribute)
COMMONS_HARVEST__OPEN (MeltingPotTask attribute)
COMMONS_HARVEST__PARTNERSHIP (MeltingPotTask attribute)
COOP_MINING (MeltingPotTask attribute)
create_json (ExperimentConfig attribute)
create_matrices() (Plotting static method)
critic_coef (IppoConfig attribute)
(MappoConfig attribute)
D
DAYCARE (MeltingPotTask attribute)
delay_qvalue (IsacConfig attribute)
(MasacConfig attribute)
delay_value (IddpgConfig attribute)
(IqlConfig attribute)
(MaddpgConfig attribute)
(QmixConfig attribute)
(VdnConfig attribute)
discrete_target_entropy_weight (IsacConfig attribute)
(MasacConfig attribute)
DISPERSION (VmasTask attribute)
DROPOUT (VmasTask attribute)
E
entropy_coef (IppoConfig attribute)
(MappoConfig attribute)
env_name() (MeltingPotTask static method)
(PettingZooTask static method)
(Smacv2Task static method)
(Task static method)
(VmasTask static method)
environemnt_sample_efficiency_curves() (Plotting static method)
evaluation (ExperimentConfig attribute)
evaluation_deterministic_actions (ExperimentConfig attribute)
evaluation_episodes (ExperimentConfig attribute)
evaluation_interval (ExperimentConfig attribute)
experiment (Callback attribute)
Experiment (class in benchmarl.experiment)
ExperimentConfig (class in benchmarl.experiment)
exploration_anneal_frames (ExperimentConfig attribute)
exploration_eps_end (ExperimentConfig attribute)
exploration_eps_init (ExperimentConfig attribute)
EXTERNALITY_MUSHROOMS__DENSE (MeltingPotTask attribute)
F
FACTORY_COMMONS__EITHER_OR (MeltingPotTask attribute)
fixed_alpha (IsacConfig attribute)
(MasacConfig attribute)
forward() (Model method)
FRUIT_MARKET__CONCENTRIC_RIVERS (MeltingPotTask attribute)
G
gamma (ExperimentConfig attribute)
get_algorithm() (AlgorithmConfig method)
get_continuous_value_module() (Isac method)
(Masac method)
get_critic() (Ippo method)
(Mappo method)
get_discrete_value_module() (Isac method)
(Masac method)
get_env_fun() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
get_env_transforms() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
get_experiments() (Benchmark method)
get_exploration_anneal_frames() (ExperimentConfig method)
get_from_yaml() (AlgorithmConfig class method)
(ExperimentConfig static method)
(MeltingPotTask method)
(ModelConfig class method)
(PettingZooTask method)
(SequenceModelConfig class method)
(Smacv2Task method)
(Task method)
(VmasTask method)
get_loss_and_updater() (Algorithm method)
get_max_n_frames() (ExperimentConfig method)
get_max_n_iters() (ExperimentConfig method)
get_mixer() (Qmix method)
(Vdn method)
get_model() (ModelConfig method)
(SequenceModelConfig method)
get_parameters() (Algorithm method)
get_policy_for_collection() (Algorithm method)
get_policy_for_loss() (Algorithm method)
get_raw_dict_from_multirun_folder() (in module benchmarl.eval_results)
get_replay_buffer() (Algorithm method)
get_replay_buffer_transforms() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
get_reward_sum_transform() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
get_value_module() (Iddpg method)
(Maddpg method)
GIFT_REFINEMENTS (MeltingPotTask attribute)
GIVE_WAY (VmasTask attribute)
Gnn (class in benchmarl.models)
GnnConfig (class in benchmarl.models)
group_map() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
H
hard_target_update_frequency (ExperimentConfig attribute)
has_render() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
has_state() (PettingZooTask method)
HIDDEN_AGENDA (MeltingPotTask attribute)
hydra_experiment() (in module benchmarl.run)
I
Iddpg (class in benchmarl.algorithms)
IddpgConfig (class in benchmarl.algorithms)
info_spec() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
Ippo (class in benchmarl.algorithms)
IppoConfig (class in benchmarl.algorithms)
Iql (class in benchmarl.algorithms)
IqlConfig (class in benchmarl.algorithms)
Isac (class in benchmarl.algorithms)
IsacConfig (class in benchmarl.algorithms)
L
lmbda (IppoConfig attribute)
(MappoConfig attribute)
load_algorithm_config_from_hydra() (in module benchmarl.hydra_config)
load_and_merge_json_dicts() (in module benchmarl.eval_results)
load_experiment_config_from_hydra() (in module benchmarl.hydra_config)
load_experiment_from_hydra() (in module benchmarl.hydra_config)
load_model_config_from_hydra() (in module benchmarl.hydra_config)
load_state_dict() (Experiment method)
load_task_config_from_hydra() (in module benchmarl.hydra_config)
log_info() (MeltingPotTask static method)
(PettingZooTask static method)
(Smacv2Task static method)
(Task static method)
(VmasTask static method)
loggers (ExperimentConfig attribute)
loss_critic_type (IppoConfig attribute)
(MappoConfig attribute)
loss_function (IddpgConfig attribute)
(IqlConfig attribute)
(IsacConfig attribute)
(MaddpgConfig attribute)
(MasacConfig attribute)
(QmixConfig attribute)
(VdnConfig attribute)
lr (ExperimentConfig attribute)
M
Maddpg (class in benchmarl.algorithms)
MaddpgConfig (class in benchmarl.algorithms)
Mappo (class in benchmarl.algorithms)
MappoConfig (class in benchmarl.algorithms)
Masac (class in benchmarl.algorithms)
MasacConfig (class in benchmarl.algorithms)
max_alpha (IsacConfig attribute)
(MasacConfig attribute)
max_n_frames (ExperimentConfig attribute)
max_n_iters (ExperimentConfig attribute)
max_steps() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
MeltingPotTask (class in benchmarl.environments)
METRIC_TO_PLOT (Plotting attribute)
METRICS_TO_NORMALIZE (Plotting attribute)
min_alpha (IsacConfig attribute)
(MasacConfig attribute)
mixing_embed_dim (QmixConfig attribute)
Mlp (class in benchmarl.models)
MlpConfig (class in benchmarl.models)
Model (class in benchmarl.models)
ModelConfig (class in benchmarl.models)
module
benchmarl.benchmark.benchmark
benchmarl.eval_results
benchmarl.hydra_config
benchmarl.run
MULTIWALKER (PettingZooTask attribute)
N
n_envs_per_worker() (ExperimentConfig method)
n_experiments (Benchmark property)
n_optimizer_steps() (ExperimentConfig method)
NAVIGATION (VmasTask attribute)
num_qvalue_nets (IsacConfig attribute)
(MasacConfig attribute)
O
observation_spec() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
off_policy_collected_frames_per_batch (ExperimentConfig attribute)
off_policy_init_random_frames (ExperimentConfig attribute)
off_policy_memory_size (ExperimentConfig attribute)
off_policy_n_envs_per_worker (ExperimentConfig attribute)
off_policy_n_optimizer_steps (ExperimentConfig attribute)
off_policy_train_batch_size (ExperimentConfig attribute)
on_batch_collected() (Callback method)
on_evaluation_end() (Callback method)
on_policy (Experiment property)
on_policy() (AlgorithmConfig static method)
(IddpgConfig static method)
(IppoConfig static method)
(IqlConfig static method)
(IsacConfig static method)
(MaddpgConfig static method)
(MappoConfig static method)
(MasacConfig static method)
(QmixConfig static method)
(VdnConfig static method)
on_policy_collected_frames_per_batch (ExperimentConfig attribute)
on_policy_minibatch_size (ExperimentConfig attribute)
on_policy_n_envs_per_worker (ExperimentConfig attribute)
on_policy_n_minibatch_iters (ExperimentConfig attribute)
on_setup() (Callback method)
on_train_end() (Callback method)
on_train_step() (Callback method)
output_has_agent_dim (Model property)
P
PAINTBALL__CAPTURE_THE_FLAG (MeltingPotTask attribute)
PAINTBALL__KING_OF_THE_HILL (MeltingPotTask attribute)
performance_profile_figure() (Plotting static method)
PettingZooTask (class in benchmarl.environments)
Plotting (class in benchmarl.eval_results)
polyak_tau (ExperimentConfig attribute)
PREDATOR_PREY__ALLEY_HUNT (MeltingPotTask attribute)
PREDATOR_PREY__OPEN (MeltingPotTask attribute)
PREDATOR_PREY__ORCHARD (MeltingPotTask attribute)
PREDATOR_PREY__RANDOM_FOREST (MeltingPotTask attribute)
prefer_continuous_actions (ExperimentConfig attribute)
PRISONERS_DILEMMA_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
PRISONERS_DILEMMA_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
probability_of_improvement() (Plotting static method)
process_batch() (Algorithm method)
(Iddpg method)
(Ippo method)
(Iql method)
(Isac method)
(Maddpg method)
(Mappo method)
(Masac method)
(Qmix method)
(Vdn method)
process_data() (Plotting static method)
process_env_fun() (ModelConfig method)
(SequenceModelConfig method)
process_loss_vals() (Algorithm method)
(Ippo method)
(Mappo method)
PROTOSS_10_VS_10 (Smacv2Task attribute)
PROTOSS_10_VS_11 (Smacv2Task attribute)
PROTOSS_20_VS_20 (Smacv2Task attribute)
PROTOSS_20_VS_23 (Smacv2Task attribute)
PROTOSS_5_VS_5 (Smacv2Task attribute)
PURE_COORDINATION_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
PURE_COORDINATION_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
Q
Qmix (class in benchmarl.algorithms)
QmixConfig (class in benchmarl.algorithms)
R
RATIONALIZABLE_COORDINATION_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
RATIONALIZABLE_COORDINATION_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
render (ExperimentConfig attribute)
render_callback() (MeltingPotTask static method)
(PettingZooTask static method)
(Smacv2Task static method)
(Task static method)
(VmasTask static method)
replay_buffer_memory_size() (ExperimentConfig method)
restore_file (ExperimentConfig attribute)
REVERSE_TRANSPORT (VmasTask attribute)
run() (Experiment method)
run_sequential() (Benchmark method)
RUNNING_WITH_SCISSORS_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
RUNNING_WITH_SCISSORS_IN_THE_MATRIX__ONE_SHOT (MeltingPotTask attribute)
RUNNING_WITH_SCISSORS_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
S
SAMPLING (VmasTask attribute)
sampling_device (ExperimentConfig attribute)
save_folder (ExperimentConfig attribute)
scale_mapping (IppoConfig attribute)
(IsacConfig attribute)
(MappoConfig attribute)
(MasacConfig attribute)
SequenceModel (class in benchmarl.models)
SequenceModelConfig (class in benchmarl.models)
share_param_critic (IddpgConfig attribute)
(IppoConfig attribute)
(IsacConfig attribute)
(MaddpgConfig attribute)
(MappoConfig attribute)
(MasacConfig attribute)
share_policy_params (ExperimentConfig attribute)
SIMPLE_ADVERSARY (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_CRYPTO (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_PUSH (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_REFERENCE (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_SPEAKER_LISTENER (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_SPREAD (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_TAG (PettingZooTask attribute)
(VmasTask attribute)
SIMPLE_WORLD_COMM (PettingZooTask attribute)
(VmasTask attribute)
Smacv2Task (class in benchmarl.environments)
soft_target_update (ExperimentConfig attribute)
STAG_HUNT_IN_THE_MATRIX__ARENA (MeltingPotTask attribute)
STAG_HUNT_IN_THE_MATRIX__REPEATED (MeltingPotTask attribute)
state_dict() (Experiment method)
state_spec() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
supports_continuous_actions() (AlgorithmConfig static method)
(IddpgConfig static method)
(IppoConfig static method)
(IqlConfig static method)
(IsacConfig static method)
(MaddpgConfig static method)
(MappoConfig static method)
(MasacConfig static method)
(MeltingPotTask method)
(PettingZooTask method)
(QmixConfig static method)
(Smacv2Task method)
(Task method)
(VdnConfig static method)
(VmasTask method)
supports_discrete_actions() (AlgorithmConfig static method)
(IddpgConfig static method)
(IppoConfig static method)
(IqlConfig static method)
(IsacConfig static method)
(MaddpgConfig static method)
(MappoConfig static method)
(MasacConfig static method)
(MeltingPotTask method)
(PettingZooTask method)
(QmixConfig static method)
(Smacv2Task method)
(Task method)
(VdnConfig static method)
(VmasTask method)
T
target_entropy (IsacConfig attribute)
(MasacConfig attribute)
Task (class in benchmarl.environments)
task_sample_efficiency_curves() (Plotting static method)
TERRAN_10_VS_10 (Smacv2Task attribute)
TERRAN_10_VS_11 (Smacv2Task attribute)
TERRAN_20_VS_20 (Smacv2Task attribute)
TERRAN_20_VS_23 (Smacv2Task attribute)
TERRAN_5_VS_5 (Smacv2Task attribute)
TERRITORY__INSIDE_OUT (MeltingPotTask attribute)
TERRITORY__OPEN (MeltingPotTask attribute)
TERRITORY__ROOMS (MeltingPotTask attribute)
train_batch_size() (ExperimentConfig method)
train_device (ExperimentConfig attribute)
train_minibatch_size() (ExperimentConfig method)
TRANSPORT (VmasTask attribute)
U
update_config() (MeltingPotTask method)
(PettingZooTask method)
(Smacv2Task method)
(Task method)
(VmasTask method)
use_tanh_mapping (IddpgConfig attribute)
(MaddpgConfig attribute)
use_tanh_normal (IppoConfig attribute)
(IsacConfig attribute)
(MappoConfig attribute)
(MasacConfig attribute)
V
validate() (ExperimentConfig method)
Vdn (class in benchmarl.algorithms)
VdnConfig (class in benchmarl.algorithms)
VmasTask (class in benchmarl.environments)
W
WATERWORLD (PettingZooTask attribute)
WHEEL (VmasTask attribute)
WIND_FLOCKING (VmasTask attribute)
Z
ZERG_10_VS_10 (Smacv2Task attribute)
ZERG_10_VS_11 (Smacv2Task attribute)
ZERG_20_VS_20 (Smacv2Task attribute)
ZERG_20_VS_23 (Smacv2Task attribute)
ZERG_5_VS_5 (Smacv2Task attribute)
Read the Docs
v: latest
Versions
latest
1.2.0
1.1.1
1.0.0
Downloads
epub
On Read the Docs
Project Home
Builds