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)[source]

Bases: object

Representation of an API Experiment.

Parameters:

  • _api_client (Any) –

  • id_ (str) –

  • name (str) –

  • category (CloudExperimentCategory) –

  • created_at (datetime) –

  • input_id (str | None) –

  • job (CloudJob | None) –

category: CloudExperimentCategory
created_at: datetime
get_experiment()[source]

Return a data Experiment.

Returns:

The experiment.

Raises:

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

Return type:

Any

get_result()[source]

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: str | None
job: CloudJob | None
name: str
status()[source]

Return the status of the experiment.

Return type:

CloudJobStatus

class aihwkit.cloud.client.entities.CloudExperimentCategory(value)[source]

Bases: Enum

Category of a CloudExperiment.

BASIC_INFERENCE = 2
BASIC_TRAINING = 1
class aihwkit.cloud.client.entities.CloudJob(id_, output_id, status=CloudJobStatus.UNKNOWN)[source]

Bases: object

Representation of an API CloudJob.

Parameters:

  • id_ (str) –

  • output_id (str | None) –

  • status (CloudJobStatus) –

id_: str
output_id: str | None
status: CloudJobStatus = 0
class aihwkit.cloud.client.entities.CloudJobStatus(value)[source]

Bases: Enum

Status for a CloudJob.

COMPLETED = 3
FAILED = 4
RUNNING = 2
UNKNOWN = 0
WAITING = 1