Cloud AI Platform v1 API - Class HyperparameterTuningJob (3.7.0) 

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

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

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

Inheritance

object > HyperparameterTuningJob

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

HyperparameterTuningJob()

public HyperparameterTuningJob()

HyperparameterTuningJob(HyperparameterTuningJob)

public HyperparameterTuningJob(HyperparameterTuningJob other)
Parameter
Name Description
other HyperparameterTuningJob

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time when the HyperparameterTuningJob was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

Property Value
Type Description
EncryptionSpec

EndTime

public Timestamp EndTime { get; set; }

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

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

HyperparameterTuningJobName

public HyperparameterTuningJobName HyperparameterTuningJobName { get; set; }

HyperparameterTuningJobName-typed view over the Name resource name property.

Property Value
Type Description
HyperparameterTuningJobName

Labels

public MapField<string, string> Labels { get; }

The labels with user-defined metadata to organize HyperparameterTuningJobs.

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

MaxFailedTrialCount

public int MaxFailedTrialCount { get; set; }

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

Property Value
Type Description
int

MaxTrialCount

public int MaxTrialCount { get; set; }

Required. The desired total number of Trials.

Property Value
Type Description
int

Name

public string Name { get; set; }

Output only. Resource name of the HyperparameterTuningJob.

Property Value
Type Description
string

ParallelTrialCount

public int ParallelTrialCount { get; set; }

Required. The desired number of Trials to run in parallel.

Property Value
Type Description
int

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

StartTime

public Timestamp StartTime { get; set; }

Output only. Time when the HyperparameterTuningJob 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

StudySpec

public StudySpec StudySpec { get; set; }

Required. Study configuration of the HyperparameterTuningJob.

Property Value
Type Description
StudySpec

TrialJobSpec

public CustomJobSpec TrialJobSpec { get; set; }

Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

Property Value
Type Description
CustomJobSpec

Trials

public RepeatedField<Trial> Trials { get; }

Output only. Trials of the HyperparameterTuningJob.

Property Value
Type Description
RepeatedFieldTrial

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time when the HyperparameterTuningJob was most recently updated.

Property Value
Type Description
Timestamp