viam.proto.app.mltraining

@generated by Viam. Do not edit manually!

Package Contents

Classes

MLTrainingServiceBase	Helper class that provides a standard way to create an ABC using
MLTrainingServiceStub
UnimplementedMLTrainingServiceBase	Helper class that provides a standard way to create an ABC using
CancelTrainingJobRequest	Abstract base class for protocol messages.
CancelTrainingJobResponse	Abstract base class for protocol messages.
DeleteCompletedTrainingJobRequest	Abstract base class for protocol messages.
DeleteCompletedTrainingJobResponse	Abstract base class for protocol messages.
GetTrainingJobRequest	Abstract base class for protocol messages.
GetTrainingJobResponse	Abstract base class for protocol messages.
ListTrainingJobsRequest	Abstract base class for protocol messages.
ListTrainingJobsResponse	Abstract base class for protocol messages.
ModelFramework
ModelType
SubmitCustomTrainingJobRequest	Abstract base class for protocol messages.
SubmitCustomTrainingJobResponse	Abstract base class for protocol messages.
SubmitTrainingJobRequest	Abstract base class for protocol messages.
SubmitTrainingJobResponse	Abstract base class for protocol messages.
TrainingJobMetadata	Abstract base class for protocol messages.
TrainingStatus

class viam.proto.app.mltraining.MLTrainingServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async SubmitTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.SubmitTrainingJobRequest, app.mltraining.v1.ml_training_pb2.SubmitTrainingJobResponse]) → None

abstract async SubmitCustomTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobRequest, app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobResponse]) → None

abstract async GetTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.GetTrainingJobRequest, app.mltraining.v1.ml_training_pb2.GetTrainingJobResponse]) → None

abstract async ListTrainingJobs(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.ListTrainingJobsRequest, app.mltraining.v1.ml_training_pb2.ListTrainingJobsResponse]) → None

abstract async CancelTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.CancelTrainingJobRequest, app.mltraining.v1.ml_training_pb2.CancelTrainingJobResponse]) → None

abstract async DeleteCompletedTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobRequest, app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobResponse]) → None

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.app.mltraining.MLTrainingServiceStub(channel: grpclib.client.Channel)

class viam.proto.app.mltraining.UnimplementedMLTrainingServiceBase

Bases: MLTrainingServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async SubmitTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.SubmitTrainingJobRequest, app.mltraining.v1.ml_training_pb2.SubmitTrainingJobResponse]) → None

async SubmitCustomTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobRequest, app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobResponse]) → None

async GetTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.GetTrainingJobRequest, app.mltraining.v1.ml_training_pb2.GetTrainingJobResponse]) → None

async ListTrainingJobs(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.ListTrainingJobsRequest, app.mltraining.v1.ml_training_pb2.ListTrainingJobsResponse]) → None

async CancelTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.CancelTrainingJobRequest, app.mltraining.v1.ml_training_pb2.CancelTrainingJobResponse]) → None

async DeleteCompletedTrainingJob(stream: grpclib.server.Stream[app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobRequest, app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobResponse]) → None

class viam.proto.app.mltraining.CancelTrainingJobRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.mltraining.CancelTrainingJobResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.mltraining.DeleteCompletedTrainingJobRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.mltraining.DeleteCompletedTrainingJobResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.mltraining.GetTrainingJobRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.mltraining.GetTrainingJobResponse(*, metadata: global___TrainingJobMetadata | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property metadata: global___TrainingJobMetadata

HasField(field_name: Literal[metadata, b'metadata']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.mltraining.ListTrainingJobsRequest(*, organization_id: str = ..., status: global___TrainingStatus = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

status: global___TrainingStatus

class viam.proto.app.mltraining.ListTrainingJobsResponse(*, jobs: collections.abc.Iterable[global___TrainingJobMetadata] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property jobs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___TrainingJobMetadata]

class viam.proto.app.mltraining.ModelFramework

Bases: _ModelFramework

class viam.proto.app.mltraining.ModelType

Bases: _ModelType

class viam.proto.app.mltraining.SubmitCustomTrainingJobRequest(*, dataset_id: str = ..., registry_item_id: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

dataset_id: str

registry_item_id: str

organization_id: str

model_name: str

model_version: str

class viam.proto.app.mltraining.SubmitCustomTrainingJobResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.mltraining.SubmitTrainingJobRequest(*, dataset_id: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ..., model_type: global___ModelType = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

dataset_id: str

organization_id: str

model_name: str

model_version: str

model_type: global___ModelType

class viam.proto.app.mltraining.SubmitTrainingJobResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.mltraining.TrainingJobMetadata(*, request: global___SubmitTrainingJobRequest | None = ..., id: str = ..., dataset_id: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ..., model_type: global___ModelType = ..., model_framework: global___ModelFramework = ..., is_custom_job: bool = ..., registry_item_id: str = ..., status: global___TrainingStatus = ..., error_status: google.rpc.status_pb2.Status | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., last_modified: google.protobuf.timestamp_pb2.Timestamp | None = ..., training_started: google.protobuf.timestamp_pb2.Timestamp | None = ..., training_ended: google.protobuf.timestamp_pb2.Timestamp | None = ..., synced_model_id: str = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property request: global___SubmitTrainingJobRequest

property error_status: google.rpc.status_pb2.Status

property created_on: google.protobuf.timestamp_pb2.Timestamp

property last_modified: google.protobuf.timestamp_pb2.Timestamp

property training_started: google.protobuf.timestamp_pb2.Timestamp

property training_ended: google.protobuf.timestamp_pb2.Timestamp

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

id: str

dataset_id: str

organization_id: str

model_name: str

model_version: str

model_type: global___ModelType

model_framework: global___ModelFramework

is_custom_job: bool

registry_item_id: str

status: global___TrainingStatus

synced_model_id: str

HasField(field_name: Literal[created_on, b'created_on', error_status, b'error_status', last_modified, b'last_modified', request, b'request', training_ended, b'training_ended', training_started, b'training_started']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.mltraining.TrainingStatus

Bases: _TrainingStatus