Google Cloud Ai Platform V1 Client - Class CompleteTrialRequest (0.13.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

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\AIPlatform\V1\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
TypeDescription
string

setName

Required. The Trial's name.

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

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

getTrialInfeasible

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

Returns
TypeDescription
bool

setTrialInfeasible

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getInfeasibleReason

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

Returns
TypeDescription
string

setInfeasibleReason

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this