Class GoogleCloudAiplatformV1HyperparameterTuningJob

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

Inheritance

object

GoogleCloudAiplatformV1HyperparameterTuningJob

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1HyperparameterTuningJob : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Time when the HyperparameterTuningJob was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DisplayName

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

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EncryptionSpec

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.

Declaration

[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1EncryptionSpec

EndTime

object representation of EndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }

Property Value

Type	Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EndTimeRaw

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

Declaration

[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }

Property Value

Type	Description
string

Error

Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Declaration

[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }

Property Value

Type	Description
GoogleRpcStatus

Labels

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.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

MaxFailedTrialCount

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.

Declaration

[JsonProperty("maxFailedTrialCount")]
public virtual int? MaxFailedTrialCount { get; set; }

Property Value

Type	Description
int?

MaxTrialCount

Required. The desired total number of Trials.

Declaration

[JsonProperty("maxTrialCount")]
public virtual int? MaxTrialCount { get; set; }

Property Value

Type	Description
int?

Name

Output only. Resource name of the HyperparameterTuningJob.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ParallelTrialCount

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

Declaration

[JsonProperty("parallelTrialCount")]
public virtual int? ParallelTrialCount { get; set; }

Property Value

Type	Description
int?

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

StartTime

object representation of StartTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }

Property Value

Type	Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

StartTimeRaw

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

Declaration

[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }

Property Value

Type	Description
string

State

Output only. The detailed state of the job.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

StudySpec

Required. Study configuration of the HyperparameterTuningJob.

Declaration

[JsonProperty("studySpec")]
public virtual GoogleCloudAiplatformV1StudySpec StudySpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1StudySpec

TrialJobSpec

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

Declaration

[JsonProperty("trialJobSpec")]
public virtual GoogleCloudAiplatformV1CustomJobSpec TrialJobSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1CustomJobSpec

Trials

Output only. Trials of the HyperparameterTuningJob.

Declaration

[JsonProperty("trials")]
public virtual IList<GoogleCloudAiplatformV1Trial> Trials { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1Trial>

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema