/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* A list of continuous hyperparameters to tune. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ContinuousParameterRange implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the continuous hyperparameter to tune. *

*/ private String name; /** *

* The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. *

*/ private String minValue; /** *

* The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue * value and this value for tuning. *

*/ private String maxValue; /** *

* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a * hyperparameter scale, see Hyperparameter Scaling. One of the following values: *

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
*
*/ private String scalingType; /** *

* The name of the continuous hyperparameter to tune. *

* * @param name * The name of the continuous hyperparameter to tune. */ public void setName(String name) { this.name = name; } /** *

* The name of the continuous hyperparameter to tune. *

* * @return The name of the continuous hyperparameter to tune. */ public String getName() { return this.name; } /** *

* The name of the continuous hyperparameter to tune. *

* * @param name * The name of the continuous hyperparameter to tune. * @return Returns a reference to this object so that method calls can be chained together. */ public ContinuousParameterRange withName(String name) { setName(name); return this; } /** *

* The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. *

* * @param minValue * The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. */ public void setMinValue(String minValue) { this.minValue = minValue; } /** *

* The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. *

* * @return The minimum value for the hyperparameter. The tuning job uses floating-point values between this value * and MaxValuefor tuning. */ public String getMinValue() { return this.minValue; } /** *

* The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. *

* * @param minValue * The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and * MaxValuefor tuning. * @return Returns a reference to this object so that method calls can be chained together. */ public ContinuousParameterRange withMinValue(String minValue) { setMinValue(minValue); return this; } /** *

* The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue * value and this value for tuning. *

* * @param maxValue * The maximum value for the hyperparameter. The tuning job uses floating-point values between * MinValue value and this value for tuning. */ public void setMaxValue(String maxValue) { this.maxValue = maxValue; } /** *

* The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue * value and this value for tuning. *

* * @return The maximum value for the hyperparameter. The tuning job uses floating-point values between * MinValue value and this value for tuning. */ public String getMaxValue() { return this.maxValue; } /** *

* The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue * value and this value for tuning. *

* * @param maxValue * The maximum value for the hyperparameter. The tuning job uses floating-point values between * MinValue value and this value for tuning. * @return Returns a reference to this object so that method calls can be chained together. */ public ContinuousParameterRange withMaxValue(String maxValue) { setMaxValue(maxValue); return this; } /** *

* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a * hyperparameter scale, see Hyperparameter Scaling. One of the following values: *

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
*
* * @param scalingType * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about * choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic * scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
* @see HyperParameterScalingType */ public void setScalingType(String scalingType) { this.scalingType = scalingType; } /** *

* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a * hyperparameter scale, see Hyperparameter Scaling. One of the following values: *

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
*
* * @return The scale that hyperparameter tuning uses to search the hyperparameter range. For information about * choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic * scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
* @see HyperParameterScalingType */ public String getScalingType() { return this.scalingType; } /** *

* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a * hyperparameter scale, see Hyperparameter Scaling. One of the following values: *

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
*
* * @param scalingType * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about * choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic * scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
* @return Returns a reference to this object so that method calls can be chained together. * @see HyperParameterScalingType */ public ContinuousParameterRange withScalingType(String scalingType) { setScalingType(scalingType); return this; } /** *

* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a * hyperparameter scale, see Hyperparameter Scaling. One of the following values: *

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
*
* * @param scalingType * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about * choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

*
*
Auto
*
*

* SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. *

*
*
Linear
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. *

*
*
Logarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. *

*

* Logarithmic scaling works only for ranges that have only values greater than 0. *

*
*
ReverseLogarithmic
*
*

* Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic * scale. *

*

* Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. *

*
* @return Returns a reference to this object so that method calls can be chained together. * @see HyperParameterScalingType */ public ContinuousParameterRange withScalingType(HyperParameterScalingType scalingType) { this.scalingType = scalingType.toString(); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getMinValue() != null) sb.append("MinValue: ").append(getMinValue()).append(","); if (getMaxValue() != null) sb.append("MaxValue: ").append(getMaxValue()).append(","); if (getScalingType() != null) sb.append("ScalingType: ").append(getScalingType()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ContinuousParameterRange == false) return false; ContinuousParameterRange other = (ContinuousParameterRange) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getMinValue() == null ^ this.getMinValue() == null) return false; if (other.getMinValue() != null && other.getMinValue().equals(this.getMinValue()) == false) return false; if (other.getMaxValue() == null ^ this.getMaxValue() == null) return false; if (other.getMaxValue() != null && other.getMaxValue().equals(this.getMaxValue()) == false) return false; if (other.getScalingType() == null ^ this.getScalingType() == null) return false; if (other.getScalingType() != null && other.getScalingType().equals(this.getScalingType()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getMinValue() == null) ? 0 : getMinValue().hashCode()); hashCode = prime * hashCode + ((getMaxValue() == null) ? 0 : getMaxValue().hashCode()); hashCode = prime * hashCode + ((getScalingType() == null) ? 0 : getScalingType().hashCode()); return hashCode; } @Override public ContinuousParameterRange clone() { try { return (ContinuousParameterRange) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.sagemaker.model.transform.ContinuousParameterRangeMarshaller.getInstance().marshall(this, protocolMarshaller); } }