Class: Google::Apis::BigqueryV2::Model

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Model

Returns a new instance of Model.



5418
5419
5420
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5418

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

Instance Attribute Details

#best_trial_id ⇒ Fixnum

The best trial_id across all training runs. Corresponds to the JSON property bestTrialId

Returns:

  • (Fixnum) 


5301
5302
5303
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5301

def best_trial_id
  @best_trial_id
end

#creation_time ⇒ Fixnum

Output only. The time when this model was created, in millisecs since the epoch. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


5307
5308
5309
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5307

def creation_time
  @creation_time
end

#default_trial_id ⇒ Fixnum

Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning models, this is the best trial ID. For multi-objective hyperparameter tuning models, this is the smallest trial ID among all Pareto optimal trials. Corresponds to the JSON property defaultTrialId

Returns:

  • (Fixnum) 


5317
5318
5319
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5317

def default_trial_id
  @default_trial_id
end

#description ⇒ String

Optional. A user-friendly description of this model. Corresponds to the JSON property description

Returns:

  • (String) 


5322
5323
5324
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5322

def description
  @description
end

#encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model. Corresponds to the JSON property encryptionConfiguration

Returns:



5330
5331
5332
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5330

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

Output only. A hash of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


5335
5336
5337
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5335

def etag
  @etag
end

#expiration_time ⇒ Fixnum

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. Corresponds to the JSON property expirationTime

Returns:

  • (Fixnum) 


5344
5345
5346
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5344

def expiration_time
  @expiration_time
end

#feature_columns ⇒ Array<Google::Apis::BigqueryV2::StandardSqlField>

Output only. Input feature columns that were used to train this model. Corresponds to the JSON property featureColumns

Returns:



5349
5350
5351
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5349

def feature_columns
  @feature_columns
end

#friendly_name ⇒ String

Optional. A descriptive name for this model. Corresponds to the JSON property friendlyName

Returns:

  • (String) 


5354
5355
5356
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5354

def friendly_name
  @friendly_name
end

#hparam_search_spaces ⇒ Google::Apis::BigqueryV2::HparamSearchSpaces

Hyperparameter search spaces. These should be a subset of training_options. Corresponds to the JSON property hparamSearchSpaces

Returns:



5359
5360
5361
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5359

def hparam_search_spaces
  @hparam_search_spaces
end

#hparam_trials ⇒ Array<Google::Apis::BigqueryV2::HparamTuningTrial>

Output only. Trials of a hyperparameter tuning model sorted by trial_id. Corresponds to the JSON property hparamTrials

Returns:



5365
5366
5367
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5365

def hparam_trials
  @hparam_trials
end

#label_columns ⇒ Array<Google::Apis::BigqueryV2::StandardSqlField>

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. Corresponds to the JSON property labelColumns

Returns:



5371
5372
5373
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5371

def label_columns
  @label_columns
end

#labels ⇒ Hash<String,String>

The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


5380
5381
5382
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5380

def labels
  @labels
end

#last_modified_time ⇒ Fixnum

Output only. The time when this model was last modified, in millisecs since the epoch. Corresponds to the JSON property lastModifiedTime

Returns:

  • (Fixnum) 


5386
5387
5388
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5386

def last_modified_time
  @last_modified_time
end

#location ⇒ String

Output only. The geographic location where the model resides. This value is inherited from the dataset. Corresponds to the JSON property location

Returns:

  • (String) 


5392
5393
5394
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5392

def location
  @location
end

#model_reference ⇒ Google::Apis::BigqueryV2::ModelReference

Required. Unique identifier for this model. Corresponds to the JSON property modelReference

Returns:



5397
5398
5399
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5397

def model_reference
  @model_reference
end

#model_type ⇒ String

Output only. Type of the model resource. Corresponds to the JSON property modelType

Returns:

  • (String) 


5402
5403
5404
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5402

def model_type
  @model_type
end

#optimal_trial_ids ⇒ Array<Fixnum>

Output only. For single-objective hyperparameter tuning models, it only contains the best trial. For multi-objective hyperparameter tuning models, it contains all Pareto optimal trials sorted by trial_id. Corresponds to the JSON property optimalTrialIds

Returns:

  • (Array<Fixnum>) 


5411
5412
5413
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5411

def optimal_trial_ids
  @optimal_trial_ids
end

#training_runs ⇒ Array<Google::Apis::BigqueryV2::TrainingRun>

Information for all training runs in increasing order of start_time. Corresponds to the JSON property trainingRuns

Returns:



5416
5417
5418
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5416

def training_runs
  @training_runs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5423

def update!(**args)
  @best_trial_id = args[:best_trial_id] if args.key?(:best_trial_id)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @default_trial_id = args[:default_trial_id] if args.key?(:default_trial_id)
  @description = args[:description] if args.key?(:description)
  @encryption_configuration = args[:encryption_configuration] if args.key?(:encryption_configuration)
  @etag = args[:etag] if args.key?(:etag)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @feature_columns = args[:feature_columns] if args.key?(:feature_columns)
  @friendly_name = args[:friendly_name] if args.key?(:friendly_name)
  @hparam_search_spaces = args[:hparam_search_spaces] if args.key?(:hparam_search_spaces)
  @hparam_trials = args[:hparam_trials] if args.key?(:hparam_trials)
  @label_columns = args[:label_columns] if args.key?(:label_columns)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @location = args[:location] if args.key?(:location)
  @model_reference = args[:model_reference] if args.key?(:model_reference)
  @model_type = args[:model_type] if args.key?(:model_type)
  @optimal_trial_ids = args[:optimal_trial_ids] if args.key?(:optimal_trial_ids)
  @training_runs = args[:training_runs] if args.key?(:training_runs)
end