class ProjectsLocationsHyperparameterTuningJobs extends Resource (View source)

The "hyperparameterTuningJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $hyperparameterTuningJobs = $aiplatformService->projects_locations_hyperparameterTuningJobs;

Methods

cancel(string $name, GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest $postBody, array $optParams = [])

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

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

Creates a HyperparameterTuningJob (hyperparameterTuningJobs.create)

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

Deletes a HyperparameterTuningJob. (hyperparameterTuningJobs.delete)

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

Gets a HyperparameterTuningJob (hyperparameterTuningJobs.get)

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

Lists HyperparameterTuningJobs in a Location.

Details

GoogleProtobufEmpty cancel(string $name, GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest $postBody, array $optParams = [])

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

(hyperparameterTuningJobs.cancel)

Parameters

string $name

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuning Jobs/{hyperparameter_tuning_job}

GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a HyperparameterTuningJob (hyperparameterTuningJobs.create)

Parameters

string $parent

Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1HyperparameterTuningJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1HyperparameterTuningJob

Exceptions

Exception

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

Deletes a HyperparameterTuningJob. (hyperparameterTuningJobs.delete)

Parameters

string $name

Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hype rparameterTuningJobs/{hyperparameter_tuning_job}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a HyperparameterTuningJob (hyperparameterTuningJobs.get)

Parameters

string $name

Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuni ngJobs/{hyperparameter_tuning_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1HyperparameterTuningJob

Exceptions

Exception

GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse listProjectsLocationsHyperparameterTuningJobs(string $parent, array $optParams = [])

Lists HyperparameterTuningJobs in a Location.

(hyperparameterTuningJobs.listProjectsLocationsHyperparameterTuningJobs)

Parameters

string $parent

Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse

Exceptions

Exception