Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJobSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

Represents the spec of a CustomJob.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1CustomJobSpec

Returns a new instance of GoogleCloudAiplatformV1beta1CustomJobSpec.



4260
4261
4262
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4260

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#base_output_directory ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GcsDestination

The Google Cloud Storage location where the output is to be written to. Corresponds to the JSON property baseOutputDirectory

Returns:



4148
4149
4150
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4148

def base_output_directory
  @base_output_directory
end

#enable_dashboard_access ⇒ Boolean Also known as: enable_dashboard_access?

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). Corresponds to the JSON property enableDashboardAccess

Returns:

  • (Boolean) 


4156
4157
4158
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4156

def enable_dashboard_access
  @enable_dashboard_access
end

#enable_web_access ⇒ Boolean Also known as: enable_web_access?

Optional. Whether you want Vertex AI to enable interactive shell access 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). Corresponds to the JSON property enableWebAccess

Returns:

  • (Boolean) 


4166
4167
4168
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4166

def enable_web_access
  @enable_web_access
end

#experiment ⇒ String

Optional. The Experiment associated with this job. Format: projects/project/ locations/location/metadataStores/metadataStores/contexts/experiment-name Corresponds to the JSON property experiment

Returns:

  • (String) 


4174
4175
4176
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4174

def experiment
  @experiment
end

#experiment_run ⇒ String

Optional. The Experiment Run associated with this job. Format: projects/ project/locations/location/metadataStores/metadataStores/contexts/ experiment-name-experiment-run-name` Corresponds to the JSON propertyexperimentRun`

Returns:

  • (String) 


4181
4182
4183
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4181

def experiment_run
  @experiment_run
end

#models ⇒ Array<String>

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 @2orprojects/project/locations/location/models/model@goldenIf 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. Corresponds to the JSON propertymodels`

Returns:

  • (Array<String>) 


4194
4195
4196
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4194

def models
  @models
end

#network ⇒ String

Optional. The full name of the Compute Engine network to which the Job should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/project/global/networks/ network`. Whereprojectis a project number, as in12345, andnetwork 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. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


4207
4208
4209
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4207

def network
  @network
end

#persistent_resource_id ⇒ 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. Corresponds to the JSON property persistentResourceId

Returns:

  • (String) 


4216
4217
4218
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4216

def persistent_resource_id
  @persistent_resource_id
end

#protected_artifact_location_id ⇒ 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 Corresponds to the JSON property protectedArtifactLocationId

Returns:

  • (String) 


4223
4224
4225
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4223

def protected_artifact_location_id
  @protected_artifact_location_id
end

#reserved_ip_ranges ⇒ Array<String>

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']. Corresponds to the JSON property reservedIpRanges

Returns:

  • (Array<String>) 


4231
4232
4233
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4231

def reserved_ip_ranges
  @reserved_ip_ranges
end

#scheduling ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Scheduling

All parameters related to queuing and scheduling of custom jobs. Corresponds to the JSON property scheduling

Returns:



4236
4237
4238
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4236

def scheduling
  @scheduling
end

#service_account ⇒ 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 for the CustomJob's project is used. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


4244
4245
4246
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4244

def 
  @service_account
end

#tensorboard ⇒ 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` Corresponds to the JSON propertytensorboard`

Returns:

  • (String) 


4251
4252
4253
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4251

def tensorboard
  @tensorboard
end

#worker_pool_specs ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WorkerPoolSpec>

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. Corresponds to the JSON property workerPoolSpecs

Returns:



4258
4259
4260
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4258

def worker_pool_specs
  @worker_pool_specs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4265

def update!(**args)
  @base_output_directory = args[:base_output_directory] if args.key?(:base_output_directory)
  @enable_dashboard_access = args[:enable_dashboard_access] if args.key?(:enable_dashboard_access)
  @enable_web_access = args[:enable_web_access] if args.key?(:enable_web_access)
  @experiment = args[:experiment] if args.key?(:experiment)
  @experiment_run = args[:experiment_run] if args.key?(:experiment_run)
  @models = args[:models] if args.key?(:models)
  @network = args[:network] if args.key?(:network)
  @persistent_resource_id = args[:persistent_resource_id] if args.key?(:persistent_resource_id)
  @protected_artifact_location_id = args[:protected_artifact_location_id] if args.key?(:protected_artifact_location_id)
  @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
  @scheduling = args[:scheduling] if args.key?(:scheduling)
  @service_account = args[:service_account] if args.key?(:service_account)
  @tensorboard = args[:tensorboard] if args.key?(:tensorboard)
  @worker_pool_specs = args[:worker_pool_specs] if args.key?(:worker_pool_specs)
end