Struct google_api_proto::google::cloud::aiplatform::v1::vizier_service_client::VizierServiceClient

pub struct VizierServiceClient<T> { /* private fields */ }

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.

Implementations

impl<T> VizierServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> VizierServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_study( &mut self, request: impl IntoRequest<CreateStudyRequest>, ) -> Result<Response<Study>, Status>

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

pub async fn get_study( &mut self, request: impl IntoRequest<GetStudyRequest>, ) -> Result<Response<Study>, Status>

Gets a Study by name.

pub async fn list_studies( &mut self, request: impl IntoRequest<ListStudiesRequest>, ) -> Result<Response<ListStudiesResponse>, Status>

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

pub async fn delete_study( &mut self, request: impl IntoRequest<DeleteStudyRequest>, ) -> Result<Response<()>, Status>

Deletes a Study.

pub async fn lookup_study( &mut self, request: impl IntoRequest<LookupStudyRequest>, ) -> Result<Response<Study>, Status>

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

pub async fn suggest_trials( &mut self, request: impl IntoRequest<SuggestTrialsRequest>, ) -> Result<Response<Operation>, Status>

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][google.cloud.aiplatform.v1.SuggestTrialsResponse].

pub async fn create_trial( &mut self, request: impl IntoRequest<CreateTrialRequest>, ) -> Result<Response<Trial>, Status>

Adds a user provided Trial to a Study.

pub async fn get_trial( &mut self, request: impl IntoRequest<GetTrialRequest>, ) -> Result<Response<Trial>, Status>

Gets a Trial.

pub async fn list_trials( &mut self, request: impl IntoRequest<ListTrialsRequest>, ) -> Result<Response<ListTrialsResponse>, Status>

Lists the Trials associated with a Study.

pub async fn add_trial_measurement( &mut self, request: impl IntoRequest<AddTrialMeasurementRequest>, ) -> Result<Response<Trial>, Status>

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

pub async fn complete_trial( &mut self, request: impl IntoRequest<CompleteTrialRequest>, ) -> Result<Response<Trial>, Status>

Marks a Trial as complete.

pub async fn delete_trial( &mut self, request: impl IntoRequest<DeleteTrialRequest>, ) -> Result<Response<()>, Status>

Deletes a Trial.

pub async fn check_trial_early_stopping_state( &mut self, request: impl IntoRequest<CheckTrialEarlyStoppingStateRequest>, ) -> Result<Response<Operation>, Status>

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].

pub async fn stop_trial( &mut self, request: impl IntoRequest<StopTrialRequest>, ) -> Result<Response<Trial>, Status>

Stops a Trial.

pub async fn list_optimal_trials( &mut self, request: impl IntoRequest<ListOptimalTrialsRequest>, ) -> Result<Response<ListOptimalTrialsResponse>, Status>

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

Trait Implementations

impl<T: Clone> Clone for VizierServiceClient<T>

fn clone(&self) -> VizierServiceClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for VizierServiceClient<T>

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

Formats the value using the given formatter.