Struct ParameterRanges

#[non_exhaustive]
pub struct ParameterRanges {
    pub integer_parameter_ranges: Option<Vec<IntegerParameterRange>>,
    pub continuous_parameter_ranges: Option<Vec<ContinuousParameterRange>>,
    pub categorical_parameter_ranges: Option<Vec<CategoricalParameterRange>>,
    pub auto_parameters: Option<Vec<AutoParameter>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

integer_parameter_ranges: Option<Vec<IntegerParameterRange>>

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

continuous_parameter_ranges: Option<Vec<ContinuousParameterRange>>

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

categorical_parameter_ranges: Option<Vec<CategoricalParameterRange>>

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

auto_parameters: Option<Vec<AutoParameter>>

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

Implementations

impl ParameterRanges

pub fn integer_parameter_ranges(&self) -> &[IntegerParameterRange]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .integer_parameter_ranges.is_none().

pub fn continuous_parameter_ranges(&self) -> &[ContinuousParameterRange]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .continuous_parameter_ranges.is_none().

pub fn categorical_parameter_ranges(&self) -> &[CategoricalParameterRange]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .categorical_parameter_ranges.is_none().

pub fn auto_parameters(&self) -> &[AutoParameter]

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auto_parameters.is_none().

impl ParameterRanges

pub fn builder() -> ParameterRangesBuilder

Creates a new builder-style object to manufacture ParameterRanges.

Trait Implementations

impl Clone for ParameterRanges

fn clone(&self) -> ParameterRanges

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterRanges

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ParameterRanges

fn eq(&self, other: &ParameterRanges) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParameterRanges