Class ProjectsResource.LocationsResource.StudiesResource.TrialsResource

The "trials" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.StudiesResource.TrialsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudMachineLearningEngine.v1

Assembly: Google.Apis.CloudMachineLearningEngine.v1.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

Methods

AddMeasurement(GoogleCloudMlV1AddTrialMeasurementRequest, 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.AddMeasurementRequest AddMeasurement(GoogleCloudMlV1AddTrialMeasurementRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudMlV1AddTrialMeasurementRequest	body	The body of the request.
string	name	Required. The trial name.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.AddMeasurementRequest

CheckEarlyStoppingState(GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest, 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.CheckEarlyStoppingStateRequest CheckEarlyStoppingState(GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest	body	The body of the request.
string	name	Required. The trial name.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CheckEarlyStoppingStateRequest

Complete(GoogleCloudMlV1CompleteTrialRequest, string)

Marks a trial as complete.

Declaration

public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CompleteRequest Complete(GoogleCloudMlV1CompleteTrialRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudMlV1CompleteTrialRequest	body	The body of the request.
string	name	Required. The trial name.metat

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CompleteRequest

Create(GoogleCloudMlV1Trial, string)

Adds a user provided trial to a study.

Declaration

public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CreateRequest Create(GoogleCloudMlV1Trial body, string parent)

Parameters

Type	Name	Description
GoogleCloudMlV1Trial	body	The body of the request.
string	parent	Required. The name of the study that the trial belongs to.

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

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 trial name.

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 name of the study that the trial belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListRequest

ListOptimalTrials(GoogleCloudMlV1ListOptimalTrialsRequest, 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(GoogleCloudMlV1ListOptimalTrialsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudMlV1ListOptimalTrialsRequest	body	The body of the request.
string	parent	Required. The name of the study that the pareto-optimal trial belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListOptimalTrialsRequest

Stop(GoogleCloudMlV1StopTrialRequest, string)

Stops a trial.

Declaration

public virtual ProjectsResource.LocationsResource.StudiesResource.TrialsResource.StopRequest Stop(GoogleCloudMlV1StopTrialRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudMlV1StopTrialRequest	body	The body of the request.
string	name	Required. The trial name.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.StopRequest

Suggest(GoogleCloudMlV1SuggestTrialsRequest, string)

Adds one or more trials to a study, with parameter values suggested by AI Platform 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(GoogleCloudMlV1SuggestTrialsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudMlV1SuggestTrialsRequest	body	The body of the request.
string	parent	Required. The name of the study that the trial belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.SuggestRequest