Class TuningJob (1.104.0) 

TuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a TuningJob that runs with Google owned models.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
base_model str
The base model that is being tuned. See `Supported models
supervised_tuning_spec google.cloud.aiplatform_v1beta1.types.SupervisedTuningSpec
Tuning Spec for Supervised Fine Tuning. This field is a member of oneof_ tuning_spec.
distillation_spec google.cloud.aiplatform_v1beta1.types.DistillationSpec
Tuning Spec for Distillation. This field is a member of oneof_ tuning_spec.
partner_model_tuning_spec google.cloud.aiplatform_v1beta1.types.PartnerModelTuningSpec
Tuning Spec for open sourced and third party Partner models. This field is a member of oneof_ tuning_spec.
name str
Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}
tuned_model_display_name str
Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description str
Optional. The description of the TuningJob.
custom_base_model str
Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models.
state google.cloud.aiplatform_v1beta1.types.JobState
Output only. The detailed state of the job.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the TuningJob was created.
start_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the TuningJob for the first time entered the JOB_STATE_RUNNING state.
end_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the TuningJob entered any of the following JobStates: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the TuningJob was most recently updated.
error google.rpc.status_pb2.Status
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
labels MutableMapping[str, str]
Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
experiment str
Output only. The Experiment associated with this TuningJob.
tuned_model google.cloud.aiplatform_v1beta1.types.TunedModel
Output only. The tuned model resources associated with this TuningJob.
tuning_data_stats google.cloud.aiplatform_v1beta1.types.TuningDataStats
Output only. The tuning data statistics associated with this TuningJob.
pipeline_job str
Output only. The resource name of the PipelineJob associated with the TuningJob. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}.
encryption_spec google.cloud.aiplatform_v1beta1.types.EncryptionSpec
Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.
service_account str
The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
output_uri str
Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Methods

TuningJob

TuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a TuningJob that runs with Google owned models.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields