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

Class GoogleCloudMlV1ParameterSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudMlV1ParameterSpec
extends GenericJson

Represents a single hyperparameter to optimize.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudMlV1ParameterSpec	clone()
List<String>	getCategoricalValues() Required if type is `CATEGORICAL`.
List<Double>	getDiscreteValues() Required if type is `DISCRETE`.
Double	getMaxValue() Required if type is `DOUBLE` or `INTEGER`.
Double	getMinValue() Required if type is `DOUBLE` or `INTEGER`.
String	getParameterName() Required.
String	getScaleType() Optional.
String	getType() Required.
GoogleCloudMlV1ParameterSpec	set(String fieldName, Object value)
GoogleCloudMlV1ParameterSpec	setCategoricalValues(List<String> categoricalValues) Required if type is `CATEGORICAL`.
GoogleCloudMlV1ParameterSpec	setDiscreteValues(List<Double> discreteValues) Required if type is `DISCRETE`.
GoogleCloudMlV1ParameterSpec	setMaxValue(Double maxValue) Required if type is `DOUBLE` or `INTEGER`.
GoogleCloudMlV1ParameterSpec	setMinValue(Double minValue) Required if type is `DOUBLE` or `INTEGER`.
GoogleCloudMlV1ParameterSpec	setParameterName(String parameterName) Required.
GoogleCloudMlV1ParameterSpec	setScaleType(String scaleType) Optional.
GoogleCloudMlV1ParameterSpec	setType(String type) Required.

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

GoogleCloudMlV1ParameterSpec

public GoogleCloudMlV1ParameterSpec()

Method Detail

getCategoricalValues

public List<String> getCategoricalValues()

Required if type is `CATEGORICAL`. The list of possible categories.

Returns:

value or null for none

setCategoricalValues

public GoogleCloudMlV1ParameterSpec setCategoricalValues(List<String> categoricalValues)

Required if type is `CATEGORICAL`. The list of possible categories.

Parameters:

categoricalValues - categoricalValues or null for none

getDiscreteValues

public List<Double> getDiscreteValues()

Required if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

Returns:

value or null for none

setDiscreteValues

public GoogleCloudMlV1ParameterSpec setDiscreteValues(List<Double> discreteValues)

Required if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

Parameters:

discreteValues - discreteValues or null for none

getMaxValue

public Double getMaxValue()

Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`.

Returns:

value or null for none

setMaxValue

public GoogleCloudMlV1ParameterSpec setMaxValue(Double maxValue)

Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`.

Parameters:

maxValue - maxValue or null for none

getMinValue

public Double getMinValue()

Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER.

Returns:

value or null for none

setMinValue

public GoogleCloudMlV1ParameterSpec setMinValue(Double minValue)

Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER.

Parameters:

minValue - minValue or null for none

getParameterName

public String getParameterName()

Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate".

Returns:

value or null for none

setParameterName

public GoogleCloudMlV1ParameterSpec setParameterName(String parameterName)

Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate".

Parameters:

parameterName - parameterName or null for none

getScaleType

public String getScaleType()

Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`).

Returns:

value or null for none

setScaleType

public GoogleCloudMlV1ParameterSpec setScaleType(String scaleType)

Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`).

Parameters:

scaleType - scaleType or null for none

getType

public String getType()

Required. The type of the parameter.

Returns:

value or null for none

setType

public GoogleCloudMlV1ParameterSpec setType(String type)

Required. The type of the parameter.

Parameters:

type - type or null for none

set

public GoogleCloudMlV1ParameterSpec set(String fieldName,
                                        Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudMlV1ParameterSpec clone()

Overrides:

clone in class GenericJson