`viam.app.ml_training_client`

Module Contents

gRPC client for working with ML training jobs.

class viam.app.ml_training_client.MLTrainingClient(channel: grpclib.client.Channel, metadata: Mapping[str, str])[source]

gRPC client for working with ML training jobs.

Constructor is used by ViamClient to instantiate relevant service stubs. Calls to MLTrainingClient methods should be made through ViamClient.

abstract async submit_training_job(org_id: str, model_name: str, model_version: str, model_type: viam.proto.app.mltraining.ModelType, tags: List[str], filter: Optional[viam.proto.app.data.Filter] = None) → str[source]

Gets training job data.

async list_training_jobs(org_id: str, training_status: Optional[viam.proto.app.mltraining.TrainingStatus.ValueType] = None) → List[viam.proto.app.mltraining.TrainingJobMetadata][source]

Returns training job data for all jobs within an org.

Parameters:

org_id (str) – the id of the org to request training job data from.
training_status (Optional[TrainingStatus]) – status of training jobs to filter the list by.
unspecified (If) –
returned. (all training jobs will be) –

Returns:

a list of training job data.

Return type:

List[viam.proto.app.mltraining.TrainingJobMetadata]

async cancel_training_job(id: str) → None[source]

Cancels the specified training job.