Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::SuggestTrialsRequest (v0.14.0)

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

Request message for VizierService.SuggestTrials.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#client_id

def client_id() -> ::String
Returns
  • (::String) — Required. The identifier of the client that is requesting the suggestion.

    If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

#client_id=

def client_id=(value) -> ::String
Parameter
  • value (::String) — Required. The identifier of the client that is requesting the suggestion.

    If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

Returns
  • (::String) — Required. The identifier of the client that is requesting the suggestion.

    If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}
Returns
  • (::String) — Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

#suggestion_count

def suggestion_count() -> ::Integer
Returns
  • (::Integer) — Required. The number of suggestions requested. It must be positive.

#suggestion_count=

def suggestion_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. The number of suggestions requested. It must be positive.
Returns
  • (::Integer) — Required. The number of suggestions requested. It must be positive.