class ProjectsLocationsStudiesTrials extends Resource (View source)

The "trials" collection of methods.

Typical usage is:

 $mlService = new Google\Service\CloudMachineLearningEngine(...);
 $trials = $mlService->projects_locations_studies_trials;

Methods

addMeasurement(string $name, GoogleCloudMlV1AddTrialMeasurementRequest $postBody, array $optParams = [])

Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.

checkEarlyStoppingState(string $name, GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest $postBody, array $optParams = [])

Checks whether a trial should stop or not. Returns a long-running operation.

complete(string $name, GoogleCloudMlV1CompleteTrialRequest $postBody, array $optParams = [])

Marks a trial as complete. (trials.complete)

create(string $parent, GoogleCloudMlV1Trial $postBody, array $optParams = [])

Adds a user provided trial to a study. (trials.create)

delete(string $name, array $optParams = [])

Deletes a trial. (trials.delete)

get(string $name, array $optParams = [])

Gets a trial. (trials.get)

listProjectsLocationsStudiesTrials(string $parent, array $optParams = [])

Lists the trials associated with a study.

listOptimalTrials(string $parent, GoogleCloudMlV1ListOptimalTrialsRequest $postBody, array $optParams = [])

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 (trials.listOptimalTrials)

stop(string $name, GoogleCloudMlV1StopTrialRequest $postBody, array $optParams = [])

Stops a trial. (trials.stop)

suggest(string $parent, GoogleCloudMlV1SuggestTrialsRequest $postBody, array $optParams = [])

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. (trials.suggest)

Details

GoogleCloudMlV1Trial addMeasurement(string $name, GoogleCloudMlV1AddTrialMeasurementRequest $postBody, array $optParams = [])

Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.

(trials.addMeasurement)

Parameters

string $name

Required. The trial name.

GoogleCloudMlV1AddTrialMeasurementRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Trial

Exceptions

Exception

GoogleLongrunningOperation checkEarlyStoppingState(string $name, GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest $postBody, array $optParams = [])

Checks whether a trial should stop or not. Returns a long-running operation.

When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. (trials.checkEarlyStoppingState)

Parameters

string $name

Required. The trial name.

GoogleCloudMlV1CheckTrialEarlyStoppingStateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudMlV1Trial complete(string $name, GoogleCloudMlV1CompleteTrialRequest $postBody, array $optParams = [])

Marks a trial as complete. (trials.complete)

Parameters

string $name

Required. The trial name.metat

GoogleCloudMlV1CompleteTrialRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Trial

Exceptions

Exception

GoogleCloudMlV1Trial create(string $parent, GoogleCloudMlV1Trial $postBody, array $optParams = [])

Adds a user provided trial to a study. (trials.create)

Parameters

string $parent

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

GoogleCloudMlV1Trial $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Trial

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a trial. (trials.delete)

Parameters

string $name

Required. The trial name.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudMlV1Trial get(string $name, array $optParams = [])

Gets a trial. (trials.get)

Parameters

string $name

Required. The trial name.

array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Trial

Exceptions

Exception

GoogleCloudMlV1ListTrialsResponse listProjectsLocationsStudiesTrials(string $parent, array $optParams = [])

Lists the trials associated with a study.

(trials.listProjectsLocationsStudiesTrials)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1ListTrialsResponse

Exceptions

Exception

GoogleCloudMlV1ListOptimalTrialsResponse listOptimalTrials(string $parent, GoogleCloudMlV1ListOptimalTrialsRequest $postBody, array $optParams = [])

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 (trials.listOptimalTrials)

Parameters

string $parent

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

GoogleCloudMlV1ListOptimalTrialsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1ListOptimalTrialsResponse

Exceptions

Exception

GoogleCloudMlV1Trial stop(string $name, GoogleCloudMlV1StopTrialRequest $postBody, array $optParams = [])

Stops a trial. (trials.stop)

Parameters

string $name

Required. The trial name.

GoogleCloudMlV1StopTrialRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Trial

Exceptions

Exception

GoogleLongrunningOperation suggest(string $parent, GoogleCloudMlV1SuggestTrialsRequest $postBody, array $optParams = [])

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. (trials.suggest)

Parameters

string $parent

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

GoogleCloudMlV1SuggestTrialsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception