nip.factory.get_scenario_class

nip.factory.get_scenario_class#

nip.factory.get_scenario_class(hyper_params: HyperParameters, base_class: type[T], agent_name: str | None = None) → type[T][source]#

Get the class for a component based on the scenario and base class.

Parameters:

  • hyper_params (HyperParameters) – The hyper_params of the experiment.

  • base_class (type) – The base class of the component to get.

  • agent_name (str, default=None) – If not None, we get a component for this specific agent.

Returns:

scenario_class (type) – The class for the component.

Raises:

NotImplementedError – If no class is found for the scenario and base class.