- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client 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.
Generated from protobuf message google.cloud.aiplatform.v1.Trial
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of the Trial assigned by the service.
↳ id
string
Output only. The identifier of the Trial assigned by the service.
↳ state
int
Output only. The detailed state of the Trial.
↳ parameters
↳ final_measurement
Google\Cloud\AIPlatform\V1\Measurement
Output only. The final measurement containing the objective value.
↳ measurements
array< Google\Cloud\AIPlatform\V1\Measurement
>
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.
↳ start_time
↳ end_time
Google\Protobuf\Timestamp
Output only. Time when the Trial's status changed to SUCCEEDED
or INFEASIBLE
.
↳ client_id
string
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.
↳ infeasible_reason
string
Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE
.
↳ custom_job
string
Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
↳ web_access_uris
array| Google\Protobuf\Internal\MapField
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.
getName
Output only. Resource name of the Trial assigned by the service.
string
setName
Output only. Resource name of the Trial assigned by the service.
var
string
$this
getId
Output only. The identifier of the Trial assigned by the service.
string
setId
Output only. The identifier of the Trial assigned by the service.
var
string
$this
getState
Output only. The detailed state of the Trial.
int
setState
Output only. The detailed state of the Trial.
var
int
$this
getParameters
Output only. The parameters of the Trial.
setParameters
Output only. The parameters of the Trial.
$this
getFinalMeasurement
Output only. The final measurement containing the objective value.
hasFinalMeasurement
clearFinalMeasurement
setFinalMeasurement
Output only. The final measurement containing the objective value.
$this
getMeasurements
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.
setMeasurements
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.
$this
getStartTime
Output only. Time when the Trial was started.
hasStartTime
clearStartTime
setStartTime
Output only. Time when the Trial was started.
$this
getEndTime
Output only. Time when the Trial's status changed to SUCCEEDED
or INFEASIBLE
.
hasEndTime
clearEndTime
setEndTime
Output only. Time when the Trial's status changed to SUCCEEDED
or INFEASIBLE
.
$this
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
setClientId
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.
var
string
$this
getInfeasibleReason
Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE
.
string
setInfeasibleReason
Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE
.
var
string
$this
getCustomJob
Output only. The CustomJob name linked to the Trial.
It's set for a HyperparameterTuningJob's Trial.
string
setCustomJob
Output only. The CustomJob name linked to the Trial.
It's set for a HyperparameterTuningJob's Trial.
var
string
$this
getWebAccessUris
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.
setWebAccessUris
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.
$this
