Class ProjectsResource.LocationsResource.StudiesResource.TrialsResource
The "trials" collection of methods.
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.StudiesResource.TrialsResource
Constructors
TrialsResource(IClientService)
Constructs a new resource.
Declaration
public TrialsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Operations
Gets the Operations resource.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource Operations { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource |
Methods
AddTrialMeasurement(GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest, string)
Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.AddTrialMeasurementRequest AddTrialMeasurement(GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest body, string trialName)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest | body | The body of the request. |
string | trialName | Required. The name of the trial to add measurement. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.AddTrialMeasurementRequest |
CheckTrialEarlyStoppingState(GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest, string)
Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CheckTrialEarlyStoppingStateRequest CheckTrialEarlyStoppingState(GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest body, string trialName)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest | body | The body of the request. |
string | trialName | Required. The Trial's name. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CheckTrialEarlyStoppingStateRequest |
Complete(GoogleCloudAiplatformV1beta1CompleteTrialRequest, string)
Marks a Trial as complete.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CompleteRequest Complete(GoogleCloudAiplatformV1beta1CompleteTrialRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1CompleteTrialRequest | body | The body of the request. |
string | name | Required. The Trial's name. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CompleteRequest |
Create(GoogleCloudAiplatformV1beta1Trial, string)
Adds a user provided Trial to a Study.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CreateRequest Create(GoogleCloudAiplatformV1beta1Trial body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1Trial | body | The body of the request. |
string | parent | Required. The resource name of the Study to create the Trial in. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CreateRequest |
Delete(string)
Deletes a Trial.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The Trial's name. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.DeleteRequest |
Get(string)
Gets a Trial.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the Trial resource. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.GetRequest |
List(string)
Lists the Trials associated with a Study.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The resource name of the Study to list the Trial from. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListRequest |
ListOptimalTrials(GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest, string)
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
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListOptimalTrialsRequest ListOptimalTrials(GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest | body | The body of the request. |
string | parent | Required. The name of the Study that the optimal Trial belongs to. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListOptimalTrialsRequest |
Stop(GoogleCloudAiplatformV1beta1StopTrialRequest, string)
Stops a Trial.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.StopRequest Stop(GoogleCloudAiplatformV1beta1StopTrialRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1StopTrialRequest | body | The body of the request. |
string | name | Required. The Trial's name. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.StopRequest |
Suggest(GoogleCloudAiplatformV1beta1SuggestTrialsRequest, string)
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.
Declaration
public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.SuggestRequest Suggest(GoogleCloudAiplatformV1beta1SuggestTrialsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1SuggestTrialsRequest | body | The body of the request. |
string | parent | Required. The project and location that the Study belongs to. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.SuggestRequest |