target.apidocs.com.google.api.services.bigquery.model.HparamTuningTrial.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







HparamTuningTrial (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 HparamTuningTrial



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.HparamTuningTrial













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class HparamTuningTrial
extends com.google.api.client.json.GenericJson
Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-
 sql/bigqueryml-syntax-hp-tuning-overview) models.

  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


HparamTuningTrial() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HparamTuningTrial
clone() 


Long
getEndTimeMs()
Ending time of the trial.



String
getErrorMessage()
Error message for FAILED and INFEASIBLE trial.



Double
getEvalLoss()
Loss computed on the eval data at the end of trial.



EvaluationMetrics
getEvaluationMetrics()
Evaluation metrics of this trial calculated on the test data.



TrainingOptions
getHparams()
The hyperprameters selected for this trial.



EvaluationMetrics
getHparamTuningEvaluationMetrics()
Hyperparameter tuning evaluation metrics of this trial calculated on the eval data.



Long
getStartTimeMs()
Starting time of the trial.



String
getStatus()
The status of the trial.



Double
getTrainingLoss()
Loss computed on the training data at the end of trial.



Long
getTrialId()
1-based index of the trial.



HparamTuningTrial
set(String fieldName,
   Object value) 


HparamTuningTrial
setEndTimeMs(Long endTimeMs)
Ending time of the trial.



HparamTuningTrial
setErrorMessage(String errorMessage)
Error message for FAILED and INFEASIBLE trial.



HparamTuningTrial
setEvalLoss(Double evalLoss)
Loss computed on the eval data at the end of trial.



HparamTuningTrial
setEvaluationMetrics(EvaluationMetrics evaluationMetrics)
Evaluation metrics of this trial calculated on the test data.



HparamTuningTrial
setHparams(TrainingOptions hparams)
The hyperprameters selected for this trial.



HparamTuningTrial
setHparamTuningEvaluationMetrics(EvaluationMetrics hparamTuningEvaluationMetrics)
Hyperparameter tuning evaluation metrics of this trial calculated on the eval data.



HparamTuningTrial
setStartTimeMs(Long startTimeMs)
Starting time of the trial.



HparamTuningTrial
setStatus(String status)
The status of the trial.



HparamTuningTrial
setTrainingLoss(Double trainingLoss)
Loss computed on the training data at the end of trial.



HparamTuningTrial
setTrialId(Long trialId)
1-based index of the trial.







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





HparamTuningTrial
public HparamTuningTrial()









Method Detail





getEndTimeMs
public Long getEndTimeMs()
Ending time of the trial.

Returns:
value or null for none








setEndTimeMs
public HparamTuningTrial setEndTimeMs(Long endTimeMs)
Ending time of the trial.

Parameters:
endTimeMs - endTimeMs or null for none








getErrorMessage
public String getErrorMessage()
Error message for FAILED and INFEASIBLE trial.

Returns:
value or null for none








setErrorMessage
public HparamTuningTrial setErrorMessage(String errorMessage)
Error message for FAILED and INFEASIBLE trial.

Parameters:
errorMessage - errorMessage or null for none








getEvalLoss
public Double getEvalLoss()
Loss computed on the eval data at the end of trial.

Returns:
value or null for none








setEvalLoss
public HparamTuningTrial setEvalLoss(Double evalLoss)
Loss computed on the eval data at the end of trial.

Parameters:
evalLoss - evalLoss or null for none








getEvaluationMetrics
public EvaluationMetrics getEvaluationMetrics()
Evaluation metrics of this trial calculated on the test data. Empty in Job API.

Returns:
value or null for none








setEvaluationMetrics
public HparamTuningTrial setEvaluationMetrics(EvaluationMetrics evaluationMetrics)
Evaluation metrics of this trial calculated on the test data. Empty in Job API.

Parameters:
evaluationMetrics - evaluationMetrics or null for none








getHparamTuningEvaluationMetrics
public EvaluationMetrics getHparamTuningEvaluationMetrics()
Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike
 evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.

