AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::HyperParameterSpecification Class Reference

#include <HyperParameterSpecification.h>

Public Member Functions

 HyperParameterSpecification ()
 
 HyperParameterSpecification (Aws::Utils::Json::JsonView jsonValue)
 
HyperParameterSpecificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
HyperParameterSpecificationWithName (const Aws::String &value)
 
HyperParameterSpecificationWithName (Aws::String &&value)
 
HyperParameterSpecificationWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
HyperParameterSpecificationWithDescription (const Aws::String &value)
 
HyperParameterSpecificationWithDescription (Aws::String &&value)
 
HyperParameterSpecificationWithDescription (const char *value)
 
const ParameterTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ParameterType &value)
 
void SetType (ParameterType &&value)
 
HyperParameterSpecificationWithType (const ParameterType &value)
 
HyperParameterSpecificationWithType (ParameterType &&value)
 
const ParameterRangeGetRange () const
 
bool RangeHasBeenSet () const
 
void SetRange (const ParameterRange &value)
 
void SetRange (ParameterRange &&value)
 
HyperParameterSpecificationWithRange (const ParameterRange &value)
 
HyperParameterSpecificationWithRange (ParameterRange &&value)
 
bool GetIsTunable () const
 
bool IsTunableHasBeenSet () const
 
void SetIsTunable (bool value)
 
HyperParameterSpecificationWithIsTunable (bool value)
 
bool GetIsRequired () const
 
bool IsRequiredHasBeenSet () const
 
void SetIsRequired (bool value)
 
HyperParameterSpecificationWithIsRequired (bool value)
 
const Aws::StringGetDefaultValue () const
 
bool DefaultValueHasBeenSet () const
 
void SetDefaultValue (const Aws::String &value)
 
void SetDefaultValue (Aws::String &&value)
 
void SetDefaultValue (const char *value)
 
HyperParameterSpecificationWithDefaultValue (const Aws::String &value)
 
HyperParameterSpecificationWithDefaultValue (Aws::String &&value)
 
HyperParameterSpecificationWithDefaultValue (const char *value)
 

Detailed Description

Defines a hyperparameter to be used by an algorithm.

See Also:

AWS API Reference

Definition at line 34 of file HyperParameterSpecification.h.

Constructor & Destructor Documentation

◆ HyperParameterSpecification() [1/2]

Aws::SageMaker::Model::HyperParameterSpecification::HyperParameterSpecification ( )

◆ HyperParameterSpecification() [2/2]

Aws::SageMaker::Model::HyperParameterSpecification::HyperParameterSpecification ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DefaultValueHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::DefaultValueHasBeenSet ( ) const
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 255 of file HyperParameterSpecification.h.

◆ DescriptionHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::DescriptionHasBeenSet ( ) const
inline

A brief description of the hyperparameter.

Definition at line 92 of file HyperParameterSpecification.h.

◆ GetDefaultValue()

const Aws::String& Aws::SageMaker::Model::HyperParameterSpecification::GetDefaultValue ( ) const
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 249 of file HyperParameterSpecification.h.

◆ GetDescription()

const Aws::String& Aws::SageMaker::Model::HyperParameterSpecification::GetDescription ( ) const
inline

A brief description of the hyperparameter.

Definition at line 87 of file HyperParameterSpecification.h.

◆ GetIsRequired()

bool Aws::SageMaker::Model::HyperParameterSpecification::GetIsRequired ( ) const
inline

Indicates whether this hyperparameter is required.

Definition at line 227 of file HyperParameterSpecification.h.

◆ GetIsTunable()

bool Aws::SageMaker::Model::HyperParameterSpecification::GetIsTunable ( ) const
inline

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Definition at line 203 of file HyperParameterSpecification.h.

◆ GetName()

const Aws::String& Aws::SageMaker::Model::HyperParameterSpecification::GetName ( ) const
inline

The name of this hyperparameter. The name must be unique.

Definition at line 46 of file HyperParameterSpecification.h.

◆ GetRange()

const ParameterRange& Aws::SageMaker::Model::HyperParameterSpecification::GetRange ( ) const
inline

The allowed range for this hyperparameter.

Definition at line 171 of file HyperParameterSpecification.h.

◆ GetType()

const ParameterType& Aws::SageMaker::Model::HyperParameterSpecification::GetType ( ) const
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 130 of file HyperParameterSpecification.h.

◆ IsRequiredHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::IsRequiredHasBeenSet ( ) const
inline

Indicates whether this hyperparameter is required.

Definition at line 232 of file HyperParameterSpecification.h.

◆ IsTunableHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::IsTunableHasBeenSet ( ) const
inline

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Definition at line 209 of file HyperParameterSpecification.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::HyperParameterSpecification::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::NameHasBeenSet ( ) const
inline

The name of this hyperparameter. The name must be unique.

Definition at line 51 of file HyperParameterSpecification.h.

◆ operator=()

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RangeHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::RangeHasBeenSet ( ) const
inline

The allowed range for this hyperparameter.

Definition at line 176 of file HyperParameterSpecification.h.

