nip.factory.build_scenario_instance

nip.factory.build_scenario_instance(hyper_params: HyperParameters, settings: ExperimentSettings) → ScenarioInstance

Build a scenario instance from parameters.

The ScenarioInstance class holds the components of a scenario, which serves to abstract away the details of the particular experiment being run.

Parameters:

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

• settings (ExperimentSettings) – The settings of the experiment.

Returns:

scenario_instance (ScenarioInstance) – The constructed scenario instance, which holds the components of the scenario.