com.amazonaws.services.sagemaker.model

Class ParameterRanges

java.lang.Object

com.amazonaws.services.sagemaker.model.ParameterRanges

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParameterRanges
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterRanges()

Method Summary

Modifier and Type	Method and Description
ParameterRanges	clone()
boolean	equals(Object obj)
List<CategoricalParameterRange>	getCategoricalParameterRanges() The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
List<ContinuousParameterRange>	getContinuousParameterRanges() The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
List<IntegerParameterRange>	getIntegerParameterRanges() The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCategoricalParameterRanges(Collection<CategoricalParameterRange> categoricalParameterRanges) The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
void	setContinuousParameterRanges(Collection<ContinuousParameterRange> continuousParameterRanges) The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
void	setIntegerParameterRanges(Collection<IntegerParameterRange> integerParameterRanges) The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
String	toString() Returns a string representation of this object.
ParameterRanges	withCategoricalParameterRanges(CategoricalParameterRange... categoricalParameterRanges) The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
ParameterRanges	withCategoricalParameterRanges(Collection<CategoricalParameterRange> categoricalParameterRanges) The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
ParameterRanges	withContinuousParameterRanges(Collection<ContinuousParameterRange> continuousParameterRanges) The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
ParameterRanges	withContinuousParameterRanges(ContinuousParameterRange... continuousParameterRanges) The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
ParameterRanges	withIntegerParameterRanges(Collection<IntegerParameterRange> integerParameterRanges) The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
ParameterRanges	withIntegerParameterRanges(IntegerParameterRange... integerParameterRanges) The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterRanges

public ParameterRanges()

Method Detail

getIntegerParameterRanges

public List<IntegerParameterRange> getIntegerParameterRanges()

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Returns:

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

setIntegerParameterRanges

public void setIntegerParameterRanges(Collection<IntegerParameterRange> integerParameterRanges)

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Parameters:

integerParameterRanges - The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

withIntegerParameterRanges

public ParameterRanges withIntegerParameterRanges(IntegerParameterRange... integerParameterRanges)

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

NOTE: This method appends the values to the existing list (if any). Use setIntegerParameterRanges(java.util.Collection) or withIntegerParameterRanges(java.util.Collection) if you want to override the existing values.

Parameters:

integerParameterRanges - The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

withIntegerParameterRanges

public ParameterRanges withIntegerParameterRanges(Collection<IntegerParameterRange> integerParameterRanges)

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Parameters:

integerParameterRanges - The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

getContinuousParameterRanges

public List<ContinuousParameterRange> getContinuousParameterRanges()

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Returns:

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

setContinuousParameterRanges

public void setContinuousParameterRanges(Collection<ContinuousParameterRange> continuousParameterRanges)

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Parameters:

continuousParameterRanges - The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

withContinuousParameterRanges

public ParameterRanges withContinuousParameterRanges(ContinuousParameterRange... continuousParameterRanges)

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

NOTE: This method appends the values to the existing list (if any). Use setContinuousParameterRanges(java.util.Collection) or withContinuousParameterRanges(java.util.Collection) if you want to override the existing values.

Parameters:

continuousParameterRanges - The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

withContinuousParameterRanges

public ParameterRanges withContinuousParameterRanges(Collection<ContinuousParameterRange> continuousParameterRanges)

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Parameters:

continuousParameterRanges - The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCategoricalParameterRanges

public List<CategoricalParameterRange> getCategoricalParameterRanges()

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Returns:

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

setCategoricalParameterRanges

public void setCategoricalParameterRanges(Collection<CategoricalParameterRange> categoricalParameterRanges)

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Parameters:

categoricalParameterRanges - The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

withCategoricalParameterRanges

public ParameterRanges withCategoricalParameterRanges(CategoricalParameterRange... categoricalParameterRanges)

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

NOTE: This method appends the values to the existing list (if any). Use setCategoricalParameterRanges(java.util.Collection) or withCategoricalParameterRanges(java.util.Collection) if you want to override the existing values.

Parameters:

categoricalParameterRanges - The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCategoricalParameterRanges

public ParameterRanges withCategoricalParameterRanges(Collection<CategoricalParameterRange> categoricalParameterRanges)

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Parameters:

categoricalParameterRanges - The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ParameterRanges clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.