- 3.13.0 (latest)
- 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.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
[BindServiceMethod(typeof(VizierService), "BindService")]
public abstract class VizierService.VizierServiceBaseReference documentation and code samples for the Cloud AI Platform v1 API class VizierService.VizierServiceBase.
Base class for server-side implementations of VizierService
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Methods
AddTrialMeasurement(AddTrialMeasurementRequest, ServerCallContext)
public virtual Task<Trial> AddTrialMeasurement(AddTrialMeasurementRequest request, ServerCallContext context)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 |
AddTrialMeasurementRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial |
The response to send back to the client (wrapped by a task). |
CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, ServerCallContext)
public virtual Task<Operation> CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, ServerCallContext context)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.v1.CheckTrialEarlyStoppingStateResponse].
| Parameters | |
|---|---|
| Name | Description |
request |
CheckTrialEarlyStoppingStateRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskOperation |
The response to send back to the client (wrapped by a task). |
CompleteTrial(CompleteTrialRequest, ServerCallContext)
public virtual Task<Trial> CompleteTrial(CompleteTrialRequest request, ServerCallContext context)Marks a Trial as complete.
| Parameters | |
|---|---|
| Name | Description |
request |
CompleteTrialRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial |
The response to send back to the client (wrapped by a task). |
CreateStudy(CreateStudyRequest, ServerCallContext)
public virtual Task<Study> CreateStudy(CreateStudyRequest request, ServerCallContext context)Creates a Study. A resource name will be generated after creation of the Study.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateStudyRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy |
The response to send back to the client (wrapped by a task). |
CreateTrial(CreateTrialRequest, ServerCallContext)
public virtual Task<Trial> CreateTrial(CreateTrialRequest request, ServerCallContext context)Adds a user provided Trial to a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateTrialRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial |
The response to send back to the client (wrapped by a task). |
DeleteStudy(DeleteStudyRequest, ServerCallContext)
public virtual Task<Empty> DeleteStudy(DeleteStudyRequest request, ServerCallContext context)Deletes a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteStudyRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
DeleteTrial(DeleteTrialRequest, ServerCallContext)
public virtual Task<Empty> DeleteTrial(DeleteTrialRequest request, ServerCallContext context)Deletes a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTrialRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
GetStudy(GetStudyRequest, ServerCallContext)
public virtual Task<Study> GetStudy(GetStudyRequest request, ServerCallContext context)Gets a Study by name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetStudyRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy |
The response to send back to the client (wrapped by a task). |
GetTrial(GetTrialRequest, ServerCallContext)
public virtual Task<Trial> GetTrial(GetTrialRequest request, ServerCallContext context)Gets a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTrialRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial |
The response to send back to the client (wrapped by a task). |
ListOptimalTrials(ListOptimalTrialsRequest, ServerCallContext)
public virtual Task<ListOptimalTrialsResponse> ListOptimalTrials(ListOptimalTrialsRequest request, ServerCallContext context)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 |
ListOptimalTrialsRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskListOptimalTrialsResponse |
The response to send back to the client (wrapped by a task). |
ListStudies(ListStudiesRequest, ServerCallContext)
public virtual Task<ListStudiesResponse> ListStudies(ListStudiesRequest request, ServerCallContext context)Lists all the studies in a region for an associated project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListStudiesRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskListStudiesResponse |
The response to send back to the client (wrapped by a task). |
ListTrials(ListTrialsRequest, ServerCallContext)
public virtual Task<ListTrialsResponse> ListTrials(ListTrialsRequest request, ServerCallContext context)Lists the Trials associated with a Study.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTrialsRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskListTrialsResponse |
The response to send back to the client (wrapped by a task). |
LookupStudy(LookupStudyRequest, ServerCallContext)
public virtual Task<Study> LookupStudy(LookupStudyRequest request, ServerCallContext context)Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
LookupStudyRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy |
The response to send back to the client (wrapped by a task). |
StopTrial(StopTrialRequest, ServerCallContext)
public virtual Task<Trial> StopTrial(StopTrialRequest request, ServerCallContext context)Stops a Trial.
| Parameters | |
|---|---|
| Name | Description |
request |
StopTrialRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial |
The response to send back to the client (wrapped by a task). |
SuggestTrials(SuggestTrialsRequest, ServerCallContext)
public virtual Task<Operation> SuggestTrials(SuggestTrialsRequest request, ServerCallContext context)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.v1.SuggestTrialsResponse].
| Parameters | |
|---|---|
| Name | Description |
request |
SuggestTrialsRequestThe request received from the client. |
context |
ServerCallContextThe context of the server-side call handler being invoked. |
| Returns | |
|---|---|
| Type | Description |
TaskOperation |
The response to send back to the client (wrapped by a task). |