Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob

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

Overview

Represents a TuningJob that runs with Google owned models.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1TuningJob

Returns a new instance of GoogleCloudAiplatformV1TuningJob.



28716
28717
28718
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28716

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

Instance Attribute Details

#base_model ⇒ String

Model name for tuning, e.g., "gemini-1.0-pro-002". Corresponds to the JSON property baseModel

Returns:

  • (String) 


28628
28629
28630
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28628

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) 


28633
28634
28635
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28633

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


28638
28639
28640
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28638

def description
  @description
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) 


28645
28646
28647
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28645

def end_time
  @end_time
end

#error ⇒ Google::Apis::AiplatformV1::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:



28655
28656
28657
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28655

def error
  @error
end

#experiment ⇒ String

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

Returns:

  • (String) 


28660
28661
28662
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28660

def experiment
  @experiment
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>) 


28670
28671
28672
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28670

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) 


28676
28677
28678
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28676

def name
  @name
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) 


28682
28683
28684
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28682

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


28687
28688
28689
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28687

def state
  @state
end

#supervised_tuning_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SupervisedTuningSpec

Tuning Spec for Supervised Tuning. Corresponds to the JSON property supervisedTuningSpec

Returns:



28692
28693
28694
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28692

def supervised_tuning_spec
  @supervised_tuning_spec
end

#tuned_model ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TunedModel

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

Returns:



28698
28699
28700
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28698

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

Returns:

  • (String) 


28704
28705
28706
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28704

def tuned_model_display_name
  @tuned_model_display_name
end

#tuning_data_stats ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningDataStats

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

Returns:



28709
28710
28711
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28709

def tuning_data_stats
  @tuning_data_stats
end

#update_time ⇒ String

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

Returns:

  • (String) 


28714
28715
28716
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28714

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28721
28722
28723
28724
28725
28726
28727
28728
28729
28730
28731
28732
28733
28734
28735
28736
28737
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 28721

def update!(**args)
  @base_model = args[:base_model] if args.key?(:base_model)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @experiment = args[:experiment] if args.key?(:experiment)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @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)
  @update_time = args[:update_time] if args.key?(:update_time)
end