Vertex AI Vizier API.
Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
VizierServiceClient(VizierServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VizierServiceClient const &
|
VizierServiceClient(VizierServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VizierServiceClient &&
|
VizierServiceClient(std::shared_ptr< VizierServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< VizierServiceConnection >
|
opts |
Options
|
Operators
operator=(VizierServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VizierServiceClient const &
|
Returns | |
---|---|
Type | Description |
VizierServiceClient & |
operator=(VizierServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VizierServiceClient &&
|
Returns | |
---|---|
Type | Description |
VizierServiceClient & |
Functions
CreateStudy(std::string const &, google::cloud::aiplatform::v1::Study const &, Options)
Creates a Study.
A resource name will be generated after creation of the Study.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the CustomJob in. Format: |
study |
google::cloud::aiplatform::v1::Study const &
Required. The Study configuration used to create the Study. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateStudy(google::cloud::aiplatform::v1::CreateStudyRequest const &, Options)
Creates a Study.
A resource name will be generated after creation of the Study.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateStudyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStudy(std::string const &, Options)
Gets a Study by name.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Study resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStudy(google::cloud::aiplatform::v1::GetStudyRequest const &, Options)
Gets a Study by name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetStudyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListStudies(std::string const &, Options)
Lists all the studies in a region for an associated project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the Study from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Study > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListStudies(google::cloud::aiplatform::v1::ListStudiesRequest, Options)
Lists all the studies in a region for an associated project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListStudiesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Study > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteStudy(std::string const &, Options)
Deletes a Study.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Study resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteStudy(google::cloud::aiplatform::v1::DeleteStudyRequest const &, Options)
Deletes a Study.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteStudyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
LookupStudy(std::string const &, Options)
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to get the Study from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupStudy(google::cloud::aiplatform::v1::LookupStudyRequest const &, Options)
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::LookupStudyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Study > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Study) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SuggestTrials(google::cloud::aiplatform::v1::SuggestTrialsRequest const &, Options)
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::SuggestTrialsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SuggestTrialsResponse > > |
A |
SuggestTrials(NoAwaitTag, google::cloud::aiplatform::v1::SuggestTrialsRequest const &, Options)
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::SuggestTrialsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SuggestTrials(google::longrunning::Operation const &, Options)
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::SuggestTrialsResponse > > |
CreateTrial(std::string const &, google::cloud::aiplatform::v1::Trial const &, Options)
Adds a user provided Trial to a Study.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Study to create the Trial in. Format: |
trial |
google::cloud::aiplatform::v1::Trial const &
Required. The Trial to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTrial(google::cloud::aiplatform::v1::CreateTrialRequest const &, Options)
Adds a user provided Trial to a Study.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTrialRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrial(std::string const &, Options)
Gets a Trial.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Trial resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrial(google::cloud::aiplatform::v1::GetTrialRequest const &, Options)
Gets a Trial.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTrialRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTrials(std::string const &, Options)
Lists the Trials associated with a Study.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Study to list the Trial from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Trial > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTrials(google::cloud::aiplatform::v1::ListTrialsRequest, Options)
Lists the Trials associated with a Study.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTrialsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Trial > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AddTrialMeasurement(google::cloud::aiplatform::v1::AddTrialMeasurementRequest const &, Options)
Adds a measurement of the objective metrics to a Trial.
This measurement is assumed to have been taken before the Trial is complete.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::AddTrialMeasurementRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CompleteTrial(google::cloud::aiplatform::v1::CompleteTrialRequest const &, Options)
Marks a Trial as complete.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CompleteTrialRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteTrial(std::string const &, Options)
Deletes a Trial.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The Trial's name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteTrial(google::cloud::aiplatform::v1::DeleteTrialRequest const &, Options)
Deletes a Trial.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTrialRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CheckTrialEarlyStoppingState(google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateRequest const &, Options)
Checks whether a Trial should stop or not.
Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateResponse > > |
A |
CheckTrialEarlyStoppingState(NoAwaitTag, google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateRequest const &, Options)
Checks whether a Trial should stop or not.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CheckTrialEarlyStoppingState(google::longrunning::Operation const &, Options)
Checks whether a Trial should stop or not.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::CheckTrialEarlyStoppingStateResponse > > |
StopTrial(google::cloud::aiplatform::v1::StopTrialRequest const &, Options)
Stops a Trial.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::StopTrialRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Trial > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Trial) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOptimalTrials(std::string const &, Options)
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the Study that the optimal Trial belongs to. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ListOptimalTrialsResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ListOptimalTrialsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOptimalTrials(google::cloud::aiplatform::v1::ListOptimalTrialsRequest const &, Options)
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListOptimalTrialsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ListOptimalTrialsResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ListOptimalTrialsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |