Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob

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 a TuningJob that runs with Google owned models.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1TuningJob

Returns a new instance of GoogleCloudAiplatformV1beta1TuningJob.



56435
56436
56437
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56435

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

Instance Attribute Details

#base_model ⇒ String

The base model that is being tuned. See Supported models. Corresponds to the JSON property baseModel

Returns:

  • (String) 


56248
56249
56250
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56248

def base_model
  @base_model
end

#create_time ⇒ String

Output only. Time when the TuningJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


56253
56254
56255
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56253

def create_time
  @create_time
end

#custom_base_model ⇒ String

Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. Corresponds to the JSON property customBaseModel

Returns:

  • (String) 


56263
56264
56265
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56263

def custom_base_model
  @custom_base_model
end

#description ⇒ String

Optional. The description of the TuningJob. Corresponds to the JSON property description

Returns:

  • (String) 


56268
56269
56270
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56268

def description
  @description
end

#distillation_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DistillationSpec

Tuning Spec for Distillation. Corresponds to the JSON property distillationSpec

Returns:



56273
56274
56275
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56273

def distillation_spec
  @distillation_spec
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



56279
56280
56281
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56279

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

Output only. Time when the TuningJob entered any of the following JobStates: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED. Corresponds to the JSON property endTime

Returns:

  • (String) 


56286
56287
56288
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56286

def end_time
  @end_time
end

#error ⇒ Google::Apis::AiplatformV1beta1::GoogleRpcStatus

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

Returns:



56296
56297
56298
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56296

def error
  @error
end

#evaluate_dataset_runs ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateDatasetRun>

Output only. Evaluation runs for the Tuning Job. Corresponds to the JSON property evaluateDatasetRuns

Returns:



56301
56302
56303
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56301

def evaluate_dataset_runs
  @evaluate_dataset_runs
end

#experiment ⇒ String

Output only. The Experiment associated with this TuningJob. Corresponds to the JSON property experiment

Returns:

  • (String) 


56306
56307
56308
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56306

def experiment
  @experiment
end

#full_fine_tuning_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FullFineTuningSpec

Tuning Spec for Full Fine Tuning. Corresponds to the JSON property fullFineTuningSpec

Returns:



56311
56312
56313
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56311

def full_fine_tuning_spec
  @full_fine_tuning_spec
end

#labels ⇒ Hash<String,String>

Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


56321
56322
56323
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56321

def labels
  @labels
end

#name ⇒ String

Output only. Identifier. Resource name of a TuningJob. Format: projects/ project/locations/location/tuningJobs/tuning_job` Corresponds to the JSON propertyname`

Returns:

  • (String) 


56327
56328
56329
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56327

def name
  @name
end

#output_uri ⇒ String

Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. Corresponds to the JSON property outputUri

Returns:

  • (String) 


56333
56334
56335
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56333

def output_uri
  @output_uri
end

#partner_model_tuning_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PartnerModelTuningSpec

Tuning spec for Partner models. Corresponds to the JSON property partnerModelTuningSpec

Returns:



56338
56339
56340
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56338

def partner_model_tuning_spec
  @partner_model_tuning_spec
end

#pipeline_job ⇒ String

Output only. The resource name of the PipelineJob associated with the TuningJob. Format: projects/project/locations/location/pipelineJobs/ pipeline_job`. Corresponds to the JSON propertypipelineJob`

Returns:

  • (String) 


56345
56346
56347
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56345

def pipeline_job
  @pipeline_job
end

#pre_tuned_model ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PreTunedModel

A pre-tuned model for continuous tuning. Corresponds to the JSON property preTunedModel

Returns:



56350
56351
56352
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56350

def pre_tuned_model
  @pre_tuned_model
end

#preference_optimization_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec

Tuning Spec for Preference Optimization. Corresponds to the JSON property preferenceOptimizationSpec

Returns:



56355
56356
56357
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56355

def preference_optimization_spec
  @preference_optimization_spec
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


56360
56361
56362
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56360

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


56366
56367
56368
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56366

def satisfies_pzs
  @satisfies_pzs
end

#service_account ⇒ String

The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning- service-agent Users starting the pipeline must have the iam.serviceAccounts. actAs permission on this service account. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


56376
56377
56378
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56376