◆ SetDefaultValue() [1/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue ( Aws::String &&  value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 267 of file HyperParameterSpecification.h.

◆ SetDefaultValue() [2/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue ( const Aws::String value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 261 of file HyperParameterSpecification.h.

◆ SetDefaultValue() [3/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue ( const char *  value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 273 of file HyperParameterSpecification.h.

◆ SetDescription() [1/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDescription ( Aws::String &&  value)
inline

A brief description of the hyperparameter.

Definition at line 102 of file HyperParameterSpecification.h.

◆ SetDescription() [2/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDescription ( const Aws::String value)
inline

A brief description of the hyperparameter.

Definition at line 97 of file HyperParameterSpecification.h.

◆ SetDescription() [3/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetDescription ( const char *  value)
inline

A brief description of the hyperparameter.

Definition at line 107 of file HyperParameterSpecification.h.

◆ SetIsRequired()

void Aws::SageMaker::Model::HyperParameterSpecification::SetIsRequired ( bool  value)
inline

Indicates whether this hyperparameter is required.

Definition at line 237 of file HyperParameterSpecification.h.

◆ SetIsTunable()

void Aws::SageMaker::Model::HyperParameterSpecification::SetIsTunable ( bool  value)
inline

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Definition at line 215 of file HyperParameterSpecification.h.

◆ SetName() [1/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetName ( Aws::String &&  value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 61 of file HyperParameterSpecification.h.

◆ SetName() [2/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetName ( const Aws::String value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 56 of file HyperParameterSpecification.h.

◆ SetName() [3/3]

void Aws::SageMaker::Model::HyperParameterSpecification::SetName ( const char *  value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 66 of file HyperParameterSpecification.h.

◆ SetRange() [1/2]

void Aws::SageMaker::Model::HyperParameterSpecification::SetRange ( const ParameterRange value)
inline

The allowed range for this hyperparameter.

Definition at line 181 of file HyperParameterSpecification.h.

◆ SetRange() [2/2]

void Aws::SageMaker::Model::HyperParameterSpecification::SetRange ( ParameterRange &&  value)
inline

The allowed range for this hyperparameter.

Definition at line 186 of file HyperParameterSpecification.h.

◆ SetType() [1/2]

void Aws::SageMaker::Model::HyperParameterSpecification::SetType ( const ParameterType value)
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 144 of file HyperParameterSpecification.h.

◆ SetType() [2/2]

void Aws::SageMaker::Model::HyperParameterSpecification::SetType ( ParameterType &&  value)
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 151 of file HyperParameterSpecification.h.

◆ TypeHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterSpecification::TypeHasBeenSet ( ) const
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 137 of file HyperParameterSpecification.h.

◆ WithDefaultValue() [1/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue ( Aws::String &&  value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 285 of file HyperParameterSpecification.h.

◆ WithDefaultValue() [2/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue ( const Aws::String value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 279 of file HyperParameterSpecification.h.

◆ WithDefaultValue() [3/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue ( const char *  value)
inline

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Definition at line 291 of file HyperParameterSpecification.h.

◆ WithDescription() [1/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDescription ( Aws::String &&  value)
inline

A brief description of the hyperparameter.

Definition at line 117 of file HyperParameterSpecification.h.

◆ WithDescription() [2/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDescription ( const Aws::String value)
inline

A brief description of the hyperparameter.

Definition at line 112 of file HyperParameterSpecification.h.

◆ WithDescription() [3/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithDescription ( const char *  value)
inline

A brief description of the hyperparameter.

Definition at line 122 of file HyperParameterSpecification.h.

◆ WithIsRequired()

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithIsRequired ( bool  value)
inline

Indicates whether this hyperparameter is required.

Definition at line 242 of file HyperParameterSpecification.h.

◆ WithIsTunable()

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithIsTunable ( bool  value)
inline

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Definition at line 221 of file HyperParameterSpecification.h.

◆ WithName() [1/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithName ( Aws::String &&  value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 76 of file HyperParameterSpecification.h.

◆ WithName() [2/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithName ( const Aws::String value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 71 of file HyperParameterSpecification.h.

◆ WithName() [3/3]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithName ( const char *  value)
inline

The name of this hyperparameter. The name must be unique.

Definition at line 81 of file HyperParameterSpecification.h.

◆ WithRange() [1/2]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithRange ( const ParameterRange value)
inline

The allowed range for this hyperparameter.

Definition at line 191 of file HyperParameterSpecification.h.

◆ WithRange() [2/2]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithRange ( ParameterRange &&  value)
inline

The allowed range for this hyperparameter.

Definition at line 196 of file HyperParameterSpecification.h.

◆ WithType() [1/2]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithType ( const ParameterType value)
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 158 of file HyperParameterSpecification.h.

◆ WithType() [2/2]

HyperParameterSpecification& Aws::SageMaker::Model::HyperParameterSpecification::WithType ( ParameterType &&  value)
inline

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Definition at line 165 of file HyperParameterSpecification.h.


The documentation for this class was generated from the following file: