- batch_run(model_cls: type[Model], parameters: Mapping[str, Any | Iterable[Any]], number_processes: int | None = 1, iterations: int = 1, data_collection_period: int = -1, max_steps: int = 1000, display_progress: bool = True) list[dict[str, Any]] [source]#
Batch run a mesa model with a set of parameter values.
Parameters#
- model_clsType[Model]
The model class to batch-run
- parametersMapping[str, Union[Any, Iterable[Any]]],
Dictionary with model parameters over which to run the model. You can either pass single values or iterables.
- number_processesint, optional
Number of processes used, by default 1. Set this to None if you want to use all CPUs.
- iterationsint, optional
Number of iterations for each parameter combination, by default 1
- data_collection_periodint, optional
Number of steps after which data gets collected, by default -1 (end of episode)
- max_stepsint, optional
Maximum number of model steps after which the model halts, by default 1000
- display_progressbool, optional
Display batch run process, by default True
Returns#
- List[Dict[str, Any]]
[description]