def 
  @service_account
end

#start_time ⇒ String

Output only. Time when the TuningJob for the first time entered the JOB_STATE_RUNNING state. Corresponds to the JSON property startTime

Returns:

  • (String) 


56382
56383
56384
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56382

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


56387
56388
56389
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56387

def state
  @state
end

#supervised_tuning_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SupervisedTuningSpec

Tuning Spec for Supervised Tuning for first party models. Corresponds to the JSON property supervisedTuningSpec

Returns:



56392
56393
56394
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56392

def supervised_tuning_spec
  @supervised_tuning_spec
end

#tuned_model ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TunedModel

The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. Corresponds to the JSON property tunedModel

Returns:



56398
56399
56400
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56398

def tuned_model
  @tuned_model
end

#tuned_model_display_name ⇒ String

Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre- tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. Corresponds to the JSON property tunedModelDisplayName

Returns:

  • (String) 


56407
56408
56409
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56407

def tuned_model_display_name
  @tuned_model_display_name
end

#tuning_data_stats ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningDataStats

The tuning data statistic values for TuningJob. Corresponds to the JSON property tuningDataStats

Returns:



56412
56413
56414
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56412

def tuning_data_stats
  @tuning_data_stats
end

#tuning_job_metadata ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJobMetadata

Tuning job metadata. Corresponds to the JSON property tuningJobMetadata

Returns:



56417
56418
56419
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56417

def tuning_job_metadata
  @tuning_job_metadata
end

#tuning_job_state ⇒ String

Output only. The detail state of the tuning job (while the overall JobState is running). Corresponds to the JSON property tuningJobState

Returns:

  • (String) 


56423
56424
56425
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56423

def tuning_job_state
  @tuning_job_state
end

#update_time ⇒ String

Output only. Time when the TuningJob was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


56428
56429
56430
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56428

def update_time
  @update_time
end

#veo_tuning_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VeoTuningSpec

Tuning Spec for Veo Model Tuning. Corresponds to the JSON property veoTuningSpec

Returns:



56433
56434
56435
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56433

def veo_tuning_spec
  @veo_tuning_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



56440
56441
56442
56443
56444
56445
56446
56447
56448
56449
56450
56451
56452
56453
56454
56455
56456
56457
56458
56459
56460
56461
56462
56463
56464
56465
56466
56467
56468
56469
56470
56471
56472
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56440

def update!(**args)
  @base_model = args[:base_model] if args.key?(:base_model)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom_base_model = args[:custom_base_model] if args.key?(:custom_base_model)
  @description = args[:description] if args.key?(:description)
  @distillation_spec = args[:distillation_spec] if args.key?(:distillation_spec)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @evaluate_dataset_runs = args[:evaluate_dataset_runs] if args.key?(:evaluate_dataset_runs)
  @experiment = args[:experiment] if args.key?(:experiment)
  @full_fine_tuning_spec = args[:full_fine_tuning_spec] if args.key?(:full_fine_tuning_spec)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @output_uri = args[:output_uri] if args.key?(:output_uri)
  @partner_model_tuning_spec = args[:partner_model_tuning_spec] if args.key?(:partner_model_tuning_spec)
  @pipeline_job = args[:pipeline_job] if args.key?(:pipeline_job)
  @pre_tuned_model = args[:pre_tuned_model] if args.key?(:pre_tuned_model)
  @preference_optimization_spec = args[:preference_optimization_spec] if args.key?(:preference_optimization_spec)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @service_account = args[:service_account] if args.key?(:service_account)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @supervised_tuning_spec = args[:supervised_tuning_spec] if args.key?(:supervised_tuning_spec)
  @tuned_model = args[:tuned_model] if args.key?(:tuned_model)
  @tuned_model_display_name = args[:tuned_model_display_name] if args.key?(:tuned_model_display_name)
  @tuning_data_stats = args[:tuning_data_stats] if args.key?(:tuning_data_stats)
  @tuning_job_metadata = args[:tuning_job_metadata] if args.key?(:tuning_job_metadata)
  @tuning_job_state = args[:tuning_job_state] if args.key?(:tuning_job_state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @veo_tuning_spec = args[:veo_tuning_spec] if args.key?(:veo_tuning_spec)
end