VizierService class final

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.

Constructors

VizierService({required Client client})
Creates a VizierService using client for transport.
VizierService.fromApiKey([String? apiKey])
Creates a VizierService that does authentication through an API key.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addTrialMeasurement(AddTrialMeasurementRequest request) → Future<Trial>
Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.
cancelOperation(CancelOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request) → Future<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>>
Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
close() → void
Closes the client and cleans up any resources associated with it.
completeTrial(CompleteTrialRequest request) → Future<Trial>
Marks a Trial as complete.
createStudy(CreateStudyRequest request) → Future<Study>
Creates a Study. A resource name will be generated after creation of the Study.
createTrial(CreateTrialRequest request) → Future<Trial>
Adds a user provided Trial to a Study.
deleteOperation(DeleteOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
deleteStudy(DeleteStudyRequest request) → Future<void>
Deletes a Study.
deleteTrial(DeleteTrialRequest request) → Future<void>
Deletes a Trial.
getIamPolicy(GetIamPolicyRequest request) → Future<Policy>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
getLocation(GetLocationRequest request) → Future<Location>
Gets information about a location.
getOperation<T extends ProtoMessage, S extends ProtoMessage>(Operation<T, S> request) → Future<Operation<T, S>>
Provides the Operations service functionality in this service.
getStudy(GetStudyRequest request) → Future<Study>
Gets a Study by name.
getTrial(GetTrialRequest request) → Future<Trial>
Gets a Trial.
listLocations(ListLocationsRequest request) → Future<ListLocationsResponse>
Lists information about the supported locations for this service.
listOperations(ListOperationsRequest request) → Future<ListOperationsResponse>
Provides the Operations service functionality in this service.
listOptimalTrials(ListOptimalTrialsRequest request) → Future<ListOptimalTrialsResponse>
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
listStudies(ListStudiesRequest request) → Future<ListStudiesResponse>
Lists all the studies in a region for an associated project.
listTrials(ListTrialsRequest request) → Future<ListTrialsResponse>
Lists the Trials associated with a Study.
lookupStudy(LookupStudyRequest request) → Future<Study>
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setIamPolicy(SetIamPolicyRequest request) → Future<Policy>
Sets the access control policy on the specified resource. Replaces any existing policy.
stopTrial(StopTrialRequest request) → Future<Trial>
Stops a Trial.
suggestTrials(SuggestTrialsRequest request) → Future<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>>
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.
testIamPermissions(TestIamPermissionsRequest request) → Future<TestIamPermissionsResponse>
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
toString() → String
A string representation of this object.
inherited
waitOperation(WaitOperationRequest request) → Future<Operation<ProtoMessage, ProtoMessage>>
Provides the Operations service functionality in this service.

Operators

operator ==(Object other) → bool
The equality operator.
inherited