benchmarl.environments.MeltingPotTask

class MeltingPotTask(value)[source]

Bases: Task

Enum for meltingpot tasks.

PREDATOR_PREY__ALLEY_HUNT = 1

CLEAN_UP = 2

COLLABORATIVE_COOKING__CIRCUIT = 3

FRUIT_MARKET__CONCENTRIC_RIVERS = 4

COLLABORATIVE_COOKING__FIGURE_EIGHT = 5

PAINTBALL__KING_OF_THE_HILL = 6

FACTORY_COMMONS__EITHER_OR = 7

PURE_COORDINATION_IN_THE_MATRIX__ARENA = 8

RUNNING_WITH_SCISSORS_IN_THE_MATRIX__REPEATED = 9

COLLABORATIVE_COOKING__CRAMPED = 10

RUNNING_WITH_SCISSORS_IN_THE_MATRIX__ARENA = 11

PRISONERS_DILEMMA_IN_THE_MATRIX__REPEATED = 12

TERRITORY__OPEN = 13

STAG_HUNT_IN_THE_MATRIX__REPEATED = 14

CHICKEN_IN_THE_MATRIX__REPEATED = 15

GIFT_REFINEMENTS = 16

PURE_COORDINATION_IN_THE_MATRIX__REPEATED = 17

COLLABORATIVE_COOKING__FORCED = 18

RATIONALIZABLE_COORDINATION_IN_THE_MATRIX__ARENA = 19

BACH_OR_STRAVINSKY_IN_THE_MATRIX__ARENA = 20

CHEMISTRY__TWO_METABOLIC_CYCLES_WITH_DISTRACTORS = 21

COMMONS_HARVEST__PARTNERSHIP = 22

PREDATOR_PREY__OPEN = 23

TERRITORY__ROOMS = 24

HIDDEN_AGENDA = 25

COOP_MINING = 26

DAYCARE = 27

PRISONERS_DILEMMA_IN_THE_MATRIX__ARENA = 28

TERRITORY__INSIDE_OUT = 29

BACH_OR_STRAVINSKY_IN_THE_MATRIX__REPEATED = 30

COMMONS_HARVEST__CLOSED = 31

CHEMISTRY__THREE_METABOLIC_CYCLES_WITH_PLENTIFUL_DISTRACTORS = 32

STAG_HUNT_IN_THE_MATRIX__ARENA = 33

PAINTBALL__CAPTURE_THE_FLAG = 34

COLLABORATIVE_COOKING__CROWDED = 35

ALLELOPATHIC_HARVEST__OPEN = 36

COLLABORATIVE_COOKING__RING = 37

COMMONS_HARVEST__OPEN = 38

COINS = 39

PREDATOR_PREY__ORCHARD = 40

PREDATOR_PREY__RANDOM_FOREST = 41

COLLABORATIVE_COOKING__ASYMMETRIC = 42

RATIONALIZABLE_COORDINATION_IN_THE_MATRIX__REPEATED = 43

CHEMISTRY__THREE_METABOLIC_CYCLES = 44

RUNNING_WITH_SCISSORS_IN_THE_MATRIX__ONE_SHOT = 45

CHEMISTRY__TWO_METABOLIC_CYCLES = 46

CHICKEN_IN_THE_MATRIX__ARENA = 47

BOAT_RACE__EIGHT_RACES = 48

EXTERNALITY_MUSHROOMS__DENSE = 49

static associated_class()[source]: The associated task class

classmethod env_name() → str: The name of the environment in the benchmarl/conf/task folder

get_task(config: Dict[str, Any] | None = None) → TaskClass

Get the TaskClass object associated with this enum element by passing it the task name and config.

If no config is given, it will be loaded from benchmarl/conf/task/self.env_name()/self.name using Task.get_from_yaml().

Parameters:

config (dict) – Optional configuration of the task.
provided (If not)
yaml. (the default configuration will be loaded from)

Returns:

The TaskClass object for the task.

get_from_yaml(path: str | None = None) → TaskClass

Load the task configuration from yaml

Parameters:: path (str, optional) – The full path of the yaml file to load from. If None, it will default to benchmarl/conf/task/self.env_name()/self.name
Returns:: the TaskClass with the loaded config

property config

update_config(config: Dict[str, Any]) → Task

supports_continuous_actions() → bool

supports_discrete_actions() → bool

max_steps(env: EnvBase) → int

has_render(env: EnvBase) → bool

group_map(env: EnvBase) → Dict[str, List[str]]

observation_spec(env: EnvBase) → Composite

info_spec(env: EnvBase) → Composite | None

state_spec(env: EnvBase) → Composite | None

action_spec(env: EnvBase) → Composite

action_mask_spec(env: EnvBase) → Composite | None

static log_info(batch: TensorDictBase) → Dict[str, float]

get_reward_sum_transform(env: EnvBase) → Transform

get_env_transforms(env: EnvBase) → List[Transform]

get_replay_buffer_transforms(env: EnvBase, group: str) → List[Transform]

static render_callback(experiment, env: EnvBase, data: TensorDictBase)