IntegerParameter: IntegerParameter Class

In DyfanJones/sagemaker-r-mlcore: sagemaker machine learning core classes and methods

IntegerParameter Class

Description

A class for representing hyperparameters that have an integer range of possible values.

Super class

sagemaker.mlcore::ParameterRange -> IntegerParameter

Public fields

.name

Helps to categorise Class

Methods

Public methods

• IntegerParameter$new()

• IntegerParameter$cast_to_type()

• IntegerParameter$clone()

Inherited methods

• sagemaker.mlcore::ParameterRange$as_tuning_range()

• sagemaker.mlcore::ParameterRange$format()

• sagemaker.mlcore::ParameterRange$is_valid()

---

Method new()

Initialize a IntegerParameter

Usage

IntegerParameter$new(
  min_value,
  max_value,
  scaling_type = c("Auto", "Linear", "Logarithmic", "ReverseLogarithmic")
)

Arguments

min_value

(int): The minimum value for the range.

max_value

(int): The maximum value for the range.

scaling_type

(str): The scale used for searching the range during tuning (default: 'Auto'). Valid values: 'Auto', 'Linear', Logarithmic' and 'ReverseLogarithmic'.

---

Method cast_to_type()

cast value to integer

Usage

IntegerParameter$cast_to_type(value)

Arguments

value

The value to be verified.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

IntegerParameter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-mlcore documentation built on May 3, 2022, 10:08 a.m.