com.google.api.services.ml.v1

Class CloudMachineLearningEngine.Projects.Locations.Studies.Trials

java.lang.Object

com.google.api.services.ml.v1.CloudMachineLearningEngine.Projects.Locations.Studies.Trials

Enclosing class:

CloudMachineLearningEngine.Projects.Locations.Studies

public class CloudMachineLearningEngine.Projects.Locations.Studies.Trials
extends Object

The "trials" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.AddMeasurement
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.CheckEarlyStoppingState
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Complete
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Create
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Delete
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Get
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.List
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.ListOptimalTrials
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Stop
class	CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Suggest

Constructor Summary

Constructors

Constructor and Description
Trials()

Method Summary

Modifier and Type	Method and Description
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.AddMeasurement	addMeasurement(String name, GoogleCloudMlV1AddTrialMeasurementRequest content) Adds a measurement of the objective metrics to a trial.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.CheckEarlyStoppingState	checkEarlyStoppingState(String name, GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest content) Checks whether a trial should stop or not.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Complete	complete(String name, GoogleCloudMlV1CompleteTrialRequest content) Marks a trial as complete.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Create	create(String parent, GoogleCloudMlV1Trial content) Adds a user provided trial to a study.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Delete	delete(String name) Deletes a trial.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Get	get(String name) Gets a trial.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.List	list(String parent) Lists the trials associated with a study.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.ListOptimalTrials	listOptimalTrials(String parent, GoogleCloudMlV1ListOptimalTrialsRequest content) Lists the pareto-optimal trials for multi-objective study or the optimal trials for single- objective study.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Stop	stop(String name, GoogleCloudMlV1StopTrialRequest content) Stops a trial.
CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Suggest	suggest(String parent, GoogleCloudMlV1SuggestTrialsRequest content) Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Trials

public Trials()

Method Detail

addMeasurement

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.AddMeasurement addMeasurement(String name,
                                                                                                  GoogleCloudMlV1AddTrialMeasurementRequest content)
                                                                                           throws IOException

Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete. Create a request for the method "trials.addMeasurement". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.

content - the GoogleCloudMlV1AddTrialMeasurementRequest

Returns:

the request

Throws:

IOException

checkEarlyStoppingState

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.CheckEarlyStoppingState checkEarlyStoppingState(String name,
                                                                                                                    GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest content)
                                                                                                             throws IOException

Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. Create a request for the method "trials.checkEarlyStoppingState". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.

content - the GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest

Returns:

the request

Throws:

IOException

complete

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Complete complete(String name,
                                                                                      GoogleCloudMlV1CompleteTrialRequest content)
                                                                               throws IOException

Marks a trial as complete. Create a request for the method "trials.complete". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.metat

content - the GoogleCloudMlV1CompleteTrialRequest

Returns:

the request

Throws:

IOException

create

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Create create(String parent,
                                                                                  GoogleCloudMlV1Trial content)
                                                                           throws IOException

Adds a user provided trial to a study. Create a request for the method "trials.create". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the study that the trial belongs to.

content - the GoogleCloudMlV1Trial

Returns:

the request

Throws:

IOException

delete

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Delete delete(String name)
                                                                           throws IOException

Deletes a trial. Create a request for the method "trials.delete". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.

Returns:

the request

Throws:

IOException

get

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Get get(String name)
                                                                     throws IOException

Gets a trial. Create a request for the method "trials.get". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.

Returns:

the request

Throws:

IOException

list

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.List list(String parent)
                                                                       throws IOException

Lists the trials associated with a study. Create a request for the method "trials.list". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the study that the trial belongs to.

Returns:

the request

Throws:

IOException

listOptimalTrials

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.ListOptimalTrials listOptimalTrials(String parent,
                                                                                                        GoogleCloudMlV1ListOptimalTrialsRequest content)
                                                                                                 throws IOException

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 Create a request for the method "trials.listOptimalTrials". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the study that the pareto-optimal trial belongs to.

content - the GoogleCloudMlV1ListOptimalTrialsRequest

Returns:

the request

Throws:

IOException

stop

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Stop stop(String name,
                                                                              GoogleCloudMlV1StopTrialRequest content)
                                                                       throws IOException

Stops a trial. Create a request for the method "trials.stop". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The trial name.

content - the GoogleCloudMlV1StopTrialRequest

Returns:

the request

Throws:

IOException

suggest

public CloudMachineLearningEngine.Projects.Locations.Studies.Trials.Suggest suggest(String parent,
                                                                                    GoogleCloudMlV1SuggestTrialsRequest content)
                                                                             throws IOException

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. Create a request for the method "trials.suggest". This request holds the parameters needed by the ml server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the study that the trial belongs to.

content - the GoogleCloudMlV1SuggestTrialsRequest

Returns:

the request

Throws:

IOException