Returns:
value or null for none








setHparamTuningEvaluationMetrics
public HparamTuningTrial setHparamTuningEvaluationMetrics(EvaluationMetrics hparamTuningEvaluationMetrics)
Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike
 evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.

Parameters:
hparamTuningEvaluationMetrics - hparamTuningEvaluationMetrics or null for none








getHparams
public TrainingOptions getHparams()
The hyperprameters selected for this trial.

Returns:
value or null for none








setHparams
public HparamTuningTrial setHparams(TrainingOptions hparams)
The hyperprameters selected for this trial.

Parameters:
hparams - hparams or null for none








getStartTimeMs
public Long getStartTimeMs()
Starting time of the trial.

Returns:
value or null for none








setStartTimeMs
public HparamTuningTrial setStartTimeMs(Long startTimeMs)
Starting time of the trial.

Parameters:
startTimeMs - startTimeMs or null for none








getStatus
public String getStatus()
The status of the trial.

Returns:
value or null for none








setStatus
public HparamTuningTrial setStatus(String status)
The status of the trial.

Parameters:
status - status or null for none








getTrainingLoss
public Double getTrainingLoss()
Loss computed on the training data at the end of trial.

Returns:
value or null for none








setTrainingLoss
public HparamTuningTrial setTrainingLoss(Double trainingLoss)
Loss computed on the training data at the end of trial.

Parameters:
trainingLoss - trainingLoss or null for none








getTrialId
public Long getTrialId()
1-based index of the trial.

Returns:
value or null for none








setTrialId
public HparamTuningTrial setTrialId(Long trialId)
1-based index of the trial.

Parameters:
trialId - trialId or null for none








set
public HparamTuningTrial set(String fieldName,
                             Object value)

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








clone
public HparamTuningTrial 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
`HparamTuningTrial`	`clone()`
`Long`	`getEndTimeMs()` Ending time of the trial.
`String`	`getErrorMessage()` Error message for FAILED and INFEASIBLE trial.
`Double`	`getEvalLoss()` Loss computed on the eval data at the end of trial.
`EvaluationMetrics`	`getEvaluationMetrics()` Evaluation metrics of this trial calculated on the test data.
`TrainingOptions`	`getHparams()` The hyperprameters selected for this trial.
`EvaluationMetrics`	`getHparamTuningEvaluationMetrics()` Hyperparameter tuning evaluation metrics of this trial calculated on the eval data.
`Long`	`getStartTimeMs()` Starting time of the trial.
`String`	`getStatus()` The status of the trial.
`Double`	`getTrainingLoss()` Loss computed on the training data at the end of trial.
`Long`	`getTrialId()` 1-based index of the trial.
`HparamTuningTrial`	`set(String fieldName, Object value)`
`HparamTuningTrial`	`setEndTimeMs(Long endTimeMs)` Ending time of the trial.
`HparamTuningTrial`	`setErrorMessage(String errorMessage)` Error message for FAILED and INFEASIBLE trial.
`HparamTuningTrial`	`setEvalLoss(Double evalLoss)` Loss computed on the eval data at the end of trial.
`HparamTuningTrial`	`setEvaluationMetrics(EvaluationMetrics evaluationMetrics)` Evaluation metrics of this trial calculated on the test data.
`HparamTuningTrial`	`setHparams(TrainingOptions hparams)` The hyperprameters selected for this trial.
`HparamTuningTrial`	`setHparamTuningEvaluationMetrics(EvaluationMetrics hparamTuningEvaluationMetrics)` Hyperparameter tuning evaluation metrics of this trial calculated on the eval data.
`HparamTuningTrial`	`setStartTimeMs(Long startTimeMs)` Starting time of the trial.
`HparamTuningTrial`	`setStatus(String status)` The status of the trial.
`HparamTuningTrial`	`setTrainingLoss(Double trainingLoss)` Loss computed on the training data at the end of trial.
`HparamTuningTrial`	`setTrialId(Long trialId)` 1-based index of the trial.