#[non_exhaustive]pub struct StoppingConditionBuilder { /* private fields */ }
Expand description
A builder for StoppingCondition
.
Implementations§
Source§impl StoppingConditionBuilder
impl StoppingConditionBuilder
Sourcepub fn max_runtime_in_seconds(self, input: i32) -> Self
pub fn max_runtime_in_seconds(self, input: i32) -> Self
The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut
error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy
is specified in the job request, MaxRuntimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob
can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
Sourcepub fn set_max_runtime_in_seconds(self, input: Option<i32>) -> Self
pub fn set_max_runtime_in_seconds(self, input: Option<i32>) -> Self
The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut
error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy
is specified in the job request, MaxRuntimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob
can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
Sourcepub fn get_max_runtime_in_seconds(&self) -> &Option<i32>
pub fn get_max_runtime_in_seconds(&self) -> &Option<i32>
The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut
error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy
is specified in the job request, MaxRuntimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob
can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
Sourcepub fn max_wait_time_in_seconds(self, input: i32) -> Self
pub fn max_wait_time_in_seconds(self, input: i32) -> Self
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds
. If the job does not complete during this time, SageMaker ends the job.
When RetryStrategy
is specified in the job request, MaxWaitTimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt.
Sourcepub fn set_max_wait_time_in_seconds(self, input: Option<i32>) -> Self
pub fn set_max_wait_time_in_seconds(self, input: Option<i32>) -> Self
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds
. If the job does not complete during this time, SageMaker ends the job.
When RetryStrategy
is specified in the job request, MaxWaitTimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt.
Sourcepub fn get_max_wait_time_in_seconds(&self) -> &Option<i32>
pub fn get_max_wait_time_in_seconds(&self) -> &Option<i32>
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds
. If the job does not complete during this time, SageMaker ends the job.
When RetryStrategy
is specified in the job request, MaxWaitTimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt.
Sourcepub fn max_pending_time_in_seconds(self, input: i32) -> Self
pub fn max_pending_time_in_seconds(self, input: i32) -> Self
The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.
When working with training jobs that use capacity from training plans, not all Pending
job states count against the MaxPendingTimeInSeconds
limit. The following scenarios do not increment the MaxPendingTimeInSeconds
counter:
-
The plan is in a
Scheduled
state: Jobs queued (inPending
status) before a plan's start date (waiting for scheduled start time) -
Between capacity reservations: Jobs temporarily back to
Pending
status between two capacity reservation periods
MaxPendingTimeInSeconds
only increments when jobs are actively waiting for capacity in an Active
plan.
Sourcepub fn set_max_pending_time_in_seconds(self, input: Option<i32>) -> Self
pub fn set_max_pending_time_in_seconds(self, input: Option<i32>) -> Self
The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.
When working with training jobs that use capacity from training plans, not all Pending
job states count against the MaxPendingTimeInSeconds
limit. The following scenarios do not increment the MaxPendingTimeInSeconds
counter:
-
The plan is in a
Scheduled
state: Jobs queued (inPending
status) before a plan's start date (waiting for scheduled start time) -
Between capacity reservations: Jobs temporarily back to
Pending
status between two capacity reservation periods
MaxPendingTimeInSeconds
only increments when jobs are actively waiting for capacity in an Active
plan.
Sourcepub fn get_max_pending_time_in_seconds(&self) -> &Option<i32>
pub fn get_max_pending_time_in_seconds(&self) -> &Option<i32>
The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.
When working with training jobs that use capacity from training plans, not all Pending
job states count against the MaxPendingTimeInSeconds
limit. The following scenarios do not increment the MaxPendingTimeInSeconds
counter:
-
The plan is in a
Scheduled
state: Jobs queued (inPending
status) before a plan's start date (waiting for scheduled start time) -
Between capacity reservations: Jobs temporarily back to
Pending
status between two capacity reservation periods
MaxPendingTimeInSeconds
only increments when jobs are actively waiting for capacity in an Active
plan.
Sourcepub fn build(self) -> StoppingCondition
pub fn build(self) -> StoppingCondition
Consumes the builder and constructs a StoppingCondition
.
Trait Implementations§
Source§impl Clone for StoppingConditionBuilder
impl Clone for StoppingConditionBuilder
Source§fn clone(&self) -> StoppingConditionBuilder
fn clone(&self) -> StoppingConditionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StoppingConditionBuilder
impl Debug for StoppingConditionBuilder
Source§impl Default for StoppingConditionBuilder
impl Default for StoppingConditionBuilder
Source§fn default() -> StoppingConditionBuilder
fn default() -> StoppingConditionBuilder
Source§impl PartialEq for StoppingConditionBuilder
impl PartialEq for StoppingConditionBuilder
Source§fn eq(&self, other: &StoppingConditionBuilder) -> bool
fn eq(&self, other: &StoppingConditionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StoppingConditionBuilder
Auto Trait Implementations§
impl Freeze for StoppingConditionBuilder
impl RefUnwindSafe for StoppingConditionBuilder
impl Send for StoppingConditionBuilder
impl Sync for StoppingConditionBuilder
impl Unpin for StoppingConditionBuilder
impl UnwindSafe for StoppingConditionBuilder
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§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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);