com.google.api.services.ml.v1.model

Class GoogleCloudMlV1HyperparameterOutput

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.ml.v1.model.GoogleCloudMlV1HyperparameterOutput

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudMlV1HyperparameterOutput
extends GenericJson

Represents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial.

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 AI Platform Training & Prediction 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
GoogleCloudMlV1HyperparameterOutput()

Method Summary

Modifier and Type	Method and Description
GoogleCloudMlV1HyperparameterOutput	clone()
List<GoogleCloudMlV1HyperparameterOutputHyperparameterMetric>	getAllMetrics() All recorded object metrics for this trial.
GoogleCloudMlV1BuiltInAlgorithmOutput	getBuiltInAlgorithmOutput() Details related to built-in algorithms jobs.
String	getEndTime() Output only.
GoogleCloudMlV1HyperparameterOutputHyperparameterMetric	getFinalMetric() The final objective metric seen for this trial.
Map<String,String>	getHyperparameters() The hyperparameters given to this trial.
Boolean	getIsTrialStoppedEarly() True if the trial is stopped early.
String	getStartTime() Output only.
String	getState() Output only.
String	getTrialId() The trial id for these results.
GoogleCloudMlV1HyperparameterOutput	set(String fieldName, Object value)
GoogleCloudMlV1HyperparameterOutput	setAllMetrics(List<GoogleCloudMlV1HyperparameterOutputHyperparameterMetric> allMetrics) All recorded object metrics for this trial.
GoogleCloudMlV1HyperparameterOutput	setBuiltInAlgorithmOutput(GoogleCloudMlV1BuiltInAlgorithmOutput builtInAlgorithmOutput) Details related to built-in algorithms jobs.
GoogleCloudMlV1HyperparameterOutput	setEndTime(String endTime) Output only.
GoogleCloudMlV1HyperparameterOutput	setFinalMetric(GoogleCloudMlV1HyperparameterOutputHyperparameterMetric finalMetric) The final objective metric seen for this trial.
GoogleCloudMlV1HyperparameterOutput	setHyperparameters(Map<String,String> hyperparameters) The hyperparameters given to this trial.
GoogleCloudMlV1HyperparameterOutput	setIsTrialStoppedEarly(Boolean isTrialStoppedEarly) True if the trial is stopped early.
GoogleCloudMlV1HyperparameterOutput	setStartTime(String startTime) Output only.
GoogleCloudMlV1HyperparameterOutput	setState(String state) Output only.
GoogleCloudMlV1HyperparameterOutput	setTrialId(String trialId) The trial id for these results.

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

GoogleCloudMlV1HyperparameterOutput

public GoogleCloudMlV1HyperparameterOutput()

Method Detail

getAllMetrics

public List<GoogleCloudMlV1HyperparameterOutputHyperparameterMetric> getAllMetrics()

All recorded object metrics for this trial. This field is not currently populated.

Returns:

value or null for none

setAllMetrics

public GoogleCloudMlV1HyperparameterOutput setAllMetrics(List<GoogleCloudMlV1HyperparameterOutputHyperparameterMetric> allMetrics)

All recorded object metrics for this trial. This field is not currently populated.

Parameters:

allMetrics - allMetrics or null for none

getBuiltInAlgorithmOutput

public GoogleCloudMlV1BuiltInAlgorithmOutput getBuiltInAlgorithmOutput()

Details related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded.

Returns:

value or null for none

setBuiltInAlgorithmOutput

public GoogleCloudMlV1HyperparameterOutput setBuiltInAlgorithmOutput(GoogleCloudMlV1BuiltInAlgorithmOutput builtInAlgorithmOutput)

Details related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded.

Parameters:

builtInAlgorithmOutput - builtInAlgorithmOutput or null for none

getEndTime

public String getEndTime()

Output only. End time for the trial.

Returns:

value or null for none

setEndTime

public GoogleCloudMlV1HyperparameterOutput setEndTime(String endTime)

Output only. End time for the trial.

Parameters:

endTime - endTime or null for none

getFinalMetric

public GoogleCloudMlV1HyperparameterOutputHyperparameterMetric getFinalMetric()

The final objective metric seen for this trial.

Returns:

value or null for none

setFinalMetric

public GoogleCloudMlV1HyperparameterOutput setFinalMetric(GoogleCloudMlV1HyperparameterOutputHyperparameterMetric finalMetric)

The final objective metric seen for this trial.

Parameters:

finalMetric - finalMetric or null for none

getHyperparameters

public Map<String,String> getHyperparameters()

The hyperparameters given to this trial.

Returns:

value or null for none

setHyperparameters

public GoogleCloudMlV1HyperparameterOutput setHyperparameters(Map<String,String> hyperparameters)

The hyperparameters given to this trial.

Parameters:

hyperparameters - hyperparameters or null for none

getIsTrialStoppedEarly

public Boolean getIsTrialStoppedEarly()

True if the trial is stopped early.

Returns:

value or null for none

setIsTrialStoppedEarly

public GoogleCloudMlV1HyperparameterOutput setIsTrialStoppedEarly(Boolean isTrialStoppedEarly)

True if the trial is stopped early.

Parameters:

isTrialStoppedEarly - isTrialStoppedEarly or null for none

getStartTime

public String getStartTime()

Output only. Start time for the trial.

Returns:

value or null for none

setStartTime

public GoogleCloudMlV1HyperparameterOutput setStartTime(String startTime)

Output only. Start time for the trial.

Parameters:

startTime - startTime or null for none

getState

public String getState()

Output only. The detailed state of the trial.

Returns:

value or null for none

setState

public GoogleCloudMlV1HyperparameterOutput setState(String state)

Output only. The detailed state of the trial.

Parameters:

state - state or null for none

getTrialId

public String getTrialId()

The trial id for these results.

Returns:

value or null for none

setTrialId

public GoogleCloudMlV1HyperparameterOutput setTrialId(String trialId)

The trial id for these results.

Parameters:

trialId - trialId or null for none

set

public GoogleCloudMlV1HyperparameterOutput set(String fieldName,
                                               Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudMlV1HyperparameterOutput clone()

Overrides:

clone in class GenericJson