#[non_exhaustive]pub struct TrainingPlanSummary {Show 15 fields
pub training_plan_arn: Option<String>,
pub training_plan_name: Option<String>,
pub status: Option<TrainingPlanStatus>,
pub status_message: Option<String>,
pub duration_hours: Option<i64>,
pub duration_minutes: Option<i64>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub upfront_fee: Option<String>,
pub currency_code: Option<String>,
pub total_instance_count: Option<i32>,
pub available_instance_count: Option<i32>,
pub in_use_instance_count: Option<i32>,
pub target_resources: Option<Vec<SageMakerResourceName>>,
pub reserved_capacity_summaries: Option<Vec<ReservedCapacitySummary>>,
}Expand description
Details of the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.training_plan_arn: Option<String>The Amazon Resource Name (ARN); of the training plan.
training_plan_name: Option<String>The name of the training plan.
status: Option<TrainingPlanStatus>The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
status_message: Option<String>A message providing additional information about the current status of the training plan.
duration_hours: Option<i64>The number of whole hours in the total duration for this training plan.
duration_minutes: Option<i64>The additional minutes beyond whole hours in the total duration for this training plan.
start_time: Option<DateTime>The start time of the training plan.
end_time: Option<DateTime>The end time of the training plan.
upfront_fee: Option<String>The upfront fee for the training plan.
currency_code: Option<String>The currency code for the upfront fee (e.g., USD).
total_instance_count: Option<i32>The total number of instances reserved in this training plan.
available_instance_count: Option<i32>The number of instances currently available for use in this training plan.
in_use_instance_count: Option<i32>The number of instances currently in use from this training plan.
target_resources: Option<Vec<SageMakerResourceName>>The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
reserved_capacity_summaries: Option<Vec<ReservedCapacitySummary>>A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
Implementations§
Source§impl TrainingPlanSummary
impl TrainingPlanSummary
Sourcepub fn training_plan_arn(&self) -> Option<&str>
pub fn training_plan_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN); of the training plan.
Sourcepub fn training_plan_name(&self) -> Option<&str>
pub fn training_plan_name(&self) -> Option<&str>
The name of the training plan.
Sourcepub fn status(&self) -> Option<&TrainingPlanStatus>
pub fn status(&self) -> Option<&TrainingPlanStatus>
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
A message providing additional information about the current status of the training plan.
Sourcepub fn duration_hours(&self) -> Option<i64>
pub fn duration_hours(&self) -> Option<i64>
The number of whole hours in the total duration for this training plan.
Sourcepub fn duration_minutes(&self) -> Option<i64>
pub fn duration_minutes(&self) -> Option<i64>
The additional minutes beyond whole hours in the total duration for this training plan.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The start time of the training plan.
Sourcepub fn upfront_fee(&self) -> Option<&str>
pub fn upfront_fee(&self) -> Option<&str>
The upfront fee for the training plan.
Sourcepub fn currency_code(&self) -> Option<&str>
pub fn currency_code(&self) -> Option<&str>
The currency code for the upfront fee (e.g., USD).
Sourcepub fn total_instance_count(&self) -> Option<i32>
pub fn total_instance_count(&self) -> Option<i32>
The total number of instances reserved in this training plan.
Sourcepub fn available_instance_count(&self) -> Option<i32>
pub fn available_instance_count(&self) -> Option<i32>
The number of instances currently available for use in this training plan.
Sourcepub fn in_use_instance_count(&self) -> Option<i32>
pub fn in_use_instance_count(&self) -> Option<i32>
The number of instances currently in use from this training plan.
Sourcepub fn target_resources(&self) -> &[SageMakerResourceName]
pub fn target_resources(&self) -> &[SageMakerResourceName]
The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_resources.is_none().
Sourcepub fn reserved_capacity_summaries(&self) -> &[ReservedCapacitySummary]
pub fn reserved_capacity_summaries(&self) -> &[ReservedCapacitySummary]
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .reserved_capacity_summaries.is_none().
Source§impl TrainingPlanSummary
impl TrainingPlanSummary
Sourcepub fn builder() -> TrainingPlanSummaryBuilder
pub fn builder() -> TrainingPlanSummaryBuilder
Creates a new builder-style object to manufacture TrainingPlanSummary.
Trait Implementations§
Source§impl Clone for TrainingPlanSummary
impl Clone for TrainingPlanSummary
Source§fn clone(&self) -> TrainingPlanSummary
fn clone(&self) -> TrainingPlanSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TrainingPlanSummary
impl Debug for TrainingPlanSummary
Source§impl PartialEq for TrainingPlanSummary
impl PartialEq for TrainingPlanSummary
impl StructuralPartialEq for TrainingPlanSummary
Auto Trait Implementations§
impl Freeze for TrainingPlanSummary
impl RefUnwindSafe for TrainingPlanSummary
impl Send for TrainingPlanSummary
impl Sync for TrainingPlanSummary
impl Unpin for TrainingPlanSummary
impl UnwindSafe for TrainingPlanSummary
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);