aihwkit.cloud.client.entities module

Data classes for the AIHW Composer API.

class aihwkit.cloud.client.entities.CloudExperiment(_api_client, id_, name, category, created_at, input_id, job)

Bases: object

Representation of an API Experiment.

Parameters

• _api_client (Any) –

• id_ (str) –

• name (str) –

• category (aihwkit.cloud.client.entities.CloudExperimentCategory) –

• created_at (datetime.datetime) –

• input_id (Optional[str]) –

• job (Optional[aihwkit.cloud.client.entities.CloudJob]) –

Return type

None

category: aihwkit.cloud.client.entities.CloudExperimentCategory

created_at: datetime.datetime

get_experiment()

Return a data Experiment.

Returns

The experiment.

Raises

ExperimentStatusError – if the Experiment is not in a valid status.

Return type

aihwkit.experiments.experiments.training.BasicTraining

get_result()

Return the result of an Experiment.

Returns

The experiment result.

Raises

ExperimentStatusError – if the Experiment is not completed.

Return type

list

id_: str

input_id: Optional[str]

job: Optional[aihwkit.cloud.client.entities.CloudJob]

name: str

status()

Return the status of the experiment.

Return type

aihwkit.cloud.client.entities.CloudJobStatus

class aihwkit.cloud.client.entities.CloudExperimentCategory(value)

Bases: enum.Enum

Category of a CloudExperiment.

BASIC_TRAINING = 1

class aihwkit.cloud.client.entities.CloudJob(id_, output_id, status=<CloudJobStatus.UNKNOWN: 0>)

Bases: object

Representation of an API CloudJob.

Parameters

• id_ (str) –

• output_id (Optional[str]) –

• status (aihwkit.cloud.client.entities.CloudJobStatus) –

Return type

None

id_: str

output_id: Optional[str]

status: aihwkit.cloud.client.entities.CloudJobStatus = 0

class aihwkit.cloud.client.entities.CloudJobStatus(value)

Bases: enum.Enum

Status for a CloudJob.

COMPLETED = 3

FAILED = 4

RUNNING = 2

UNKNOWN = 0

WAITING = 1