Returns the operations Resource.
cancel(name, body=None, x__xgafv=None)
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`.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a HyperparameterTuningJob
Deletes a HyperparameterTuningJob.
Gets a HyperparameterTuningJob
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists HyperparameterTuningJobs in a Location.
Retrieves the next page of results.
cancel(name, body=None, x__xgafv=None)
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`.
Args:
name: string, Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for JobService.CancelHyperparameterTuningJob.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a HyperparameterTuningJob
Args:
parent: string, Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
"createTime": "A String", # Output only. Time when the HyperparameterTuningJob was created.
"displayName": "A String", # Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"maxFailedTrialCount": 42, # The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
"maxTrialCount": 42, # Required. The desired total number of Trials.
"name": "A String", # Output only. Resource name of the HyperparameterTuningJob.
"parallelTrialCount": 42, # Required. The desired number of Trials to run in parallel.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"studySpec": { # Represents specification of a Study. # Required. Study configuration of the HyperparameterTuningJob.
"algorithm": "A String", # The search algorithm specified for the Study.
"convexAutomatedStoppingSpec": { # Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model. # The automated early stopping spec using convex stopping rule.
"learningRateParameterName": "A String", # The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.
"maxStepCount": "A String", # Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. If not defined, it will learn it from the completed trials. When use_steps is false, this field is set to the maximum elapsed seconds.
"minMeasurementCount": "A String", # The minimal number of measurements in a Trial. Early-stopping checks will not trigger if less than min_measurement_count+1 completed trials or pending trials with less than min_measurement_count measurements. If not defined, the default value is 5.
"minStepCount": "A String", # Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count > min_step_count won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_step_count is set to be one-tenth of the max_step_count. When use_elapsed_duration is true, this field is set to the minimum elapsed seconds.
"updateAllStoppedTrials": True or False, # ConvexAutomatedStoppingSpec by default only updates the trials that needs to be early stopped using a newly trained auto-regressive model. When this flag is set to True, all stopped trials from the beginning are potentially updated in terms of their `final_measurement`. Also, note that the training logic of autoregressive models is different in this case. Enabling this option has shown better results and this may be the default option in the future.
"useElapsedDuration": True or False, # This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_elapsed_duration==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_elapsed_duration==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds.
},
"decayCurveStoppingSpec": { # The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far. # The automated early stopping spec using decay curve rule.
"useElapsedDuration": True or False, # True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.
},
"measurementSelectionType": "A String", # Describe which measurement selection type will be used
"medianAutomatedStoppingSpec": { # The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement. # The automated early stopping spec using median rule.
"useElapsedDuration": True or False, # True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.
},
"metrics": [ # Required. Metric specs for the Study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
"safetyConfig": { # Used in safe optimization to specify threshold levels and risk tolerance. # Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.
"desiredMinSafeTrialsFraction": 3.14, # Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.
"safetyThreshold": 3.14, # Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
},
},
],
"observationNoise": "A String", # The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # Value specification for a parameter in `CATEGORICAL` type. # The value spec for a 'CATEGORICAL' parameter.
"defaultValue": "A String", # A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. The list of possible categories.
"A String",
],
},
"conditionalParameterSpecs": [ # A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
{ # Represents a parameter spec with condition from its parent parameter.
"parameterSpec": # Object with schema name: GoogleCloudAiplatformV1StudySpecParameterSpec # Required. The spec for a conditional parameter.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. # The spec for matching values from a parent parameter of `CATEGORICAL` type.
"values": [ # Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. # The spec for matching values from a parent parameter of `DISCRETE` type.
"values": [ # Required. Matches values of the parent parameter of 'DISCRETE' type. All values must exist in `discrete_value_spec` of parent parameter. The Epsilon of the value matching is 1e-10.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter. # The spec for matching values from a parent parameter of `INTEGER` type.
"values": [ # Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
},
],
"discreteValueSpec": { # Value specification for a parameter in `DISCRETE` type. # The value spec for a 'DISCRETE' parameter.
"defaultValue": 3.14, # A default value for a `DISCRETE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # Value specification for a parameter in `DOUBLE` type. # The value spec for a 'DOUBLE' parameter.
"defaultValue": 3.14, # A default value for a `DOUBLE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": 3.14, # Required. Inclusive maximum value of the parameter.
"minValue": 3.14, # Required. Inclusive minimum value of the parameter.
},
"integerValueSpec": { # Value specification for a parameter in `INTEGER` type. # The value spec for an 'INTEGER' parameter.
"defaultValue": "A String", # A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": "A String", # Required. Inclusive maximum value of the parameter.
"minValue": "A String", # Required. Inclusive minimum value of the parameter.
},
"parameterId": "A String", # Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
"scaleType": "A String", # How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.
},
],
"studyStoppingConfig": { # The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection. # Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
"maxDurationNoProgress": "A String", # If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.
"maxNumTrials": 42, # If there are more than this many trials, stop the study.
"maxNumTrialsNoProgress": 42, # If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.
"maximumRuntimeConstraint": { # Time-based Constraint for Study # If the specified time or duration has passed, stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"minNumTrials": 42, # If there are fewer than this many COMPLETED trials, do not stop the study.
"minimumRuntimeConstraint": { # Time-based Constraint for Study # Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"shouldStopAsap": True or False, # If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
},
},
"trialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. 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 `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # Optional. The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
"trials": [ # Output only. Trials of the HyperparameterTuningJob.
{ # A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.
"clientId": "A String", # Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
"customJob": "A String", # Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
"endTime": "A String", # Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the Trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.
"measurements": [ # Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
{ # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
],
"name": "A String", # Output only. Resource name of the Trial assigned by the service.
"parameters": [ # Output only. The parameters of the Trial.
{ # A message representing a parameter to be tuned.
"parameterId": "A String", # Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
"value": "", # Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.
},
],
"startTime": "A String", # Output only. Time when the Trial was started.
"state": "A String", # Output only. The detailed state of the Trial.
"webAccessUris": { # Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
"a_key": "A String",
},
},
],
"updateTime": "A String", # Output only. Time when the HyperparameterTuningJob was most recently updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
"createTime": "A String", # Output only. Time when the HyperparameterTuningJob was created.
"displayName": "A String", # Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"maxFailedTrialCount": 42, # The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
"maxTrialCount": 42, # Required. The desired total number of Trials.
"name": "A String", # Output only. Resource name of the HyperparameterTuningJob.
"parallelTrialCount": 42, # Required. The desired number of Trials to run in parallel.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"studySpec": { # Represents specification of a Study. # Required. Study configuration of the HyperparameterTuningJob.
"algorithm": "A String", # The search algorithm specified for the Study.
"convexAutomatedStoppingSpec": { # Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model. # The automated early stopping spec using convex stopping rule.
"learningRateParameterName": "A String", # The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.
"maxStepCount": "A String", # Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. If not defined, it will learn it from the completed trials. When use_steps is false, this field is set to the maximum elapsed seconds.
"minMeasurementCount": "A String", # The minimal number of measurements in a Trial. Early-stopping checks will not trigger if less than min_measurement_count+1 completed trials or pending trials with less than min_measurement_count measurements. If not defined, the default value is 5.
"minStepCount": "A String", # Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count > min_step_count won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_step_count is set to be one-tenth of the max_step_count. When use_elapsed_duration is true, this field is set to the minimum elapsed seconds.
"updateAllStoppedTrials": True or False, # ConvexAutomatedStoppingSpec by default only updates the trials that needs to be early stopped using a newly trained auto-regressive model. When this flag is set to True, all stopped trials from the beginning are potentially updated in terms of their `final_measurement`. Also, note that the training logic of autoregressive models is different in this case. Enabling this option has shown better results and this may be the default option in the future.
"useElapsedDuration": True or False, # This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_elapsed_duration==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_elapsed_duration==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds.
},
"decayCurveStoppingSpec": { # The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far. # The automated early stopping spec using decay curve rule.
"useElapsedDuration": True or False, # True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.
},
"measurementSelectionType": "A String", # Describe which measurement selection type will be used
"medianAutomatedStoppingSpec": { # The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement. # The automated early stopping spec using median rule.
"useElapsedDuration": True or False, # True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.
},
"metrics": [ # Required. Metric specs for the Study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
"safetyConfig": { # Used in safe optimization to specify threshold levels and risk tolerance. # Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.
"desiredMinSafeTrialsFraction": 3.14, # Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.
"safetyThreshold": 3.14, # Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
},
},
],
"observationNoise": "A String", # The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # Value specification for a parameter in `CATEGORICAL` type. # The value spec for a 'CATEGORICAL' parameter.
"defaultValue": "A String", # A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. The list of possible categories.
"A String",
],
},
"conditionalParameterSpecs": [ # A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
{ # Represents a parameter spec with condition from its parent parameter.
"parameterSpec": # Object with schema name: GoogleCloudAiplatformV1StudySpecParameterSpec # Required. The spec for a conditional parameter.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. # The spec for matching values from a parent parameter of `CATEGORICAL` type.
"values": [ # Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. # The spec for matching values from a parent parameter of `DISCRETE` type.
"values": [ # Required. Matches values of the parent parameter of 'DISCRETE' type. All values must exist in `discrete_value_spec` of parent parameter. The Epsilon of the value matching is 1e-10.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter. # The spec for matching values from a parent parameter of `INTEGER` type.
"values": [ # Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
},
],
"discreteValueSpec": { # Value specification for a parameter in `DISCRETE` type. # The value spec for a 'DISCRETE' parameter.
"defaultValue": 3.14, # A default value for a `DISCRETE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # Value specification for a parameter in `DOUBLE` type. # The value spec for a 'DOUBLE' parameter.
"defaultValue": 3.14, # A default value for a `DOUBLE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": 3.14, # Required. Inclusive maximum value of the parameter.
"minValue": 3.14, # Required. Inclusive minimum value of the parameter.
},
"integerValueSpec": { # Value specification for a parameter in `INTEGER` type. # The value spec for an 'INTEGER' parameter.
"defaultValue": "A String", # A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": "A String", # Required. Inclusive maximum value of the parameter.
"minValue": "A String", # Required. Inclusive minimum value of the parameter.
},
"parameterId": "A String", # Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
"scaleType": "A String", # How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.
},
],
"studyStoppingConfig": { # The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection. # Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
"maxDurationNoProgress": "A String", # If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.
"maxNumTrials": 42, # If there are more than this many trials, stop the study.
"maxNumTrialsNoProgress": 42, # If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.
"maximumRuntimeConstraint": { # Time-based Constraint for Study # If the specified time or duration has passed, stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"minNumTrials": 42, # If there are fewer than this many COMPLETED trials, do not stop the study.
"minimumRuntimeConstraint": { # Time-based Constraint for Study # Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"shouldStopAsap": True or False, # If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
},
},
"trialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. 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 `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # Optional. The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
"trials": [ # Output only. Trials of the HyperparameterTuningJob.
{ # A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.
"clientId": "A String", # Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
"customJob": "A String", # Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
"endTime": "A String", # Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the Trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.
"measurements": [ # Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
{ # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
],
"name": "A String", # Output only. Resource name of the Trial assigned by the service.
"parameters": [ # Output only. The parameters of the Trial.
{ # A message representing a parameter to be tuned.
"parameterId": "A String", # Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
"value": "", # Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.
},
],
"startTime": "A String", # Output only. Time when the Trial was started.
"state": "A String", # Output only. The detailed state of the Trial.
"webAccessUris": { # Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
"a_key": "A String",
},
},
],
"updateTime": "A String", # Output only. Time when the HyperparameterTuningJob was most recently updated.
}
delete(name, x__xgafv=None)
Deletes a HyperparameterTuningJob.
Args:
name: string, Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets a HyperparameterTuningJob
Args:
name: string, Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
"createTime": "A String", # Output only. Time when the HyperparameterTuningJob was created.
"displayName": "A String", # Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"maxFailedTrialCount": 42, # The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
"maxTrialCount": 42, # Required. The desired total number of Trials.
"name": "A String", # Output only. Resource name of the HyperparameterTuningJob.
"parallelTrialCount": 42, # Required. The desired number of Trials to run in parallel.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"studySpec": { # Represents specification of a Study. # Required. Study configuration of the HyperparameterTuningJob.
"algorithm": "A String", # The search algorithm specified for the Study.
"convexAutomatedStoppingSpec": { # Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model. # The automated early stopping spec using convex stopping rule.
"learningRateParameterName": "A String", # The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.
"maxStepCount": "A String", # Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. If not defined, it will learn it from the completed trials. When use_steps is false, this field is set to the maximum elapsed seconds.
"minMeasurementCount": "A String", # The minimal number of measurements in a Trial. Early-stopping checks will not trigger if less than min_measurement_count+1 completed trials or pending trials with less than min_measurement_count measurements. If not defined, the default value is 5.
"minStepCount": "A String", # Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count > min_step_count won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_step_count is set to be one-tenth of the max_step_count. When use_elapsed_duration is true, this field is set to the minimum elapsed seconds.
"updateAllStoppedTrials": True or False, # ConvexAutomatedStoppingSpec by default only updates the trials that needs to be early stopped using a newly trained auto-regressive model. When this flag is set to True, all stopped trials from the beginning are potentially updated in terms of their `final_measurement`. Also, note that the training logic of autoregressive models is different in this case. Enabling this option has shown better results and this may be the default option in the future.
"useElapsedDuration": True or False, # This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_elapsed_duration==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_elapsed_duration==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds.
},
"decayCurveStoppingSpec": { # The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far. # The automated early stopping spec using decay curve rule.
"useElapsedDuration": True or False, # True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.
},
"measurementSelectionType": "A String", # Describe which measurement selection type will be used
"medianAutomatedStoppingSpec": { # The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement. # The automated early stopping spec using median rule.
"useElapsedDuration": True or False, # True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.
},
"metrics": [ # Required. Metric specs for the Study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
"safetyConfig": { # Used in safe optimization to specify threshold levels and risk tolerance. # Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.
"desiredMinSafeTrialsFraction": 3.14, # Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.
"safetyThreshold": 3.14, # Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
},
},
],
"observationNoise": "A String", # The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # Value specification for a parameter in `CATEGORICAL` type. # The value spec for a 'CATEGORICAL' parameter.
"defaultValue": "A String", # A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. The list of possible categories.
"A String",
],
},
"conditionalParameterSpecs": [ # A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
{ # Represents a parameter spec with condition from its parent parameter.
"parameterSpec": # Object with schema name: GoogleCloudAiplatformV1StudySpecParameterSpec # Required. The spec for a conditional parameter.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. # The spec for matching values from a parent parameter of `CATEGORICAL` type.
"values": [ # Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. # The spec for matching values from a parent parameter of `DISCRETE` type.
"values": [ # Required. Matches values of the parent parameter of 'DISCRETE' type. All values must exist in `discrete_value_spec` of parent parameter. The Epsilon of the value matching is 1e-10.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter. # The spec for matching values from a parent parameter of `INTEGER` type.
"values": [ # Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
},
],
"discreteValueSpec": { # Value specification for a parameter in `DISCRETE` type. # The value spec for a 'DISCRETE' parameter.
"defaultValue": 3.14, # A default value for a `DISCRETE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # Value specification for a parameter in `DOUBLE` type. # The value spec for a 'DOUBLE' parameter.
"defaultValue": 3.14, # A default value for a `DOUBLE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": 3.14, # Required. Inclusive maximum value of the parameter.
"minValue": 3.14, # Required. Inclusive minimum value of the parameter.
},
"integerValueSpec": { # Value specification for a parameter in `INTEGER` type. # The value spec for an 'INTEGER' parameter.
"defaultValue": "A String", # A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": "A String", # Required. Inclusive maximum value of the parameter.
"minValue": "A String", # Required. Inclusive minimum value of the parameter.
},
"parameterId": "A String", # Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
"scaleType": "A String", # How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.
},
],
"studyStoppingConfig": { # The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection. # Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
"maxDurationNoProgress": "A String", # If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.
"maxNumTrials": 42, # If there are more than this many trials, stop the study.
"maxNumTrialsNoProgress": 42, # If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.
"maximumRuntimeConstraint": { # Time-based Constraint for Study # If the specified time or duration has passed, stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"minNumTrials": 42, # If there are fewer than this many COMPLETED trials, do not stop the study.
"minimumRuntimeConstraint": { # Time-based Constraint for Study # Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"shouldStopAsap": True or False, # If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
},
},
"trialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. 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 `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # Optional. The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
"trials": [ # Output only. Trials of the HyperparameterTuningJob.
{ # A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.
"clientId": "A String", # Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
"customJob": "A String", # Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
"endTime": "A String", # Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the Trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.
"measurements": [ # Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
{ # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
],
"name": "A String", # Output only. Resource name of the Trial assigned by the service.
"parameters": [ # Output only. The parameters of the Trial.
{ # A message representing a parameter to be tuned.
"parameterId": "A String", # Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
"value": "", # Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.
},
],
"startTime": "A String", # Output only. Time when the Trial was started.
"state": "A String", # Output only. The detailed state of the Trial.
"webAccessUris": { # Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
"a_key": "A String",
},
},
],
"updateTime": "A String", # Output only. Time when the HyperparameterTuningJob was most recently updated.
}
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists HyperparameterTuningJobs in a Location.
Args:
parent: string, Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}` (required)
filter: string, The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
readMask: string, Mask specifying which fields to read.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for JobService.ListHyperparameterTuningJobs
"hyperparameterTuningJobs": [ # List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials of the jobs will be not be returned.
{ # Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
"createTime": "A String", # Output only. Time when the HyperparameterTuningJob was created.
"displayName": "A String", # Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
"maxFailedTrialCount": 42, # The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
"maxTrialCount": 42, # Required. The desired total number of Trials.
"name": "A String", # Output only. Resource name of the HyperparameterTuningJob.
"parallelTrialCount": 42, # Required. The desired number of Trials to run in parallel.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"startTime": "A String", # Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
"studySpec": { # Represents specification of a Study. # Required. Study configuration of the HyperparameterTuningJob.
"algorithm": "A String", # The search algorithm specified for the Study.
"convexAutomatedStoppingSpec": { # Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model. # The automated early stopping spec using convex stopping rule.
"learningRateParameterName": "A String", # The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.
"maxStepCount": "A String", # Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. If not defined, it will learn it from the completed trials. When use_steps is false, this field is set to the maximum elapsed seconds.
"minMeasurementCount": "A String", # The minimal number of measurements in a Trial. Early-stopping checks will not trigger if less than min_measurement_count+1 completed trials or pending trials with less than min_measurement_count measurements. If not defined, the default value is 5.
"minStepCount": "A String", # Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count > min_step_count won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_step_count is set to be one-tenth of the max_step_count. When use_elapsed_duration is true, this field is set to the minimum elapsed seconds.
"updateAllStoppedTrials": True or False, # ConvexAutomatedStoppingSpec by default only updates the trials that needs to be early stopped using a newly trained auto-regressive model. When this flag is set to True, all stopped trials from the beginning are potentially updated in terms of their `final_measurement`. Also, note that the training logic of autoregressive models is different in this case. Enabling this option has shown better results and this may be the default option in the future.
"useElapsedDuration": True or False, # This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_elapsed_duration==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_elapsed_duration==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds.
},
"decayCurveStoppingSpec": { # The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far. # The automated early stopping spec using decay curve rule.
"useElapsedDuration": True or False, # True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.
},
"measurementSelectionType": "A String", # Describe which measurement selection type will be used
"medianAutomatedStoppingSpec": { # The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement. # The automated early stopping spec using median rule.
"useElapsedDuration": True or False, # True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.
},
"metrics": [ # Required. Metric specs for the Study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metricId": "A String", # Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
"safetyConfig": { # Used in safe optimization to specify threshold levels and risk tolerance. # Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.
"desiredMinSafeTrialsFraction": 3.14, # Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.
"safetyThreshold": 3.14, # Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
},
},
],
"observationNoise": "A String", # The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # Value specification for a parameter in `CATEGORICAL` type. # The value spec for a 'CATEGORICAL' parameter.
"defaultValue": "A String", # A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. The list of possible categories.
"A String",
],
},
"conditionalParameterSpecs": [ # A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
{ # Represents a parameter spec with condition from its parent parameter.
"parameterSpec": # Object with schema name: GoogleCloudAiplatformV1StudySpecParameterSpec # Required. The spec for a conditional parameter.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. # The spec for matching values from a parent parameter of `CATEGORICAL` type.
"values": [ # Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. # The spec for matching values from a parent parameter of `DISCRETE` type.
"values": [ # Required. Matches values of the parent parameter of 'DISCRETE' type. All values must exist in `discrete_value_spec` of parent parameter. The Epsilon of the value matching is 1e-10.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter. # The spec for matching values from a parent parameter of `INTEGER` type.
"values": [ # Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
},
],
"discreteValueSpec": { # Value specification for a parameter in `DISCRETE` type. # The value spec for a 'DISCRETE' parameter.
"defaultValue": 3.14, # A default value for a `DISCRETE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"values": [ # Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # Value specification for a parameter in `DOUBLE` type. # The value spec for a 'DOUBLE' parameter.
"defaultValue": 3.14, # A default value for a `DOUBLE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": 3.14, # Required. Inclusive maximum value of the parameter.
"minValue": 3.14, # Required. Inclusive minimum value of the parameter.
},
"integerValueSpec": { # Value specification for a parameter in `INTEGER` type. # The value spec for an 'INTEGER' parameter.
"defaultValue": "A String", # A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.
"maxValue": "A String", # Required. Inclusive maximum value of the parameter.
"minValue": "A String", # Required. Inclusive minimum value of the parameter.
},
"parameterId": "A String", # Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
"scaleType": "A String", # How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.
},
],
"studyStoppingConfig": { # The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection. # Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
"maxDurationNoProgress": "A String", # If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.
"maxNumTrials": 42, # If there are more than this many trials, stop the study.
"maxNumTrialsNoProgress": 42, # If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.
"maximumRuntimeConstraint": { # Time-based Constraint for Study # If the specified time or duration has passed, stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"minNumTrials": 42, # If there are fewer than this many COMPLETED trials, do not stop the study.
"minimumRuntimeConstraint": { # Time-based Constraint for Study # Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
"endTime": "A String", # Compares the wallclock time to this time. Must use UTC timezone.
"maxDuration": "A String", # Counts the wallclock time passed since the creation of this Study.
},
"shouldStopAsap": True or False, # If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
},
},
"trialJobSpec": { # Represents the spec of a CustomJob. # Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
"baseOutputDirectory": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"enableDashboardAccess": True or False, # Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"enableWebAccess": True or False, # Optional. 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 `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
"experiment": "A String", # Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
"experimentRun": "A String", # Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
"models": [ # Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
"A String",
],
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.
"persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
"protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
"reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"maxWaitDuration": "A String", # Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.
"restartJobOnWorkerRestart": True or False, # Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # Optional. The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
"tensorboard": "A String", # Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
"workerPoolSpecs": [ # Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
{ # Represents the spec of a worker pool in a job.
"containerSpec": { # The spec of a Container. # The custom container task.
"args": [ # The arguments to be passed when starting the container.
"A String",
],
"command": [ # The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
"A String",
],
"env": [ # Environment variables to be passed to the container. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"imageUri": "A String", # Required. The URI of a container image in the Container Registry that is to be run on each worker replica.
},
"diskSpec": { # Represents the spec of disk options. # Disk spec.
"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
"bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
},
"machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"nfsMounts": [ # Optional. List of NFS mount spec.
{ # Represents a mount configuration for Network File System (NFS) to mount.
"mountPoint": "A String", # Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/
"path": "A String", # Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`
"server": "A String", # Required. IP address of the NFS server.
},
],
"pythonPackageSpec": { # The spec of a Python packaged code. # The Python packaged task.
"args": [ # Command line arguments to be passed to the Python task.
"A String",
],
"env": [ # Environment variables to be passed to the python module. Maximum limit is 100.
{ # Represents an environment variable present in a Container or Python Module.
"name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
"value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
},
],
"executorImageUri": "A String", # Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list.
"packageUris": [ # Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
"A String",
],
"pythonModule": "A String", # Required. The Python module name to run after installing the packages.
},
"replicaCount": "A String", # Optional. The number of worker replicas to use for this worker pool.
},
],
},
"trials": [ # Output only. Trials of the HyperparameterTuningJob.
{ # A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.
"clientId": "A String", # Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
"customJob": "A String", # Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
"endTime": "A String", # Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
"finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
"id": "A String", # Output only. The identifier of the Trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.
"measurements": [ # Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
{ # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.
"elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
"metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
{ # A message representing a metric in the measurement.
"metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
"value": 3.14, # Output only. The value for this metric.
},
],
"stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
},
],
"name": "A String", # Output only. Resource name of the Trial assigned by the service.
"parameters": [ # Output only. The parameters of the Trial.
{ # A message representing a parameter to be tuned.
"parameterId": "A String", # Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
"value": "", # Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.
},
],
"startTime": "A String", # Output only. Time when the Trial was started.
"state": "A String", # Output only. The detailed state of the Trial.
"webAccessUris": { # Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
"a_key": "A String",
},
},
],
"updateTime": "A String", # Output only. Time when the HyperparameterTuningJob was most recently updated.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListHyperparameterTuningJobsRequest.page_token to obtain that page.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.