target.apidocs.com.google.api.services.bigquery.model.TrainingRun.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation

There is a newer version: v2-rev20241027-2.0.0

Show newest version







TrainingRun (BigQuery API v2-rev20240727-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 com.google.api.client.json.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
com.google.api.client.util.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

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TrainingRun
clone() 


List<GlobalExplanation>
getClassLevelGlobalExplanations()
Output only.



DataSplitResult
getDataSplitResult()
Output only.



EvaluationMetrics
getEvaluationMetrics()
Output only.



GlobalExplanation
getModelLevelGlobalExplanation()
Output only.



List<IterationResult>
getResults()
Output only.



String
getStartTime()
Output only.



TrainingOptions
getTrainingOptions()
Output only.



Long
getTrainingStartTime()
Output only.



String
getVertexAiModelId()
The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-
 registry/introduction) for this training run.



String
getVertexAiModelVersion()
Output only.



TrainingRun
set(String fieldName,
   Object value) 


TrainingRun
setClassLevelGlobalExplanations(List<GlobalExplanation> classLevelGlobalExplanations)
Output only.



TrainingRun
setDataSplitResult(DataSplitResult dataSplitResult)
Output only.



TrainingRun
setEvaluationMetrics(EvaluationMetrics evaluationMetrics)
Output only.



TrainingRun
setModelLevelGlobalExplanation(GlobalExplanation modelLevelGlobalExplanation)
Output only.



TrainingRun
setResults(List<IterationResult> results)
Output only.



TrainingRun
setStartTime(String startTime)
Output only.



TrainingRun
setTrainingOptions(TrainingOptions trainingOptions)
Output only.



TrainingRun
setTrainingStartTime(Long trainingStartTime)
Output only.



TrainingRun
setVertexAiModelId(String vertexAiModelId)
The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-
 registry/introduction) for this training run.



TrainingRun
setVertexAiModelVersion(String vertexAiModelVersion)
Output only.







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()
Output only. 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)
Output only. 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()
Output only. 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)
Output only. 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()
Output only. 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)
Output only. 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()
Output only. 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)
Output only. 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 only. Output of each iteration run, results.size() <= max_iterations.

Returns:
value or null for none








setResults
public TrainingRun setResults(List<IterationResult> results)
Output only. Output of each iteration run, results.size() <= max_iterations.

Parameters:
results - results or null for none








getStartTime
public String getStartTime()
Output only. The start time of this training run.

Returns:
value or null for none








setStartTime
public TrainingRun setStartTime(String startTime)
Output only. The start time of this training run.

Parameters:
startTime - startTime or null for none








getTrainingOptions
public TrainingOptions getTrainingOptions()
Output only. 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)
Output only. Options that were used for this training run, includes user specified and default
 options that were used.

Parameters:
trainingOptions - trainingOptions or null for none








getTrainingStartTime
public Long getTrainingStartTime()
Output only. The start time of this training run, in milliseconds since epoch.

Returns:
value or null for none








setTrainingStartTime
public TrainingRun setTrainingStartTime(Long trainingStartTime)
Output only. The start time of this training run, in milliseconds since epoch.

Parameters:
trainingStartTime - trainingStartTime or null for none








getVertexAiModelId
public String getVertexAiModelId()
The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-
 registry/introduction) for this training run.

Returns:
value or null for none








setVertexAiModelId
public TrainingRun setVertexAiModelId(String vertexAiModelId)
The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-
 registry/introduction) for this training run.

Parameters:
vertexAiModelId - vertexAiModelId or null for none








getVertexAiModelVersion
public String getVertexAiModelVersion()
Output only. The model version in the [Vertex AI Model
 Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this
 training run.

Returns:
value or null for none








setVertexAiModelVersion
public TrainingRun setVertexAiModelVersion(String vertexAiModelVersion)
Output only. The model version in the [Vertex AI Model
 Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this
 training run.

Parameters:
vertexAiModelVersion - vertexAiModelVersion or null for none








set
public TrainingRun set(String fieldName,
                       Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public TrainingRun clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`TrainingRun`	`clone()`
`List<GlobalExplanation>`	`getClassLevelGlobalExplanations()` Output only.
`DataSplitResult`	`getDataSplitResult()` Output only.
`EvaluationMetrics`	`getEvaluationMetrics()` Output only.
`GlobalExplanation`	`getModelLevelGlobalExplanation()` Output only.
`List<IterationResult>`	`getResults()` Output only.
`String`	`getStartTime()` Output only.
`TrainingOptions`	`getTrainingOptions()` Output only.
`Long`	`getTrainingStartTime()` Output only.
`String`	`getVertexAiModelId()` The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model- registry/introduction) for this training run.
`String`	`getVertexAiModelVersion()` Output only.
`TrainingRun`	`set(String fieldName, Object value)`
`TrainingRun`	`setClassLevelGlobalExplanations(List<GlobalExplanation> classLevelGlobalExplanations)` Output only.
`TrainingRun`	`setDataSplitResult(DataSplitResult dataSplitResult)` Output only.
`TrainingRun`	`setEvaluationMetrics(EvaluationMetrics evaluationMetrics)` Output only.
`TrainingRun`	`setModelLevelGlobalExplanation(GlobalExplanation modelLevelGlobalExplanation)` Output only.
`TrainingRun`	`setResults(List<IterationResult> results)` Output only.
`TrainingRun`	`setStartTime(String startTime)` Output only.
`TrainingRun`	`setTrainingOptions(TrainingOptions trainingOptions)` Output only.
`TrainingRun`	`setTrainingStartTime(Long trainingStartTime)` Output only.
`TrainingRun`	`setVertexAiModelId(String vertexAiModelId)` The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model- registry/introduction) for this training run.
`TrainingRun`	`setVertexAiModelVersion(String vertexAiModelVersion)` Output only.