Scenario management

aica_challenge_1.scenario_manager.Scenario dataclass

Represents a scenario.

Parameters:

Name	Type	Description	Default
name	str	A given name of the scenario.	required
short_path	str	A name of the scenario directory inside the scenarios directory of the challenge.	required
path	str	A full path to the scenario.	required
description	str	A description of the scenario.	required
goal	str	A goal of the scenario.	required
parameters	Dict[str, str]	A set of parameters that is passed to agents on top of the run parameters.	required
variants	Dict[int, ScenarioVariant]	A list of variants for the scenario.	required

aica_challenge_1.scenario_manager.ScenarioVariant dataclass

Represents one variant of a particular scenario.

Parameters:

Name	Type	Description	Default
id	int	An identifier of a this variant.	required
path	str	A path to the variant's configuration file.	required
config	List[ConfigItem]	A list of configuration items parsed from configuration file.	required

aica_challenge_1.scenario_manager.ScenarioManager

Scenario manager takes care of tracking and downloading scenarios.

download_remote_scenarios(overwrite: bool = False) -> None

Attempts to download all scenarios that are currently published.

Parameters:

Name	Type	Description	Default
overwrite	bool	If False, it will not attempt to overwrite local scenarios. This is mostly useful in situations when you made local modifications that you want to preserve.	False

get_scenario(name: str) -> Optional[Scenario]

Retrieve a local scenario by name.

Parameters:

Name	Type	Description	Default
name	str	A short name (i.e., the directory in scenarios directory) of the scenario.	required

Returns:

Type	Description
Optional[Scenario]	A scenario description if there is a scenario of the given name, None otherwise.

get_scenarios(remote: bool = False) -> List[Scenario]

Retrieves descriptions of either local or remote scenarios.

Parameters:

Name	Type	Description	Default
remote	bool	If set to True, checks for all available scenarios online. Otherwise look only inside the scenarios directory.	False

Returns:

Type	Description
List[Scenario]	A list of scenario descriptions.