benchmarl.environments.Smacv2Task

class Smacv2Task(value)[source]

Bases: Task

Enum for SMACv2 tasks.

PROTOSS_5_VS_5 = 1

PROTOSS_10_VS_10 = 2

PROTOSS_10_VS_11 = 3

PROTOSS_20_VS_20 = 4

PROTOSS_20_VS_23 = 5

TERRAN_5_VS_5 = 6

TERRAN_10_VS_10 = 7

TERRAN_10_VS_11 = 8

TERRAN_20_VS_20 = 9

TERRAN_20_VS_23 = 10

ZERG_5_VS_5 = 11

ZERG_10_VS_10 = 12

ZERG_10_VS_11 = 13

ZERG_20_VS_20 = 14

ZERG_20_VS_23 = 15

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)