File: //snap/google-cloud-cli/current/lib/surface/ai/hp_tuning_jobs/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2020 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command to get a hyperparameter tuning job in Vertex AI."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.ai.hp_tuning_jobs import client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.ai import constants
from googlecloudsdk.command_lib.ai import endpoint_util
from googlecloudsdk.command_lib.ai import validation
from googlecloudsdk.command_lib.ai.hp_tuning_jobs import flags
@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA,
base.ReleaseTrack.ALPHA)
class Describe(base.DescribeCommand):
"""Get detail information about the hyperparameter tuning job by given id.
## EXAMPLES
To get a job ``123'' under project ``example'' in region
``us-central1'', run:
$ {command} 123 --project=example --region=us-central1
"""
@staticmethod
def Args(parser):
flags.AddHptuningJobResourceArg(parser, 'to describe')
def Run(self, args):
hptuning_job_ref = args.CONCEPTS.hptuning_job.Parse()
region = hptuning_job_ref.AsDict()['locationsId']
validation.ValidateRegion(
region, available_regions=constants.SUPPORTED_TRAINING_REGIONS)
version = constants.GA_VERSION if self.ReleaseTrack(
) == base.ReleaseTrack.GA else constants.BETA_VERSION
with endpoint_util.AiplatformEndpointOverrides(
version=version, region=region):
response = client.HpTuningJobsClient(version=version).Get(
hptuning_job_ref.RelativeName())
return response