Google Cloud Ai Platform V1 Client - Class Trial (0.26.2)

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 array<Google\Cloud\AIPlatform\V1\Trial\Parameter>

Output only. The parameters of the Trial.

↳ 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 Google\Protobuf\Timestamp

Output only. Time when the Trial was started.

↳ 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.

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

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

Returns
TypeDescription
string

setId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The detailed state of the Trial.

Returns
TypeDescription
int

setState

Output only. The detailed state of the Trial.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getParameters

Output only. The parameters of the Trial.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParameters

Output only. The parameters of the Trial.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\Trial\Parameter>
Returns
TypeDescription
$this

getFinalMeasurement

Output only. The final measurement containing the objective value.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Measurement|null

hasFinalMeasurement

clearFinalMeasurement

setFinalMeasurement

Output only. The final measurement containing the objective value.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\Measurement
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\Measurement>
Returns
TypeDescription
$this

getStartTime

Output only. Time when the Trial was started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Time when the Trial was started.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInfeasibleReason

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

Returns
TypeDescription
string

setInfeasibleReason

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomJob

Output only. The CustomJob name linked to the Trial.

It's set for a HyperparameterTuningJob's Trial.

Returns
TypeDescription
string

setCustomJob

Output only. The CustomJob name linked to the Trial.

It's set for a HyperparameterTuningJob's Trial.

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this