Class: Google::Apis::BigqueryV2::TrainingRun

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

Overview

Information about a single training query run for the model.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TrainingRun

Returns a new instance of TrainingRun.



8354
8355
8356
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8354

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

Instance Attribute Details

#class_level_global_explanations ⇒ Array<Google::Apis::BigqueryV2::GlobalExplanation>

Global explanation contains the explanation of top features on the class level. Applies to classification models only. Corresponds to the JSON property classLevelGlobalExplanations

Returns:



8309
8310
8311
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8309

def class_level_global_explanations
  @class_level_global_explanations
end

#data_split_result ⇒ Google::Apis::BigqueryV2::DataSplitResult

Data split result. This contains references to the training and evaluation data tables that were used to train the model. Corresponds to the JSON property dataSplitResult

Returns:



8315
8316
8317
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8315

def data_split_result
  @data_split_result
end

#evaluation_metrics ⇒ Google::Apis::BigqueryV2::EvaluationMetrics

Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. Corresponds to the JSON property evaluationMetrics

Returns:



8322
8323
8324
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8322

def evaluation_metrics
  @evaluation_metrics
end

#model_level_global_explanation ⇒ Google::Apis::BigqueryV2::GlobalExplanation

Global explanations containing the top most important features after training. Corresponds to the JSON property modelLevelGlobalExplanation

Returns:



8327
8328
8329
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8327

def model_level_global_explanation
  @model_level_global_explanation
end

#results ⇒ Array<Google::Apis::BigqueryV2::IterationResult>

Output of each iteration run, results.size() <= max_iterations. Corresponds to the JSON property results

Returns:



8332
8333
8334
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8332

def results
  @results
end

#start_time ⇒ String

The start time of this training run. Corresponds to the JSON property startTime

Returns:

  • (String) 


8337
8338
8339
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8337

def start_time
  @start_time
end

#training_options ⇒ Google::Apis::BigqueryV2::TrainingOptions

Options used in model training. Corresponds to the JSON property trainingOptions

Returns:



8342
8343
8344
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8342

def training_options
  @training_options
end

#vertex_ai_model_id ⇒ String

The model id in Vertex AI Model Registry for this training run Corresponds to the JSON property vertexAiModelId

Returns:

  • (String) 


8347
8348
8349
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8347

def vertex_ai_model_id
  @vertex_ai_model_id
end

#vertex_ai_model_version ⇒ String

The model version in Vertex AI Model Registry for this training run Corresponds to the JSON property vertexAiModelVersion

Returns:

  • (String) 


8352
8353
8354
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8352

def vertex_ai_model_version
  @vertex_ai_model_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8359

def update!(**args)
  @class_level_global_explanations = args[:class_level_global_explanations] if args.key?(:class_level_global_explanations)
  @data_split_result = args[:data_split_result] if args.key?(:data_split_result)
  @evaluation_metrics = args[:evaluation_metrics] if args.key?(:evaluation_metrics)
  @model_level_global_explanation = args[:model_level_global_explanation] if args.key?(:model_level_global_explanation)
  @results = args[:results] if args.key?(:results)
  @start_time = args[:start_time] if args.key?(:start_time)
  @training_options = args[:training_options] if args.key?(:training_options)
  @vertex_ai_model_id = args[:vertex_ai_model_id] if args.key?(:vertex_ai_model_id)
  @vertex_ai_model_version = args[:vertex_ai_model_version] if args.key?(:vertex_ai_model_version)
end