- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static interface VizierServiceGrpc.AsyncServiceVertex 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.
Methods
addTrialMeasurement(AddTrialMeasurementRequest request, StreamObserver<Trial> responseObserver)
public default void addTrialMeasurement(AddTrialMeasurementRequest request, 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.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTrialMeasurementRequest |
responseObserver |
io.grpc.stub.StreamObserver<Trial> |
checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, StreamObserver<Operation> responseObserver)
public default void checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
CheckTrialEarlyStoppingStateRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
completeTrial(CompleteTrialRequest request, StreamObserver<Trial> responseObserver)
public default void completeTrial(CompleteTrialRequest request, StreamObserver<Trial> responseObserver)Marks a Trial as complete.
| Parameters | |
|---|---|
| Name | Description |
request |
CompleteTrialRequest |
responseObserver |
io.grpc.stub.StreamObserver<Trial> |
createStudy(CreateStudyRequest request, StreamObserver<Study> responseObserver)
public default void createStudy(CreateStudyRequest request, StreamObserver<Study> responseObserver)Creates a Study. A resource name will be generated after creation of the Study.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateStudyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Study> |
createTrial(CreateTrialRequest request, StreamObserver<Trial> responseObserver)
public default void createTrial(CreateTrialRequest request, StreamObserver<Trial> responseObserver)Adds a user provided Trial to a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateTrialRequest |
responseObserver |
io.grpc.stub.StreamObserver<Trial> |
deleteStudy(DeleteStudyRequest request, StreamObserver<Empty> responseObserver)
public default void deleteStudy(DeleteStudyRequest request, StreamObserver<Empty> responseObserver)Deletes a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteStudyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
deleteTrial(DeleteTrialRequest request, StreamObserver<Empty> responseObserver)
public default void deleteTrial(DeleteTrialRequest request, StreamObserver<Empty> responseObserver)Deletes a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTrialRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
getStudy(GetStudyRequest request, StreamObserver<Study> responseObserver)
public default void getStudy(GetStudyRequest request, StreamObserver<Study> responseObserver)Gets a Study by name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetStudyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Study> |
getTrial(GetTrialRequest request, StreamObserver<Trial> responseObserver)
public default void getTrial(GetTrialRequest request, StreamObserver<Trial> responseObserver)Gets a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTrialRequest |
responseObserver |
io.grpc.stub.StreamObserver<Trial> |
listOptimalTrials(ListOptimalTrialsRequest request, StreamObserver<ListOptimalTrialsResponse> responseObserver)
public default void listOptimalTrials(ListOptimalTrialsRequest request, 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
| Parameters | |
|---|---|
| Name | Description |
request |
ListOptimalTrialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListOptimalTrialsResponse> |
listStudies(ListStudiesRequest request, StreamObserver<ListStudiesResponse> responseObserver)
public default void listStudies(ListStudiesRequest request, StreamObserver<ListStudiesResponse> responseObserver)Lists all the studies in a region for an associated project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListStudiesRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListStudiesResponse> |
listTrials(ListTrialsRequest request, StreamObserver<ListTrialsResponse> responseObserver)
public default void listTrials(ListTrialsRequest request, StreamObserver<ListTrialsResponse> responseObserver)Lists the Trials associated with a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTrialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListTrialsResponse> |
lookupStudy(LookupStudyRequest request, StreamObserver<Study> responseObserver)
public default void lookupStudy(LookupStudyRequest request, StreamObserver<Study> responseObserver)Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
LookupStudyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Study> |
stopTrial(StopTrialRequest request, StreamObserver<Trial> responseObserver)
public default void stopTrial(StopTrialRequest request, StreamObserver<Trial> responseObserver)Stops a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
StopTrialRequest |
responseObserver |
io.grpc.stub.StreamObserver<Trial> |
suggestTrials(SuggestTrialsRequest request, StreamObserver<Operation> responseObserver)
public default void suggestTrials(SuggestTrialsRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
SuggestTrialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |