Cloud AI Platform v1 API - Class TuningJob (2.27.0)

Version latest

• 2.27.0 (latest)
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class TuningJob : IMessage<TuningJob>, IEquatable<TuningJob>, IDeepCloneable<TuningJob>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class TuningJob.

Represents a TuningJob that runs with Google owned models.

Inheritance

object > TuningJob

Implements

IMessageTuningJob, IEquatableTuningJob, IDeepCloneableTuningJob, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TuningJob()

public TuningJob()

TuningJob(TuningJob)

public TuningJob(TuningJob other)

Parameter
Name	Description
other	TuningJob

Properties

BaseModel

public string BaseModel { get; set; }

Model name for tuning, e.g., "gemini-1.0-pro-002".

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

Description

public string Description { get; set; }

Optional. The description of the [TuningJob][google.cloud.aiplatform.v1.TuningJob].

Property Value
Type	Description
string

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

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 assiociated 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