Class VizierServiceGrpc.VizierServiceFutureStub (2.4.0)

public static final class VizierServiceGrpc.VizierServiceFutureStub extends AbstractFutureStub<VizierServiceGrpc.VizierServiceFutureStub>

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > VizierServiceGrpc.VizierServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addTrialMeasurement(AddTrialMeasurementRequest request)

public ListenableFuture<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.

Parameter

Name	Description
request	`AddTrialMeasurementRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Trial>

build(Channel channel, CallOptions callOptions)

protected VizierServiceGrpc.VizierServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
VizierServiceGrpc.VizierServiceFutureStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request)

public ListenableFuture<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.

Parameter

Name	Description
request	`CheckTrialEarlyStoppingStateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

completeTrial(CompleteTrialRequest request)

public ListenableFuture<Trial> completeTrial(CompleteTrialRequest request)

Marks a Trial as complete.

Parameter

Name	Description
request	`CompleteTrialRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Trial>

createStudy(CreateStudyRequest request)

public ListenableFuture<Study> createStudy(CreateStudyRequest request)

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

Parameter

Name	Description
request	`CreateStudyRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Study>

createTrial(CreateTrialRequest request)

public ListenableFuture<Trial> createTrial(CreateTrialRequest request)

Adds a user provided Trial to a Study.

Parameter

Name	Description
request	`CreateTrialRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Trial>

deleteStudy(DeleteStudyRequest request)

public ListenableFuture<Empty> deleteStudy(DeleteStudyRequest request)

Deletes a Study.

Parameter

Name	Description
request	`DeleteStudyRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTrial(DeleteTrialRequest request)

public ListenableFuture<Empty> deleteTrial(DeleteTrialRequest request)

Deletes a Trial.

Parameter

Name	Description
request	`DeleteTrialRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getStudy(GetStudyRequest request)

public ListenableFuture<Study> getStudy(GetStudyRequest request)

Gets a Study by name.

Parameter

Name	Description
request	`GetStudyRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Study>

getTrial(GetTrialRequest request)

public ListenableFuture<Trial> getTrial(GetTrialRequest request)

Gets a Trial.

Parameter

Name	Description
request	`GetTrialRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Trial>

listOptimalTrials(ListOptimalTrialsRequest request)

public ListenableFuture<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

Parameter

Name	Description
request	`ListOptimalTrialsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListOptimalTrialsResponse>

listStudies(ListStudiesRequest request)

public ListenableFuture<ListStudiesResponse> listStudies(ListStudiesRequest request)

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

Parameter

Name	Description
request	`ListStudiesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListStudiesResponse>

listTrials(ListTrialsRequest request)

public ListenableFuture<ListTrialsResponse> listTrials(ListTrialsRequest request)

Lists the Trials associated with a Study.

Parameter

Name	Description
request	`ListTrialsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListTrialsResponse>

lookupStudy(LookupStudyRequest request)

public ListenableFuture<Study> lookupStudy(LookupStudyRequest request)

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

Parameter

Name	Description
request	`LookupStudyRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Study>

stopTrial(StopTrialRequest request)

public ListenableFuture<Trial> stopTrial(StopTrialRequest request)

Stops a Trial.

Parameter

Name	Description
request	`StopTrialRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Trial>

suggestTrials(SuggestTrialsRequest request)

public ListenableFuture<Operation> suggestTrials(SuggestTrialsRequest request)

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.

Parameter

Name	Description
request	`SuggestTrialsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>