class ProjectsLocationsStudiesTrials extends Resource (View source)

The "trials" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $trials = $aiplatformService->projects_locations_studies_trials;

Methods

addTrialMeasurement(string $trialName, GoogleCloudAiplatformV1AddTrialMeasurementRequest $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.

checkTrialEarlyStoppingState(string $trialName, GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest $postBody, array $optParams = [])

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

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

Marks a Trial as complete. (trials.complete)

create(string $parent, GoogleCloudAiplatformV1Trial $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, GoogleCloudAiplatformV1ListOptimalTrialsRequest $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, GoogleCloudAiplatformV1StopTrialRequest $postBody, array $optParams = [])

Stops a Trial. (trials.stop)

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

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

Details

GoogleCloudAiplatformV1Trial addTrialMeasurement(string $trialName, GoogleCloudAiplatformV1AddTrialMeasurementRequest $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.addTrialMeasurement)

Parameters

string $trialName

Required. The name of the trial to add measurement. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

GoogleCloudAiplatformV1AddTrialMeasurementRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Trial

Exceptions

Exception

GoogleLongrunningOperation checkTrialEarlyStoppingState(string $trialName, GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest $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.checkTrialEarlyStoppingState)

Parameters

string $trialName

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Marks a Trial as complete. (trials.complete)

Parameters

string $name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

GoogleCloudAiplatformV1CompleteTrialRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Trial

Exceptions

Exception

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

Adds a user provided Trial to a Study. (trials.create)

Parameters

string $parent

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

GoogleCloudAiplatformV1Trial $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Trial

Exceptions

Exception

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

Deletes a Trial. (trials.delete)

Parameters

string $name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Gets a Trial. (trials.get)

Parameters

string $name

Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Trial

Exceptions

Exception

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

Lists the Trials associated with a Study.

(trials.listProjectsLocationsStudiesTrials)

Parameters

string $parent

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTrialsResponse

Exceptions

Exception

GoogleCloudAiplatformV1ListOptimalTrialsResponse listOptimalTrials(string $parent, GoogleCloudAiplatformV1ListOptimalTrialsRequest $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 optimal Trial belongs to.

GoogleCloudAiplatformV1ListOptimalTrialsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListOptimalTrialsResponse

Exceptions

Exception

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

Stops a Trial. (trials.stop)

Parameters

string $name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

GoogleCloudAiplatformV1StopTrialRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Trial

Exceptions

Exception

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

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

Parameters

string $parent

Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

GoogleCloudAiplatformV1SuggestTrialsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception