Struct burn::train::LearnerSummary
pub struct LearnerSummary {
pub epochs: usize,
pub metrics: SummaryMetrics,
/* private fields */
}
Expand description
Detailed training summary.
Fields§
§epochs: usize
The number of epochs completed.
metrics: SummaryMetrics
The summary of recorded metrics during training.
Implementations§
§impl LearnerSummary
impl LearnerSummary
pub fn new<S>(
directory: impl AsRef<Path>,
metrics: &[S],
) -> Result<LearnerSummary, String>
pub fn new<S>( directory: impl AsRef<Path>, metrics: &[S], ) -> Result<LearnerSummary, String>
Creates a new learner summary for the specified metrics.
§Arguments
directory
- The directory containing the training artifacts (checkpoints and logs).metrics
- The list of metrics to collect for the summary.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for LearnerSummary
impl RefUnwindSafe for LearnerSummary
impl Send for LearnerSummary
impl Sync for LearnerSummary
impl Unpin for LearnerSummary
impl UnwindSafe for LearnerSummary
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
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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>
Converts
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>
Converts
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§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> ToCompactString for Twhere
T: Display,
impl<T> ToCompactString for Twhere
T: Display,
§fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>
fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>
Fallible version of [
ToCompactString::to_compact_string()
] Read more§fn to_compact_string(&self) -> CompactString
fn to_compact_string(&self) -> CompactString
Converts the given value to a [
CompactString
]. Read more