public sealed class TuningJob : IMessage<TuningJob>, IEquatable<TuningJob>, IDeepCloneable<TuningJob>, IBufferMessage, IMessageReference documentation and code samples for the Vertex AI v1beta1 API class TuningJob.
Represents a TuningJob that runs with Google owned models.
Implements
IMessageTuningJob, IEquatableTuningJob, IDeepCloneableTuningJob, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
TuningJob()
public TuningJob()TuningJob(TuningJob)
public TuningJob(TuningJob other)| Parameter | |
|---|---|
| Name | Description |
other |
TuningJob |
Properties
BaseModel
public string BaseModel { get; set; }The base model that is being tuned. See Supported models.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time when the [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
CustomBaseModel
public string CustomBaseModel { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Description
public string Description { get; set; }Optional. The description of the [TuningJob][google.cloud.aiplatform.v1.TuningJob].
| Property Value | |
|---|---|
| Type | Description |
string |
|
DistillationSpec
public DistillationSpec DistillationSpec { get; set; }Tuning Spec for Distillation.
| Property Value | |
|---|---|
| Type | Description |
DistillationSpec |
|
EncryptionSpec
public EncryptionSpec EncryptionSpec { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
EncryptionSpec |
|
EndTime
public Timestamp EndTime { get; set; }Output only. Time when the TuningJob entered any of the following
[JobStates][google.cloud.aiplatform.v1.JobState]: JOB_STATE_SUCCEEDED,
JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Error
public Status Error { get; set; }Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
| Property Value | |
|---|---|
| Type | Description |
Status |
|
Experiment
public string Experiment { get; set; }Output only. The Experiment associated with this [TuningJob][google.cloud.aiplatform.v1.TuningJob].
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExperimentAsContextName
public ContextName ExperimentAsContextName { get; set; }ContextName-typed view over the Experiment resource name property.
| Property Value | |
|---|---|
| Type | Description |
ContextName |
|
HasBaseModel
public bool HasBaseModel { get; }Gets whether the "base_model" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Labels
public MapField<string, string> Labels { get; }Optional. The labels with user-defined metadata to organize [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources such as [Model][google.cloud.aiplatform.v1.Model] and [Endpoint][google.cloud.aiplatform.v1.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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }Output only. Identifier. Resource name of a TuningJob. Format:
projects/{project}/locations/{location}/tuningJobs/{tuning_job}
| Property Value | |
|---|---|
| Type | Description |
string |
|
OutputUri
public string OutputUri { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PartnerModelTuningSpec
public PartnerModelTuningSpec PartnerModelTuningSpec { get; set; }Tuning Spec for open sourced and third party Partner models.
| Property Value | |
|---|---|
| Type | Description |
PartnerModelTuningSpec |
|
PipelineJob
public string PipelineJob { get; set; }Output only. The resource name of the PipelineJob associated with the
[TuningJob][google.cloud.aiplatform.v1.TuningJob]. Format:
projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PipelineJobAsPipelineJobName
public PipelineJobName PipelineJobAsPipelineJobName { get; set; }PipelineJobName-typed view over the PipelineJob resource name property.
| Property Value | |
|---|---|
| Type | Description |
PipelineJobName |
|
ServiceAccount
public string ServiceAccount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceModelCase
public TuningJob.SourceModelOneofCase SourceModelCase { get; }| Property Value | |
|---|---|
| Type | Description |
TuningJobSourceModelOneofCase |
|
StartTime
public Timestamp StartTime { get; set; }Output only. Time when the
[TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
entered the JOB_STATE_RUNNING state.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
State
public JobState State { get; set; }Output only. The detailed state of the job.
| Property Value | |
|---|---|
| Type | Description |
JobState |
|
SupervisedTuningSpec
public SupervisedTuningSpec SupervisedTuningSpec { get; set; }Tuning Spec for Supervised Fine Tuning.
| Property Value | |
|---|---|
| Type | Description |
SupervisedTuningSpec |
|
TunedModel
public TunedModel TunedModel { get; set; }Output only. The tuned model resources associated with this [TuningJob][google.cloud.aiplatform.v1.TuningJob].
| Property Value | |
|---|---|
| Type | Description |
TunedModel |
|
TunedModelDisplayName
public string TunedModelDisplayName { get; set; }Optional. The display name of the [TunedModel][google.cloud.aiplatform.v1.Model]. The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TuningDataStats
public TuningDataStats TuningDataStats { get; set; }Output only. The tuning data statistics associated with this [TuningJob][google.cloud.aiplatform.v1.TuningJob].
| Property Value | |
|---|---|
| Type | Description |
TuningDataStats |
|
TuningJobName
public TuningJobName TuningJobName { get; set; }TuningJobName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
TuningJobName |
|
TuningSpecCase
public TuningJob.TuningSpecOneofCase TuningSpecCase { get; }| Property Value | |
|---|---|
| Type | Description |
TuningJobTuningSpecOneofCase |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Time when the [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|