.TH "GCLOUD_AI_HP\-TUNING\-JOBS_CREATE" 1



.SH "NAME"
.HP
gcloud ai hp\-tuning\-jobs create \- create a hyperparameter tuning job



.SH "SYNOPSIS"
.HP
\f5gcloud ai hp\-tuning\-jobs create\fR \fB\-\-config\fR=\fICONFIG\fR \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR [\fB\-\-algorithm\fR=\fIALGORITHM\fR] [\fB\-\-enable\-dashboard\-access\fR] [\fB\-\-enable\-web\-access\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-max\-trial\-count\fR=\fIMAX_TRIAL_COUNT\fR] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-parallel\-trial\-count\fR=\fIPARALLEL_TRIAL_COUNT\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a hyperparameter tuning job.



.SH "EXAMPLES"

To create a job named \f5\fItest\fR\fR under project \f5\fIexample\fR\fR in
region \f5\fIus\-central1\fR\fR, run:

.RS 2m
$ gcloud ai hp\-tuning\-jobs create \-\-region=us\-central1 \e
    \-\-project=example \-\-config=config.yaml \-\-display\-name=test
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-config\fR=\fICONFIG\fR

Path to the job configuration file. This file should be a YAML document
containing a HyperparameterTuningSpec. If an option is specified both in the
configuration file **and** via command line arguments, the command line
arguments override the configuration file.

Example(YAML):

.RS 2m
displayName: TestHpTuningJob
maxTrialCount: 1
parallelTrialCount: 1
studySpec:
  metrics:
  \- metricId: x
    goal: MINIMIZE
  parameters:
  \- parameterId: z
    integerValueSpec:
      minValue: 1
      maxValue: 100
  algorithm: RANDOM_SEARCH
trialJobSpec:
  workerPoolSpecs:
  \- machineSpec:
      machineType: n1\-standard\-4
    replicaCount: 1
    containerSpec:
      imageUri: gcr.io/ucaip\-test/ucaip\-training\-test
.RE

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the hyperparameter tuning job to create.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-algorithm\fR=\fIALGORITHM\fR

Search algorithm specified for the given study. \fIALGORITHM\fR must be one of:
\fBalgorithm\-unspecified\fR, \fBgrid\-search\fR, \fBrandom\-search\fR.

.TP 2m
\fB\-\-enable\-dashboard\-access\fR

Whether you want Vertex AI to enable dashboard built on the training containers.
If set to \f5\fItrue\fR\fR, you can access the dashboard at the URIs given by
CustomJob.web_access_uris or Trial.web_access_uris (within
HyperparameterTuningJob.trials).

.TP 2m
\fB\-\-enable\-web\-access\fR

Whether you want Vertex AI to enable interactive shell access
(https://cloud.google.com/vertex\-ai/docs/training/monitor\-debug\-interactive\-shell)
to training containers. If set to \f5\fItrue\fR\fR, you can access interactive
shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris
(within HyperparameterTuningJob.trials).

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-max\-trial\-count\fR=\fIMAX_TRIAL_COUNT\fR

Desired total number of trials. The default value is 1.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

Full name of the Google Compute Engine network to which the Job is peered with.
Private services access must already have been configured. If unspecified, the
Job is not peered with any network.

.TP 2m
\fB\-\-parallel\-trial\-count\fR=\fIPARALLEL_TRIAL_COUNT\fR

Desired number of Trials to run in parallel. The default value is 1.

.TP 2m

Region resource \- Cloud region to create a hyperparameter tuning job. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-region\fR on the command line with a fully specified
name;
.IP "\(em" 2m
set the property \f5ai/region\fR with a fully specified name;
.IP "\(em" 2m
choose one from the prompted list of available regions with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp


.TP 2m
\fB\-\-region\fR=\fIREGION\fR

ID of the region or fully qualified identifier for the region.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(em" 2m
set the property \f5ai/region\fR;
.IP "\(em" 2m
choose one from the prompted list of available regions.
.RE
.sp

.TP 2m
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR

The email address of a service account to use when running the training
appplication. You must have the \f5iam.serviceAccounts.actAs\fR permission for
the specified service account.

.TP 2m

Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the hyperparameter tuning job. The 'Vertex AI Service Agent'
service account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'.
The arguments in this group can be used to specify the attributes of this
resource.


.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

ID of the key or fully qualified identifier for the key.

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

The KMS keyring of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

The Google Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

The Google Cloud project for the key.

To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha ai hp\-tuning\-jobs create
.RE

.RS 2m
$ gcloud beta ai hp\-tuning\-jobs create
.RE