public final class Trial extends GeneratedMessageV3 implements TrialOrBuilder
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.
Protobuf type google.cloud.aiplatform.v1beta1.Trial
Static Fields
public static final int CLIENT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CUSTOM_JOB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FINAL_MEASUREMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INFEASIBLE_REASON_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MEASUREMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int WEB_ACCESS_URIS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Trial getDefaultInstance()
| Returns |
|---|
| Type | Description |
Trial | |
public static final Descriptors.Descriptor getDescriptor()
public static Trial.Builder newBuilder()
public static Trial.Builder newBuilder(Trial prototype)
| Parameter |
|---|
| Name | Description |
prototype | Trial
|
public static Trial parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Trial | |
public static Trial parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Trial | |
public static Parser<Trial> parser()
Methods
public boolean containsWebAccessUris(String key)
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.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public String getClientId()
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.
string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The clientId.
|
public ByteString getClientIdBytes()
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.
string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clientId.
|
public String getCustomJob()
Output only. The CustomJob name linked to the Trial.
It's set for a HyperparameterTuningJob's Trial.
string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The customJob.
|
public ByteString getCustomJobBytes()
Output only. The CustomJob name linked to the Trial.
It's set for a HyperparameterTuningJob's Trial.
string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for customJob.
|
public Trial getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Trial | |
public Timestamp getEndTime()
Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Measurement getFinalMeasurement()
Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public MeasurementOrBuilder getFinalMeasurementOrBuilder()
Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Output only. The identifier of the Trial assigned by the service.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The id.
|
public ByteString getIdBytes()
Output only. The identifier of the Trial assigned by the service.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getInfeasibleReason()
Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE.
string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The infeasibleReason.
|
public ByteString getInfeasibleReasonBytes()
Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE.
string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for infeasibleReason.
|
public Measurement getMeasurements(int index)
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.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
public int getMeasurementsCount()
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.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
public List<Measurement> getMeasurementsList()
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.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public MeasurementOrBuilder getMeasurementsOrBuilder(int index)
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.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends MeasurementOrBuilder> getMeasurementsOrBuilderList()
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.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.MeasurementOrBuilder> | |
Output only. Resource name of the Trial assigned by the service.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Output only. Resource name of the Trial assigned by the service.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Trial.Parameter getParameters(int index)
Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
public int getParametersCount()
Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
public List<Trial.Parameter> getParametersList()
Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Trial.ParameterOrBuilder getParametersOrBuilder(int index)
Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends Trial.ParameterOrBuilder> getParametersOrBuilderList()
Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.Trial.ParameterOrBuilder> | |
public Parser<Trial> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getStartTime()
Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Trial.State getState()
Output only. The detailed state of the Trial.
.google.cloud.aiplatform.v1beta1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. The detailed state of the Trial.
.google.cloud.aiplatform.v1beta1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
public final UnknownFieldSet getUnknownFields()
Overrides
public Map<String,String> getWebAccessUris()
public int getWebAccessUrisCount()
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.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getWebAccessUrisMap()
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.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getWebAccessUrisOrDefault(String key, String defaultValue)
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.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getWebAccessUrisOrThrow(String key)
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.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean hasEndTime()
Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasFinalMeasurement()
Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the finalMeasurement field is set.
|
public boolean hasStartTime()
Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public Trial.Builder newBuilderForType()
protected Trial.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Trial.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
