aihwkit.experiments.runners.cloud module

Base class for an Experiment Runner.

class aihwkit.experiments.runners.cloud.CloudRunner(api_url=None, api_token=None, verify=True)[source]

Bases: Runner

Runner that executes Experiments in the AIHW Composer cloud.

Class that allows executing Experiments in the cloud.

Parameters:

  • api_url (str | None) –

  • api_token (str | None) –

  • verify (bool) –

get_cloud_experiment(id_)[source]

Return a single cloud experiment by id.

Parameters:

  • id – the identifier of the cloud experiment.

  • id_ (str) –

Returns:

A CloudExperiment.

Return type:

CloudExperiment

list_cloud_experiments()[source]

Return a list of cloud experiments.

Returns:

A list of CloudExperiments.

Return type:

List[CloudExperiment]

run(experiment, name='', device='gpu', **_)[source]

Run a single Experiment.

Starts the execution of an Experiment in the cloud. Upon successful invocation, this method will return a CloudExperiment object that can be used for inspecting the status of the remote execution.

Note

Please be aware that the experiment is subjected to some constraints compared to local running of experiments.

Parameters:

  • experiment (BasicTraining) – the experiment to be executed.

  • name (str) – an optional name for the experiment.

  • device (str) – the desired device.

  • _ (Any) – extra arguments for the runner.

Returns:

A CloudExperiment which represents the remote experiment.

Return type:

CloudExperiment