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 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 viam.gen.app.mltraining.v1.ml_training_pb2.Global___TrainingJobLogEntry viam.gen.app.mltraining.v1.ml_training_pb2.Global___GetTrainingJobLogsRequest viam.gen.app.mltraining.v1.ml_training_pb2.Global___GetTrainingJobLogsResponse viam.gen.app.mltraining.v1.ml_training_pb2.Global___ListSupportedContainersRequest viam.gen.app.mltraining.v1.ml_training_pb2.Global___ListSupportedContainersResponse viam.gen.app.mltraining.v1.ml_training_pb2.Global___Container 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 viam.gen.app.mltraining.v1.ml_training_pb2.TrainingJobLogEntry viam.gen.app.mltraining.v1.ml_training_pb2.GetTrainingJobLogsRequest viam.gen.app.mltraining.v1.ml_training_pb2.GetTrainingJobLogsResponse viam.gen.app.mltraining.v1.ml_training_pb2.ListSupportedContainersRequest viam.gen.app.mltraining.v1.ml_training_pb2.ListSupportedContainersResponse viam.gen.app.mltraining.v1.ml_training_pb2.Container Module Contents --------------- .. 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:type:: Global___ModelType :canonical: 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:type:: Global___ModelFramework :canonical: 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:type:: Global___TrainingStatus :canonical: TrainingStatus .. py:class:: SubmitTrainingJobRequest(*, dataset_id: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ..., model_type: Global___ModelType = ..., model_framework: Global___ModelFramework = ..., 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: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:method:: tags() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:type:: Global___SubmitTrainingJobRequest :canonical: 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:type:: Global___SubmitTrainingJobResponse :canonical: SubmitTrainingJobResponse .. py:class:: SubmitCustomTrainingJobRequest(*, dataset_id: str = ..., registry_item_id: str = ..., registry_item_version: str = ..., organization_id: str = ..., model_name: str = ..., model_version: str = ..., arguments: collections.abc.Mapping[str, str] | None = ..., container_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:class:: ArgumentsEntry(*, key: str = ..., value: 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:: key :type: str .. py:attribute:: value :type: str .. 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:attribute:: container_version :type: str .. py:method:: arguments() -> google.protobuf.internal.containers.ScalarMap[str, str] .. py:type:: Global___SubmitCustomTrainingJobRequest :canonical: 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:type:: Global___SubmitCustomTrainingJobResponse :canonical: 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:type:: Global___GetTrainingJobRequest :canonical: 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:method:: metadata() -> Global___TrainingJobMetadata .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___GetTrainingJobResponse :canonical: 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:type:: Global___ListTrainingJobsRequest :canonical: 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:method:: jobs() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___TrainingJobMetadata] .. py:type:: Global___ListTrainingJobsResponse :canonical: ListTrainingJobsResponse .. py:class:: TrainingJobMetadata(*, 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 = ..., arguments: collections.abc.Mapping[str, str] | None = ..., container_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:class:: ArgumentsEntry(*, key: str = ..., value: 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:: key :type: str .. py:attribute:: value :type: 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:attribute:: container_version :type: str .. py:method:: error_status() -> google.rpc.status_pb2.Status .. py:method:: created_on() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: last_modified() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: training_started() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: training_ended() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: tags() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:method:: arguments() -> google.protobuf.internal.containers.ScalarMap[str, str] .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___TrainingJobMetadata :canonical: 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:type:: Global___CancelTrainingJobRequest :canonical: 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:type:: Global___CancelTrainingJobResponse :canonical: 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:type:: Global___DeleteCompletedTrainingJobRequest :canonical: 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:type:: Global___DeleteCompletedTrainingJobResponse :canonical: DeleteCompletedTrainingJobResponse .. py:class:: TrainingJobLogEntry(*, level: str = ..., time: google.protobuf.timestamp_pb2.Timestamp | None = ..., message: 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:: level :type: str .. py:attribute:: message :type: str .. py:method:: time() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___TrainingJobLogEntry :canonical: TrainingJobLogEntry .. py:class:: GetTrainingJobLogsRequest(*, id: str = ..., page_token: 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:attribute:: id :type: str .. py:attribute:: page_token :type: str .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:method:: WhichOneof(oneof_group: _WhichOneofArgType__page_token) -> _WhichOneofReturnType__page_token | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___GetTrainingJobLogsRequest :canonical: GetTrainingJobLogsRequest .. py:class:: GetTrainingJobLogsResponse(*, logs: collections.abc.Iterable[Global___TrainingJobLogEntry] | None = ..., next_page_token: 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:: next_page_token :type: str .. py:method:: logs() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___TrainingJobLogEntry] .. py:type:: Global___GetTrainingJobLogsResponse :canonical: GetTrainingJobLogsResponse .. py:class:: ListSupportedContainersRequest 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:type:: Global___ListSupportedContainersRequest :canonical: ListSupportedContainersRequest .. py:class:: ListSupportedContainersResponse(*, container_map: collections.abc.Mapping[str, Global___Container] | 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:class:: ContainerMapEntry(*, key: str = ..., value: Global___Container | 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:attribute:: key :type: str .. py:method:: value() -> Global___Container .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:method:: container_map() -> google.protobuf.internal.containers.MessageMap[str, Global___Container] ex value: container_map: { "tf:2.15": Container { key: "tf:2.15" uri: "us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-15.py310:latest" description: "Tensorflow 2.15" eol: { seconds: 1772630400, nanos: 0 } // 2026-03-03T00:00:00Z } } .. py:type:: Global___ListSupportedContainersResponse :canonical: ListSupportedContainersResponse .. py:class:: Container(*, key: str = ..., uri: str = ..., framework: str = ..., description: str = ..., eol: google.protobuf.timestamp_pb2.Timestamp | 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:attribute:: key :type: str .. py:attribute:: uri :type: str .. py:attribute:: framework :type: str .. py:attribute:: description :type: str .. py:method:: eol() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___Container :canonical: Container