com.google.api.services.bigquery.model

Class TrainingRun

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.TrainingRun

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TrainingRun
extends GenericJson

Information about a single training query run for the model.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TrainingRun()

Method Summary

Modifier and Type	Method and Description
TrainingRun	clone()
List<GlobalExplanation>	getClassLevelGlobalExplanations() Global explanation contains the explanation of top features on the class level.
DataSplitResult	getDataSplitResult() Data split result of the training run.
EvaluationMetrics	getEvaluationMetrics() The evaluation metrics over training/eval data that were computed at the end of training.
GlobalExplanation	getModelLevelGlobalExplanation() Global explanation contains the explanation of top features on the model level.
List<IterationResult>	getResults() Output of each iteration run, results.size() <= max_iterations.
String	getStartTime() The start time of this training run.
TrainingOptions	getTrainingOptions() Options that were used for this training run, includes user specified and default options that were used.
TrainingRun	set(String fieldName, Object value)
TrainingRun	setClassLevelGlobalExplanations(List<GlobalExplanation> classLevelGlobalExplanations) Global explanation contains the explanation of top features on the class level.
TrainingRun	setDataSplitResult(DataSplitResult dataSplitResult) Data split result of the training run.
TrainingRun	setEvaluationMetrics(EvaluationMetrics evaluationMetrics) The evaluation metrics over training/eval data that were computed at the end of training.
TrainingRun	setModelLevelGlobalExplanation(GlobalExplanation modelLevelGlobalExplanation) Global explanation contains the explanation of top features on the model level.
TrainingRun	setResults(List<IterationResult> results) Output of each iteration run, results.size() <= max_iterations.
TrainingRun	setStartTime(String startTime) The start time of this training run.
TrainingRun	setTrainingOptions(TrainingOptions trainingOptions) Options that were used for this training run, includes user specified and default options that were used.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

TrainingRun

public TrainingRun()

Method Detail

getClassLevelGlobalExplanations

public List<GlobalExplanation> getClassLevelGlobalExplanations()

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

Returns:

value or null for none

setClassLevelGlobalExplanations

public TrainingRun setClassLevelGlobalExplanations(List<GlobalExplanation> classLevelGlobalExplanations)

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

Parameters:

classLevelGlobalExplanations - classLevelGlobalExplanations or null for none

getDataSplitResult

public DataSplitResult getDataSplitResult()

Data split result of the training run. Only set when the input data is actually split.

Returns:

value or null for none

setDataSplitResult

public TrainingRun setDataSplitResult(DataSplitResult dataSplitResult)

Data split result of the training run. Only set when the input data is actually split.

Parameters:

dataSplitResult - dataSplitResult or null for none

getEvaluationMetrics

public EvaluationMetrics getEvaluationMetrics()

The evaluation metrics over training/eval data that were computed at the end of training.

Returns:

value or null for none

setEvaluationMetrics

public TrainingRun setEvaluationMetrics(EvaluationMetrics evaluationMetrics)

The evaluation metrics over training/eval data that were computed at the end of training.

Parameters:

evaluationMetrics - evaluationMetrics or null for none

getModelLevelGlobalExplanation

public GlobalExplanation getModelLevelGlobalExplanation()

Global explanation contains the explanation of top features on the model level. Applies to both regression and classification models.

Returns:

value or null for none

setModelLevelGlobalExplanation

public TrainingRun setModelLevelGlobalExplanation(GlobalExplanation modelLevelGlobalExplanation)

Global explanation contains the explanation of top features on the model level. Applies to both regression and classification models.

Parameters:

modelLevelGlobalExplanation - modelLevelGlobalExplanation or null for none

getResults

public List<IterationResult> getResults()

Output of each iteration run, results.size() <= max_iterations.

Returns:

value or null for none

setResults

public TrainingRun setResults(List<IterationResult> results)

Output of each iteration run, results.size() <= max_iterations.

Parameters:

results - results or null for none

getStartTime

public String getStartTime()

The start time of this training run.

Returns:

value or null for none

setStartTime

public TrainingRun setStartTime(String startTime)

The start time of this training run.

Parameters:

startTime - startTime or null for none

getTrainingOptions

public TrainingOptions getTrainingOptions()

Options that were used for this training run, includes user specified and default options that were used.

Returns:

value or null for none

setTrainingOptions

public TrainingRun setTrainingOptions(TrainingOptions trainingOptions)

Options that were used for this training run, includes user specified and default options that were used.

Parameters:

trainingOptions - trainingOptions or null for none

set

public TrainingRun set(String fieldName,
                       Object value)

Overrides:

set in class GenericJson

clone

public TrainingRun clone()

Overrides:

clone in class GenericJson