:py:mod:`viam.gen.app.mltraining.v1.ml_training_pb2` ==================================================== .. py:module:: viam.gen.app.mltraining.v1.ml_training_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework viam.gen.app.mltraining.v1.ml_training_pb2.TrainingStatus viam.gen.app.mltraining.v1.ml_training_pb2.SubmitTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.SubmitTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.SubmitCustomTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.GetTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.GetTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.ListTrainingJobsRequest viam.gen.app.mltraining.v1.ml_training_pb2.ListTrainingJobsResponse viam.gen.app.mltraining.v1.ml_training_pb2.TrainingJobMetadata viam.gen.app.mltraining.v1.ml_training_pb2.CancelTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.CancelTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.DeleteCompletedTrainingJobResponse Attributes ~~~~~~~~~~ .. autoapisummary:: viam.gen.app.mltraining.v1.ml_training_pb2.DESCRIPTOR viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_TYPE_UNSPECIFIED viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_TYPE_MULTI_LABEL_CLASSIFICATION viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_TYPE_OBJECT_DETECTION viam.gen.app.mltraining.v1.ml_training_pb2.global___ModelType viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_FRAMEWORK_UNSPECIFIED viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_FRAMEWORK_TFLITE viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_FRAMEWORK_TENSORFLOW viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_FRAMEWORK_PYTORCH viam.gen.app.mltraining.v1.ml_training_pb2.MODEL_FRAMEWORK_ONNX viam.gen.app.mltraining.v1.ml_training_pb2.global___ModelFramework viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_UNSPECIFIED viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_PENDING viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_IN_PROGRESS viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_COMPLETED viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_FAILED viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_CANCELED viam.gen.app.mltraining.v1.ml_training_pb2.TRAINING_STATUS_CANCELING viam.gen.app.mltraining.v1.ml_training_pb2.global___TrainingStatus viam.gen.app.mltraining.v1.ml_training_pb2.global___SubmitTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___SubmitTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.global___SubmitCustomTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___SubmitCustomTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.global___GetTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___GetTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.global___ListTrainingJobsRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___ListTrainingJobsResponse viam.gen.app.mltraining.v1.ml_training_pb2.global___TrainingJobMetadata viam.gen.app.mltraining.v1.ml_training_pb2.global___CancelTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___CancelTrainingJobResponse viam.gen.app.mltraining.v1.ml_training_pb2.global___DeleteCompletedTrainingJobRequest viam.gen.app.mltraining.v1.ml_training_pb2.global___DeleteCompletedTrainingJobResponse .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: ModelType Bases: :py:obj:`_ModelType` .. py:data:: MODEL_TYPE_UNSPECIFIED :type: ModelType .. py:data:: MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION :type: ModelType .. py:data:: MODEL_TYPE_MULTI_LABEL_CLASSIFICATION :type: ModelType .. py:data:: MODEL_TYPE_OBJECT_DETECTION :type: ModelType .. py:data:: global___ModelType .. py:class:: ModelFramework Bases: :py:obj:`_ModelFramework` .. py:data:: MODEL_FRAMEWORK_UNSPECIFIED :type: ModelFramework .. py:data:: MODEL_FRAMEWORK_TFLITE :type: ModelFramework .. py:data:: MODEL_FRAMEWORK_TENSORFLOW :type: ModelFramework .. py:data:: MODEL_FRAMEWORK_PYTORCH :type: ModelFramework .. py:data:: MODEL_FRAMEWORK_ONNX :type: ModelFramework .. py:data:: global___ModelFramework .. py:class:: TrainingStatus Bases: :py:obj:`_TrainingStatus` .. py:data:: TRAINING_STATUS_UNSPECIFIED :type: TrainingStatus .. py:data:: TRAINING_STATUS_PENDING :type: TrainingStatus .. py:data:: TRAINING_STATUS_IN_PROGRESS :type: TrainingStatus .. py:data:: TRAINING_STATUS_COMPLETED :type: TrainingStatus .. py:data:: TRAINING_STATUS_FAILED :type: TrainingStatus .. py:data:: TRAINING_STATUS_CANCELED :type: TrainingStatus .. py:data:: TRAINING_STATUS_CANCELING :type: TrainingStatus .. py:data:: global___TrainingStatus .. py:class:: SubmitTrainingJobRequest(*, dataset_id: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ..., model_type: global___ModelType = ..., tags: collections.abc.Iterable[str] | None = ...) Bases: :py:obj:`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. .. py:property:: tags :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:attribute:: dataset_id :type: str .. py:attribute:: organization_id :type: str .. py:attribute:: model_name :type: str .. py:attribute:: model_version :type: str .. py:attribute:: model_type :type: global___ModelType .. py:data:: global___SubmitTrainingJobRequest .. py:class:: SubmitTrainingJobResponse(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:data:: global___SubmitTrainingJobResponse .. py:class:: SubmitCustomTrainingJobRequest(*, dataset_id: str = ..., registry_item_id: str = ..., registry_item_version: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ...) Bases: :py:obj:`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. .. py:attribute:: dataset_id :type: str .. py:attribute:: registry_item_id :type: str .. py:attribute:: registry_item_version :type: str .. py:attribute:: organization_id :type: str .. py:attribute:: model_name :type: str .. py:attribute:: model_version :type: str .. py:data:: global___SubmitCustomTrainingJobRequest .. py:class:: SubmitCustomTrainingJobResponse(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:data:: global___SubmitCustomTrainingJobResponse .. py:class:: GetTrainingJobRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:data:: global___GetTrainingJobRequest .. py:class:: GetTrainingJobResponse(*, metadata: global___TrainingJobMetadata | None = ...) Bases: :py:obj:`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. .. py:property:: metadata :type: global___TrainingJobMetadata .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetTrainingJobResponse .. py:class:: ListTrainingJobsRequest(*, organization_id: str = ..., status: global___TrainingStatus = ...) Bases: :py:obj:`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. .. py:attribute:: organization_id :type: str .. py:attribute:: status :type: global___TrainingStatus .. py:data:: global___ListTrainingJobsRequest .. py:class:: ListTrainingJobsResponse(*, jobs: collections.abc.Iterable[global___TrainingJobMetadata] | None = ...) Bases: :py:obj:`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. .. py:property:: jobs :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___TrainingJobMetadata] .. py:data:: global___ListTrainingJobsResponse .. py:class:: 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 = ..., registry_item_version: 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: :py:obj:`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. .. py:property:: request :type: global___SubmitTrainingJobRequest .. py:property:: error_status :type: google.rpc.status_pb2.Status .. py:property:: created_on :type: google.protobuf.timestamp_pb2.Timestamp .. py:property:: last_modified :type: google.protobuf.timestamp_pb2.Timestamp .. py:property:: training_started :type: google.protobuf.timestamp_pb2.Timestamp .. py:property:: training_ended :type: google.protobuf.timestamp_pb2.Timestamp .. py:property:: tags :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:attribute:: id :type: str .. py:attribute:: dataset_id :type: str .. py:attribute:: organization_id :type: str .. py:attribute:: model_name :type: str .. py:attribute:: model_version :type: str .. py:attribute:: model_type :type: global___ModelType .. py:attribute:: model_framework :type: global___ModelFramework .. py:attribute:: is_custom_job :type: bool .. py:attribute:: registry_item_id :type: str .. py:attribute:: registry_item_version :type: str .. py:attribute:: status :type: global___TrainingStatus .. py:attribute:: synced_model_id :type: str .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___TrainingJobMetadata .. py:class:: CancelTrainingJobRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:data:: global___CancelTrainingJobRequest .. py:class:: CancelTrainingJobResponse Bases: :py:obj:`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. .. py:data:: global___CancelTrainingJobResponse .. py:class:: DeleteCompletedTrainingJobRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:data:: global___DeleteCompletedTrainingJobRequest .. py:class:: DeleteCompletedTrainingJobResponse Bases: :py:obj:`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. .. py:data:: global___DeleteCompletedTrainingJobResponse