#[non_exhaustive]pub struct HyperbandStrategyConfigBuilder { /* private fields */ }
Expand description
A builder for HyperbandStrategyConfig
.
Implementations§
source§impl HyperbandStrategyConfigBuilder
impl HyperbandStrategyConfigBuilder
sourcepub fn min_resource(self, input: i32) -> Self
pub fn min_resource(self, input: i32) -> Self
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource
has not been reached, the training job is not stopped by Hyperband
.
sourcepub fn set_min_resource(self, input: Option<i32>) -> Self
pub fn set_min_resource(self, input: Option<i32>) -> Self
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource
has not been reached, the training job is not stopped by Hyperband
.
sourcepub fn get_min_resource(&self) -> &Option<i32>
pub fn get_min_resource(&self) -> &Option<i32>
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource
has not been reached, the training job is not stopped by Hyperband
.
sourcepub fn max_resource(self, input: i32) -> Self
pub fn max_resource(self, input: i32) -> Self
The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource
value, it is stopped. If a value for MaxResource
is not provided, and Hyperband
is selected as the hyperparameter tuning strategy, HyperbandTraining
attempts to infer MaxResource
from the following keys (if present) in StaticsHyperParameters:
-
epochs
-
numepochs
-
n-epochs
-
n_epochs
-
num_epochs
If HyperbandStrategyConfig
is unable to infer a value for MaxResource
, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.
sourcepub fn set_max_resource(self, input: Option<i32>) -> Self
pub fn set_max_resource(self, input: Option<i32>) -> Self
The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource
value, it is stopped. If a value for MaxResource
is not provided, and Hyperband
is selected as the hyperparameter tuning strategy, HyperbandTraining
attempts to infer MaxResource
from the following keys (if present) in StaticsHyperParameters:
-
epochs
-
numepochs
-
n-epochs
-
n_epochs
-
num_epochs
If HyperbandStrategyConfig
is unable to infer a value for MaxResource
, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.
sourcepub fn get_max_resource(&self) -> &Option<i32>
pub fn get_max_resource(&self) -> &Option<i32>
The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource
value, it is stopped. If a value for MaxResource
is not provided, and Hyperband
is selected as the hyperparameter tuning strategy, HyperbandTraining
attempts to infer MaxResource
from the following keys (if present) in StaticsHyperParameters:
-
epochs
-
numepochs
-
n-epochs
-
n_epochs
-
num_epochs
If HyperbandStrategyConfig
is unable to infer a value for MaxResource
, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.
sourcepub fn build(self) -> HyperbandStrategyConfig
pub fn build(self) -> HyperbandStrategyConfig
Consumes the builder and constructs a HyperbandStrategyConfig
.
Trait Implementations§
source§impl Clone for HyperbandStrategyConfigBuilder
impl Clone for HyperbandStrategyConfigBuilder
source§fn clone(&self) -> HyperbandStrategyConfigBuilder
fn clone(&self) -> HyperbandStrategyConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for HyperbandStrategyConfigBuilder
impl Default for HyperbandStrategyConfigBuilder
source§fn default() -> HyperbandStrategyConfigBuilder
fn default() -> HyperbandStrategyConfigBuilder
source§impl PartialEq for HyperbandStrategyConfigBuilder
impl PartialEq for HyperbandStrategyConfigBuilder
source§fn eq(&self, other: &HyperbandStrategyConfigBuilder) -> bool
fn eq(&self, other: &HyperbandStrategyConfigBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for HyperbandStrategyConfigBuilder
Auto Trait Implementations§
impl Freeze for HyperbandStrategyConfigBuilder
impl RefUnwindSafe for HyperbandStrategyConfigBuilder
impl Send for HyperbandStrategyConfigBuilder
impl Sync for HyperbandStrategyConfigBuilder
impl Unpin for HyperbandStrategyConfigBuilder
impl UnwindSafe for HyperbandStrategyConfigBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more