benchmarl.algorithms.AlgorithmConfig
- class AlgorithmConfig[source]
Bases:
object
Dataclass representing an algorithm configuration. This should be overridden by implemented algorithms. Implementors should:
add configuration parameters for their algorithm
implement all abstract methods
- get_algorithm(experiment) Algorithm [source]
Main function to turn the config into the associated algorithm
- Parameters:
experiment (Experiment) – the experiment class
Returns: the Algorithm
- classmethod get_from_yaml(path: str | None = None)[source]
Load the algorithm 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/algorithm/self.associated_class().__name__
Returns: the loaded AlgorithmConfig
- abstract static associated_class() Type[Algorithm] [source]
The algorithm class associated to the config
- abstract static supports_continuous_actions() bool [source]
If the algorithm supports continuous actions