267 lines
11 KiB
C++
267 lines
11 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/sagemaker/SageMaker_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/sagemaker/model/HyperParameterScalingType.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace SageMaker
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>For a hyperparameter of the integer type, specifies the range that a
|
|
* hyperparameter tuning job searches.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/IntegerParameterRange">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_SAGEMAKER_API IntegerParameterRange
|
|
{
|
|
public:
|
|
IntegerParameterRange();
|
|
IntegerParameterRange(Aws::Utils::Json::JsonView jsonValue);
|
|
IntegerParameterRange& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithName(const char* value) { SetName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline const Aws::String& GetMinValue() const{ return m_minValue; }
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline bool MinValueHasBeenSet() const { return m_minValueHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMinValue(const Aws::String& value) { m_minValueHasBeenSet = true; m_minValue = value; }
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMinValue(Aws::String&& value) { m_minValueHasBeenSet = true; m_minValue = std::move(value); }
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMinValue(const char* value) { m_minValueHasBeenSet = true; m_minValue.assign(value); }
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMinValue(const Aws::String& value) { SetMinValue(value); return *this;}
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMinValue(Aws::String&& value) { SetMinValue(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The minimum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMinValue(const char* value) { SetMinValue(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline const Aws::String& GetMaxValue() const{ return m_maxValue; }
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline bool MaxValueHasBeenSet() const { return m_maxValueHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMaxValue(const Aws::String& value) { m_maxValueHasBeenSet = true; m_maxValue = value; }
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMaxValue(Aws::String&& value) { m_maxValueHasBeenSet = true; m_maxValue = std::move(value); }
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline void SetMaxValue(const char* value) { m_maxValueHasBeenSet = true; m_maxValue.assign(value); }
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMaxValue(const Aws::String& value) { SetMaxValue(value); return *this;}
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMaxValue(Aws::String&& value) { SetMaxValue(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The maximum value of the hyperparameter to search.</p>
|
|
*/
|
|
inline IntegerParameterRange& WithMaxValue(const char* value) { SetMaxValue(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline const HyperParameterScalingType& GetScalingType() const{ return m_scalingType; }
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline bool ScalingTypeHasBeenSet() const { return m_scalingTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline void SetScalingType(const HyperParameterScalingType& value) { m_scalingTypeHasBeenSet = true; m_scalingType = value; }
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline void SetScalingType(HyperParameterScalingType&& value) { m_scalingTypeHasBeenSet = true; m_scalingType = std::move(value); }
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline IntegerParameterRange& WithScalingType(const HyperParameterScalingType& value) { SetScalingType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
|
|
* For information about choosing a hyperparameter scale, see <a
|
|
* href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter
|
|
* Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon
|
|
* SageMaker hyperparameter tuning chooses the best scale for the
|
|
* hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches
|
|
* the values in the hyperparameter range by using a linear scale.</p> </dd>
|
|
* <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the
|
|
* hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling
|
|
* works only for ranges that have only values greater than 0.</p> </dd> </dl>
|
|
*/
|
|
inline IntegerParameterRange& WithScalingType(HyperParameterScalingType&& value) { SetScalingType(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet;
|
|
|
|
Aws::String m_minValue;
|
|
bool m_minValueHasBeenSet;
|
|
|
|
Aws::String m_maxValue;
|
|
bool m_maxValueHasBeenSet;
|
|
|
|
HyperParameterScalingType m_scalingType;
|
|
bool m_scalingTypeHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace SageMaker
|
|
} // namespace Aws
|