Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::CompleteTrialRequest (v0.38.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::CompleteTrialRequest.

Request message for VizierService.CompleteTrial.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#final_measurement

def final_measurement() -> ::Google::Cloud::AIPlatform::V1::Measurement
Returns
  • (::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

#final_measurement=

def final_measurement=(value) -> ::Google::Cloud::AIPlatform::V1::Measurement
Parameter
  • value (::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
Returns
  • (::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

#infeasible_reason

def infeasible_reason() -> ::String
Returns
  • (::String) — Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

#infeasible_reason=

def infeasible_reason=(value) -> ::String
Parameter
  • value (::String) — Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.
Returns
  • (::String) — Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

#name

def name() -> ::String
Returns
  • (::String) — Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
Returns
  • (::String) — Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

#trial_infeasible

def trial_infeasible() -> ::Boolean
Returns
  • (::Boolean) — Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.

#trial_infeasible=

def trial_infeasible=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.
Returns
  • (::Boolean) — Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.