Package com.google.cloud.aiplatform.v1

Interface VizierServiceGrpc.AsyncService

  • All Known Implementing Classes:
    VizierServiceGrpc.VizierServiceImplBase
    Enclosing class:
    VizierServiceGrpc
    public static interface VizierServiceGrpc.AsyncService
     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.

    • Method Detail

      • createStudy

        default void createStudy​(CreateStudyRequest request,
                         io.grpc.stub.StreamObserver<Study> responseObserver)
         Creates a Study. A resource name will be generated after creation of the
 Study.

      • getStudy

        default void getStudy​(GetStudyRequest request,
                      io.grpc.stub.StreamObserver<Study> responseObserver)
         Gets a Study by name.

      • listStudies

        default void listStudies​(ListStudiesRequest request,
                         io.grpc.stub.StreamObserver<ListStudiesResponse> responseObserver)
         Lists all the studies in a region for an associated project.

      • deleteStudy

        default void deleteStudy​(DeleteStudyRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Deletes a Study.

      • lookupStudy

        default void lookupStudy​(LookupStudyRequest request,
                         io.grpc.stub.StreamObserver<Study> responseObserver)
         Looks a study up using the user-defined display_name field instead of the
 fully qualified resource name.

      • suggestTrials

        default void suggestTrials​(SuggestTrialsRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         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].

      • createTrial

        default void createTrial​(CreateTrialRequest request,
                         io.grpc.stub.StreamObserver<Trial> responseObserver)
         Adds a user provided Trial to a Study.

      • getTrial

        default void getTrial​(GetTrialRequest request,
                      io.grpc.stub.StreamObserver<Trial> responseObserver)
         Gets a Trial.

      • listTrials

        default void listTrials​(ListTrialsRequest request,
                        io.grpc.stub.StreamObserver<ListTrialsResponse> responseObserver)
         Lists the Trials associated with a Study.

      • addTrialMeasurement

        default void addTrialMeasurement​(AddTrialMeasurementRequest request,
                                 io.grpc.stub.StreamObserver<Trial> responseObserver)
         Adds a measurement of the objective metrics to a Trial. This measurement
 is assumed to have been taken before the Trial is complete.

      • completeTrial

        default void completeTrial​(CompleteTrialRequest request,
                           io.grpc.stub.StreamObserver<Trial> responseObserver)
         Marks a Trial as complete.

      • deleteTrial

        default void deleteTrial​(DeleteTrialRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Deletes a Trial.

      • checkTrialEarlyStoppingState

        default void checkTrialEarlyStoppingState​(CheckTrialEarlyStoppingStateRequest request,
                                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         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].

      • stopTrial

        default void stopTrial​(StopTrialRequest request,
                       io.grpc.stub.StreamObserver<Trial> responseObserver)
         Stops a Trial.

      • listOptimalTrials

        default void listOptimalTrials​(ListOptimalTrialsRequest request,
                               io.grpc.stub.StreamObserver<ListOptimalTrialsResponse> responseObserver)
         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