Class VizierServiceGrpc.VizierServiceBlockingStub (3.31.0)

public static final class VizierServiceGrpc.VizierServiceBlockingStub extends 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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > VizierServiceGrpc.VizierServiceBlockingStub

Methods

addTrialMeasurement(AddTrialMeasurementRequest request)

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.

Parameter
NameDescription
requestAddTrialMeasurementRequest
Returns
TypeDescription
Trial

build(Channel channel, CallOptions callOptions)

protected VizierServiceGrpc.VizierServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
VizierServiceGrpc.VizierServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request)

public 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
NameDescription
requestCheckTrialEarlyStoppingStateRequest
Returns
TypeDescription
Operation

completeTrial(CompleteTrialRequest request)

public Trial completeTrial(CompleteTrialRequest request)

Marks a Trial as complete.

Parameter
NameDescription
requestCompleteTrialRequest
Returns
TypeDescription
Trial

createStudy(CreateStudyRequest request)

public Study createStudy(CreateStudyRequest request)

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

Parameter
NameDescription
requestCreateStudyRequest
Returns
TypeDescription
Study

createTrial(CreateTrialRequest request)

public Trial createTrial(CreateTrialRequest request)

Adds a user provided Trial to a Study.

Parameter
NameDescription
requestCreateTrialRequest
Returns
TypeDescription
Trial

deleteStudy(DeleteStudyRequest request)

public Empty deleteStudy(DeleteStudyRequest request)

Deletes a Study.

Parameter
NameDescription
requestDeleteStudyRequest
Returns
TypeDescription
Empty

deleteTrial(DeleteTrialRequest request)

public Empty deleteTrial(DeleteTrialRequest request)

Deletes a Trial.

Parameter
NameDescription
requestDeleteTrialRequest
Returns
TypeDescription
Empty

getStudy(GetStudyRequest request)

public Study getStudy(GetStudyRequest request)

Gets a Study by name.

Parameter
NameDescription
requestGetStudyRequest
Returns
TypeDescription
Study

getTrial(GetTrialRequest request)

public Trial getTrial(GetTrialRequest request)

Gets a Trial.

Parameter
NameDescription
requestGetTrialRequest
Returns
TypeDescription
Trial

listOptimalTrials(ListOptimalTrialsRequest request)

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

Parameter
NameDescription
requestListOptimalTrialsRequest
Returns
TypeDescription
ListOptimalTrialsResponse

listStudies(ListStudiesRequest request)

public ListStudiesResponse listStudies(ListStudiesRequest request)

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

Parameter
NameDescription
requestListStudiesRequest
Returns
TypeDescription
ListStudiesResponse

listTrials(ListTrialsRequest request)

public ListTrialsResponse listTrials(ListTrialsRequest request)

Lists the Trials associated with a Study.

Parameter
NameDescription
requestListTrialsRequest
Returns
TypeDescription
ListTrialsResponse

lookupStudy(LookupStudyRequest request)

public Study lookupStudy(LookupStudyRequest request)

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

Parameter
NameDescription
requestLookupStudyRequest
Returns
TypeDescription
Study

stopTrial(StopTrialRequest request)

public Trial stopTrial(StopTrialRequest request)

Stops a Trial.

Parameter
NameDescription
requestStopTrialRequest
Returns
TypeDescription
Trial

suggestTrials(SuggestTrialsRequest request)

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

Parameter
NameDescription
requestSuggestTrialsRequest
Returns
TypeDescription
Operation