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

Class GoogleCloudMlV1TrainingOutput

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudMlV1TrainingOutput
extends GenericJson

Represents results of a training job. Output only.

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
GoogleCloudMlV1TrainingOutput()

Method Summary

Modifier and Type	Method and Description
GoogleCloudMlV1TrainingOutput	clone()
GoogleCloudMlV1BuiltInAlgorithmOutput	getBuiltInAlgorithmOutput() Details related to built-in algorithms jobs.
Long	getCompletedTrialCount() The number of hyperparameter tuning trials that completed successfully.
Double	getConsumedMLUnits() The amount of ML units consumed by the job.
String	getHyperparameterMetricTag() The TensorFlow summary tag name used for optimizing hyperparameter tuning trials.
Boolean	getIsBuiltInAlgorithmJob() Whether this job is a built-in Algorithm job.
Boolean	getIsHyperparameterTuningJob() Whether this job is a hyperparameter tuning job.
List<GoogleCloudMlV1HyperparameterOutput>	getTrials() Results for individual Hyperparameter trials.
GoogleCloudMlV1TrainingOutput	set(String fieldName, Object value)
GoogleCloudMlV1TrainingOutput	setBuiltInAlgorithmOutput(GoogleCloudMlV1BuiltInAlgorithmOutput builtInAlgorithmOutput) Details related to built-in algorithms jobs.
GoogleCloudMlV1TrainingOutput	setCompletedTrialCount(Long completedTrialCount) The number of hyperparameter tuning trials that completed successfully.
GoogleCloudMlV1TrainingOutput	setConsumedMLUnits(Double consumedMLUnits) The amount of ML units consumed by the job.
GoogleCloudMlV1TrainingOutput	setHyperparameterMetricTag(String hyperparameterMetricTag) The TensorFlow summary tag name used for optimizing hyperparameter tuning trials.
GoogleCloudMlV1TrainingOutput	setIsBuiltInAlgorithmJob(Boolean isBuiltInAlgorithmJob) Whether this job is a built-in Algorithm job.
GoogleCloudMlV1TrainingOutput	setIsHyperparameterTuningJob(Boolean isHyperparameterTuningJob) Whether this job is a hyperparameter tuning job.
GoogleCloudMlV1TrainingOutput	setTrials(List<GoogleCloudMlV1HyperparameterOutput> trials) Results for individual Hyperparameter trials.

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

GoogleCloudMlV1TrainingOutput

public GoogleCloudMlV1TrainingOutput()

Method Detail

getBuiltInAlgorithmOutput

public GoogleCloudMlV1BuiltInAlgorithmOutput getBuiltInAlgorithmOutput()

Details related to built-in algorithms jobs. Only set for built-in algorithms jobs.

Returns:

value or null for none

setBuiltInAlgorithmOutput

public GoogleCloudMlV1TrainingOutput setBuiltInAlgorithmOutput(GoogleCloudMlV1BuiltInAlgorithmOutput builtInAlgorithmOutput)

Details related to built-in algorithms jobs. Only set for built-in algorithms jobs.

Parameters:

builtInAlgorithmOutput - builtInAlgorithmOutput or null for none

getCompletedTrialCount

public Long getCompletedTrialCount()

The number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs.

Returns:

value or null for none

setCompletedTrialCount

public GoogleCloudMlV1TrainingOutput setCompletedTrialCount(Long completedTrialCount)

The number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs.

Parameters:

completedTrialCount - completedTrialCount or null for none

getConsumedMLUnits

public Double getConsumedMLUnits()

The amount of ML units consumed by the job.

Returns:

value or null for none

setConsumedMLUnits

public GoogleCloudMlV1TrainingOutput setConsumedMLUnits(Double consumedMLUnits)

The amount of ML units consumed by the job.

Parameters:

consumedMLUnits - consumedMLUnits or null for none

getHyperparameterMetricTag

public String getHyperparameterMetricTag()

The TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`Hyperpa rameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs.

Returns:

value or null for none

setHyperparameterMetricTag

public GoogleCloudMlV1TrainingOutput setHyperparameterMetricTag(String hyperparameterMetricTag)

The TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`Hyperpa rameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs.

Parameters:

hyperparameterMetricTag - hyperparameterMetricTag or null for none

getIsBuiltInAlgorithmJob

public Boolean getIsBuiltInAlgorithmJob()

Whether this job is a built-in Algorithm job.

Returns:

value or null for none

setIsBuiltInAlgorithmJob

public GoogleCloudMlV1TrainingOutput setIsBuiltInAlgorithmJob(Boolean isBuiltInAlgorithmJob)

Whether this job is a built-in Algorithm job.

Parameters:

isBuiltInAlgorithmJob - isBuiltInAlgorithmJob or null for none

getIsHyperparameterTuningJob

public Boolean getIsHyperparameterTuningJob()

Whether this job is a hyperparameter tuning job.

Returns:

value or null for none

setIsHyperparameterTuningJob

public GoogleCloudMlV1TrainingOutput setIsHyperparameterTuningJob(Boolean isHyperparameterTuningJob)

Whether this job is a hyperparameter tuning job.

Parameters:

isHyperparameterTuningJob - isHyperparameterTuningJob or null for none

getTrials

public List<GoogleCloudMlV1HyperparameterOutput> getTrials()

Results for individual Hyperparameter trials. Only set for hyperparameter tuning jobs.

Returns:

value or null for none

setTrials

public GoogleCloudMlV1TrainingOutput setTrials(List<GoogleCloudMlV1HyperparameterOutput> trials)

Results for individual Hyperparameter trials. Only set for hyperparameter tuning jobs.

Parameters:

trials - trials or null for none

set

public GoogleCloudMlV1TrainingOutput set(String fieldName,
                                         Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudMlV1TrainingOutput clone()

Overrides:

clone in class GenericJson