Show / Hide Table of Contents

Class GoogleCloudAiplatformV1Trial

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

Inheritance
object
GoogleCloudAiplatformV1Trial
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 GoogleCloudAiplatformV1Trial : IDirectResponseSchema

Properties

ClientId

Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.

Declaration
[JsonProperty("clientId")]
public virtual string ClientId { get; set; }
Property Value
Type Description
string

CustomJob

Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.

Declaration
[JsonProperty("customJob")]
public virtual string CustomJob { 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

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 Trial's status changed to SUCCEEDED or INFEASIBLE.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

FinalMeasurement

Output only. The final measurement containing the objective value.

Declaration
[JsonProperty("finalMeasurement")]
public virtual GoogleCloudAiplatformV1Measurement FinalMeasurement { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1Measurement

Id

Output only. The identifier of the Trial assigned by the service.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

InfeasibleReason

Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.

Declaration
[JsonProperty("infeasibleReason")]
public virtual string InfeasibleReason { get; set; }
Property Value
Type Description
string

Measurements

Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.

Declaration
[JsonProperty("measurements")]
public virtual IList<GoogleCloudAiplatformV1Measurement> Measurements { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1Measurement>

Name

Output only. Resource name of the Trial assigned by the service.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Parameters

Output only. The parameters of the Trial.

Declaration
[JsonProperty("parameters")]
public virtual IList<GoogleCloudAiplatformV1TrialParameter> Parameters { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1TrialParameter>

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 Trial was started.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

State

Output only. The detailed state of the Trial.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

WebAccessUris

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is true. The keys are names of each node used for the trial; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool. The values are the URIs for each node's interactive shell.

Declaration
[JsonProperty("webAccessUris")]
public virtual IDictionary<string, string> WebAccessUris { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX