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.



6725
6726
6727
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6725

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) 


6598
6599
6600
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6598

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) 


6604
6605
6606
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6604

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) 


6614
6615
6616
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6614

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) 


6619
6620
6621
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6619

def description
  @description
end

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

Configuration for Cloud KMS encryption settings. Corresponds to the JSON property encryptionConfiguration

Returns:



6624
6625
6626
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6624

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

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

Returns:

  • (String) 


6629
6630
6631
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6629

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) 


6638
6639
6640
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6638

def expiration_time
  @expiration_time
end

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

Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause. Corresponds to the JSON property featureColumns

Returns:



6644
6645
6646
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6644

def feature_columns
  @feature_columns
end

#friendly_name ⇒ String

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

Returns:

  • (String) 


6649
6650
6651
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6649

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:



6654
6655
6656
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6654

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:



6660
6661
6662
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6660

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:



6666
6667
6668
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6666

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>) 


6675
6676
6677
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6675

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) 


6681
6682
6683
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6681

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) 


6687
6688
6689
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6687

def location
  @location
end

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

Id path of a model. Corresponds to the JSON property modelReference

Returns:



6692
6693
6694
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6692

def model_reference
  @model_reference
end

#model_type ⇒ String

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

Returns:

  • (String) 


6697
6698
6699
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6697

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>) 


6706
6707
6708
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6706

def optimal_trial_ids
  @optimal_trial_ids
end

#remote_model_info ⇒ Google::Apis::BigqueryV2::RemoteModelInfo

Remote Model Info Corresponds to the JSON property remoteModelInfo

Returns:



6711
6712
6713
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6711

def remote_model_info
  @remote_model_info
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:



6716
6717
6718
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6716

def training_runs
  @training_runs
end

#transform_columns ⇒ Array<Google::Apis::BigqueryV2::TransformColumn>

Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model. Corresponds to the JSON property transformColumns

Returns:



6723
6724
6725
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6723

def transform_columns
  @transform_columns
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6730

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)
  @remote_model_info = args[:remote_model_info] if args.key?(:remote_model_info)
  @training_runs = args[:training_runs] if args.key?(:training_runs)
  @transform_columns = args[:transform_columns] if args.key?(:transform_columns)
end