Struct gapi_grpc::google::cloud::aiplatform::v1beta1::vizier_service_client::VizierServiceClient

[+] Show declaration

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

[−] Expand description

Vertex Vizier API.

Vizier service is a GCP service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

Implementations

impl VizierServiceClient<Channel>[−]

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, [−]

Attempt to create a new client by connecting to a given endpoint.

impl<T> VizierServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, [−]

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

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 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.ml.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.ml.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>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T> Debug for VizierServiceClient<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.