Struct VizierService

pub struct VizierService { /* private fields */ }

Available on crate feature vizier-service only.

Implements a client for the Vertex AI API.

Example

let client = VizierService::builder().build().await?;
// use `client` to make requests to the Vertex AI API.

Service Description

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.

Configuration

To configure VizierService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://aiplatform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

VizierService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap VizierService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl VizierService

pub fn builder() -> ClientBuilder

Returns a builder for VizierService.

let client = VizierService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: VizierService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_study(&self) -> CreateStudy

Creates a Study. A resource name will be generated after creation of the Study.

pub fn get_study(&self) -> GetStudy

Gets a Study by name.

pub fn list_studies(&self) -> ListStudies

Lists all the studies in a region for an associated project.

pub fn delete_study(&self) -> DeleteStudy

Deletes a Study.

pub fn lookup_study(&self) -> LookupStudy

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

pub fn suggest_trials(&self) -> SuggestTrials

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_trial(&self) -> CreateTrial

Adds a user provided Trial to a Study.

pub fn get_trial(&self) -> GetTrial

Gets a Trial.

pub fn list_trials(&self) -> ListTrials

Lists the Trials associated with a Study.

pub fn add_trial_measurement(&self) -> AddTrialMeasurement

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

pub fn complete_trial(&self) -> CompleteTrial

Marks a Trial as complete.

pub fn delete_trial(&self) -> DeleteTrial

Deletes a Trial.

pub fn check_trial_early_stopping_state(&self) -> CheckTrialEarlyStoppingState

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn stop_trial(&self) -> StopTrial

Stops a Trial.

pub fn list_optimal_trials(&self) -> ListOptimalTrials

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

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

pub fn wait_operation(&self) -> WaitOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for VizierService

fn clone(&self) -> VizierService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VizierService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.