Cloud AI Platform v1beta1 API - Class VizierService.VizierServiceBase (1.0.0-beta04)

Version 1.0.0-beta04

• 1.0.0-beta12 (latest)
• 1.0.0-beta11

[BindServiceMethod(typeof(VizierService), "BindService")]
public abstract class VizierService.VizierServiceBase

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class VizierService.VizierServiceBase.

Base class for server-side implementations of VizierService

Inheritance

object > VizierService.VizierServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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	AddTrialMeasurementRequest The request received from the client.
context	ServerCallContext The 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.v1beta1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request received from the client.
context	ServerCallContext The 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	CompleteTrialRequest The request received from the client.
context	ServerCallContext The 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	CreateStudyRequest The request received from the client.
context	ServerCallContext The 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	CreateTrialRequest The request received from the client.
context	ServerCallContext The 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	DeleteStudyRequest The request received from the client.
context	ServerCallContext The 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	DeleteTrialRequest The request received from the client.
context	ServerCallContext The 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	GetStudyRequest The request received from the client.
context	ServerCallContext The 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	GetTrialRequest The request received from the client.
context	ServerCallContext The 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	ListOptimalTrialsRequest The request received from the client.
context	ServerCallContext The 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	ListStudiesRequest The request received from the client.
context	ServerCallContext The 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	ListTrialsRequest The request received from the client.
context	ServerCallContext The 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	LookupStudyRequest The request received from the client.
context	ServerCallContext The 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	StopTrialRequest The request received from the client.
context	ServerCallContext The 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.v1beta1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request received from the client.
context	ServerCallContext The 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).