com.google.cloud.aiplatform.v1beta1

Class VizierServiceGrpc.VizierServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<VizierServiceGrpc.VizierServiceBlockingStub>

com.google.cloud.aiplatform.v1beta1.VizierServiceGrpc.VizierServiceBlockingStub

Enclosing class:

VizierServiceGrpc

public static final class VizierServiceGrpc.VizierServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<VizierServiceGrpc.VizierServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service VizierService.

 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
Trial	addTrialMeasurement(AddTrialMeasurementRequest request) Adds a measurement of the objective metrics to a Trial.
protected VizierServiceGrpc.VizierServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.longrunning.Operation	checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request) Checks whether a Trial should stop or not.
Trial	completeTrial(CompleteTrialRequest request) Marks a Trial as complete.
Study	createStudy(CreateStudyRequest request) Creates a Study.
Trial	createTrial(CreateTrialRequest request) Adds a user provided Trial to a Study.
com.google.protobuf.Empty	deleteStudy(DeleteStudyRequest request) Deletes a Study.
com.google.protobuf.Empty	deleteTrial(DeleteTrialRequest request) Deletes a Trial.
Study	getStudy(GetStudyRequest request) Gets a Study by name.
Trial	getTrial(GetTrialRequest request) Gets a Trial.
ListOptimalTrialsResponse	listOptimalTrials(ListOptimalTrialsRequest request) Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
ListStudiesResponse	listStudies(ListStudiesRequest request) Lists all the studies in a region for an associated project.
ListTrialsResponse	listTrials(ListTrialsRequest request) Lists the Trials associated with a Study.
Study	lookupStudy(LookupStudyRequest request) Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
Trial	stopTrial(StopTrialRequest request) Stops a Trial.
com.google.longrunning.Operation	suggestTrials(SuggestTrialsRequest request) Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected VizierServiceGrpc.VizierServiceBlockingStub build(io.grpc.Channel channel,
                                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<VizierServiceGrpc.VizierServiceBlockingStub>

createStudy

public Study createStudy(CreateStudyRequest request)

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

getStudy

public Study getStudy(GetStudyRequest request)

 Gets a Study by name.
 

listStudies

public ListStudiesResponse listStudies(ListStudiesRequest request)

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

deleteStudy

public com.google.protobuf.Empty deleteStudy(DeleteStudyRequest request)

 Deletes a Study.
 

lookupStudy

public Study lookupStudy(LookupStudyRequest request)

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

suggestTrials

public com.google.longrunning.Operation suggestTrials(SuggestTrialsRequest request)

 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.v1beta1.SuggestTrialsResponse].
 

createTrial

public Trial createTrial(CreateTrialRequest request)

 Adds a user provided Trial to a Study.
 

getTrial

public Trial getTrial(GetTrialRequest request)

 Gets a Trial.
 

listTrials

public ListTrialsResponse listTrials(ListTrialsRequest request)

 Lists the Trials associated with a Study.
 

addTrialMeasurement

public Trial addTrialMeasurement(AddTrialMeasurementRequest request)

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

completeTrial

public Trial completeTrial(CompleteTrialRequest request)

 Marks a Trial as complete.
 

deleteTrial

public com.google.protobuf.Empty deleteTrial(DeleteTrialRequest request)

 Deletes a Trial.
 

checkTrialEarlyStoppingState

public com.google.longrunning.Operation checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request)

 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.v1beta1.CheckTrialEarlyStoppingStateResponse].
 

stopTrial

public Trial stopTrial(StopTrialRequest request)

 Stops a Trial.
 

listOptimalTrials

public ListOptimalTrialsResponse listOptimalTrials(ListOptimalTrialsRequest request)

 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