aihwkit.experiments.runners.local module

Runner that executes Experiments locally.

class aihwkit.experiments.runners.local.LocalRunner(device=None)

Bases: aihwkit.experiments.runners.base.Runner

Runner that executes Experiments locally.

Class that allows executing Experiments locally.

run(experiment, max_elements_train=0, dataset_root='/tmp/datasets', stdout=True)

Run a single Experiment.

Executes an experiment locally, in the device specified by self.device, optionally printing information to stdout.

Note

If using a dataset different than FashionMNIST or SVHN, the runner assumes that the files for the dataset are downloaded at dataset_root. For those two datasets, the downloading will take place automatically if the files are not present.

Parameters

  • experiment (aihwkit.experiments.experiments.training.BasicTraining) – the experiment to be executed.

  • max_elements_train (int) – limit on the amount of samples to use from the dataset. If 0, no limit is applied.

  • dataset_root (str) – path for the dataset files.

  • stdout (bool) – enable printing to stdout during the execution of the experiment.

Returns

A list of dictionaries with information about each epoch.

Return type

List[Dict]