1.0.0
Usage
Notebooks
Installation
Running
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() (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() (Task method)
action_spec() (Task method)
adam_eps (ExperimentConfig attribute)
aggregate_scores() (Plotting static method)
Algorithm (class in benchmarl.algorithms)
AlgorithmConfig (class in benchmarl.algorithms)
alpha_init (IsacConfig attribute)
(MasacConfig attribute)
associated_class() (AlgorithmConfig 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
BALANCE (VmasTask attribute)
Benchmark (class in benchmarl.benchmark.benchmark)
benchmarl.benchmark.benchmark
module
benchmarl.eval_results
module
benchmarl.hydra_config
module
benchmarl.run
module
C
Callback (class in benchmarl.experiment)
checkpoint_interval (ExperimentConfig attribute)
clip_epsilon (IppoConfig attribute)
(MappoConfig attribute)
clip_grad_norm (ExperimentConfig attribute)
clip_grad_val (ExperimentConfig attribute)
close() (Experiment method)
collected_frames_per_batch() (ExperimentConfig method)
create_json (ExperimentConfig attribute)
create_matrices() (Plotting static method)
critic_coef (IppoConfig attribute)
(MappoConfig attribute)
D
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)
E
entropy_coef (IppoConfig attribute)
(MappoConfig attribute)
env_name() (Task static method)
environemnt_sample_efficiency_curves() (Plotting static method)
evaluation (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)
F
fixed_alpha (IsacConfig attribute)
(MasacConfig attribute)
forward() (Model method)
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() (Task method)
get_experiments() (Benchmark method)
get_exploration_anneal_frames() (ExperimentConfig method)
get_from_yaml() (AlgorithmConfig class method)
(ExperimentConfig static method)
(ModelConfig class method)
(SequenceModelConfig class method)
(Task 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_reward_sum_transform() (Task method)
get_value_module() (Iddpg method)
(Maddpg method)
group_map() (Task method)
H
hard_target_update_frequency (ExperimentConfig attribute)
has_render() (Task method)
has_state() (PettingZooTask method)
hydra_experiment() (in module benchmarl.run)
I
Iddpg (class in benchmarl.algorithms)
IddpgConfig (class in benchmarl.algorithms)
info_spec() (Task 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() (Task 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() (Task method)
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() (Task method)
off_policy_collected_frames_per_batch (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_train_end() (Callback method)
on_train_step() (Callback method)
output_has_agent_dim (Model property)
P
performance_profile_figure() (Plotting static method)
PettingZooTask (class in benchmarl.environments)
Plotting (class in benchmarl.eval_results)
polyak_tau (ExperimentConfig attribute)
prefer_continuous_actions (ExperimentConfig 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)
Q
Qmix (class in benchmarl.algorithms)
QmixConfig (class in benchmarl.algorithms)
R
render (ExperimentConfig attribute)
render_callback() (Task static method)
replay_buffer_memory_size() (ExperimentConfig method)
restore_file (ExperimentConfig attribute)
run() (Experiment method)
run_sequential() (Benchmark method)
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)
SIMPLE_CRYPTO (PettingZooTask attribute)
SIMPLE_PUSH (PettingZooTask attribute)
SIMPLE_REFERENCE (PettingZooTask attribute)
SIMPLE_SPEAKER_LISTENER (PettingZooTask attribute)
SIMPLE_SPREAD (PettingZooTask attribute)
SIMPLE_TAG (PettingZooTask attribute)
SIMPLE_WORLD_COMM (PettingZooTask attribute)
Smacv2Task (class in benchmarl.environments)
soft_target_update (ExperimentConfig attribute)
state_dict() (Experiment method)
state_spec() (Task 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)
(QmixConfig static method)
(Task method)
(VdnConfig static 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)
(QmixConfig static method)
(Task method)
(VdnConfig static 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)
train_batch_size() (ExperimentConfig method)
train_device (ExperimentConfig attribute)
train_minibatch_size() (ExperimentConfig method)
TRANSPORT (VmasTask attribute)
U
update_config() (Task method)
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)
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: 1.0.0
Versions
latest
1.0.0
Downloads
On Read the Docs
Project Home
Builds