Cloud AI Platform v1 API - Class Trial (2.19.0)

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

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

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

Implements

IMessage Trial, IEquatable Trial, IDeepCloneable Trial, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Trial()

public Trial()

Trial(Trial)

public Trial(Trial other)

Parameter
Name	Description
`other`	`Trial`

Properties

ClientId

public string ClientId { get; set; }

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.

Property Value
Type	Description
`string`

CustomJob

public string CustomJob { get; set; }

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

Property Value
Type	Description
`string`

CustomJobAsCustomJobName

public CustomJobName CustomJobAsCustomJobName { get; set; }

CustomJobName-typed view over the CustomJob resource name property.

Property Value
Type	Description
`CustomJobName`

EndTime

public Timestamp EndTime { get; set; }

Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.

Property Value
Type	Description
`Timestamp`

FinalMeasurement

public Measurement FinalMeasurement { get; set; }

Output only. The final measurement containing the objective value.

Property Value
Type	Description
`Measurement`

Id

public string Id { get; set; }

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

Property Value
Type	Description
`string`

InfeasibleReason

public string InfeasibleReason { get; set; }

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

Property Value
Type	Description
`string`

Measurements

public RepeatedField<Measurement> Measurements { get; }

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.

Property Value
Type	Description
`RepeatedFieldMeasurement`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

Parameters

public RepeatedField<Trial.Types.Parameter> Parameters { get; }

Output only. The parameters of the Trial.

Property Value
Type	Description
`RepeatedFieldTrialTypesParameter`

StartTime

public Timestamp StartTime { get; set; }

Output only. Time when the Trial was started.

Property Value
Type	Description
`Timestamp`

State

public Trial.Types.State State { get; set; }

Output only. The detailed state of the Trial.

Property Value
Type	Description
`TrialTypesState`

TrialName

public TrialName TrialName { get; set; }

TrialName-typed view over the Name resource name property.

Property Value
Type	Description
`TrialName`

WebAccessUris

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

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] and the job's [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.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.

Property Value
Type	Description
`MapFieldstringstring`