Google Cloud Ai Platform V1 Client - Class CompleteTrialRequest (1.40.0)

Version latest

• 1.40.0 (latest)
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 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 CompleteTrialRequest.

Request message for VizierService.CompleteTrial.

Generated from protobuf message google.cloud.aiplatform.v1.CompleteTrialRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
↳ final_measurement	Measurement Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement
↳ trial_infeasible	bool Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.
↳ infeasible_reason	string Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

getName

Required. The Trial's name.

Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Returns
Type	Description
string

setName

Required. The Trial's name.

Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFinalMeasurement

Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

Returns
Type	Description
Measurement|null

hasFinalMeasurement

clearFinalMeasurement

setFinalMeasurement

Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

Parameter
Name	Description
var	Measurement

Returns
Type	Description
$this

getTrialInfeasible

Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.

Returns
Type	Description
bool

setTrialInfeasible

Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInfeasibleReason

Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

Returns
Type	Description
string

setInfeasibleReason

Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

Parameter
Name	Description
var	string

Returns
Type	Description
$this