pub struct ReportGenerator { /* private fields */ }Expand description
Report generator
Implementations§
Source§impl ReportGenerator
impl ReportGenerator
Sourcepub fn new(config: ReportConfig) -> Result<Self, ReportError>
pub fn new(config: ReportConfig) -> Result<Self, ReportError>
Create a new report generator.
Rejects config.format immediately (before any analysis or section
generation runs) when it names a format this crate cannot write –
see ReportFormat::is_implemented. The old behavior accepted any
format at construction and only discovered the mismatch inside
export_report, after a caller had already paid for the full report
generation.
Sourcepub fn with_debug_data(self, data: GradientDebugReport) -> Self
pub fn with_debug_data(self, data: GradientDebugReport) -> Self
Add gradient debug data
Sourcepub fn with_profiling_data(self, data: ProfilerReport) -> Self
pub fn with_profiling_data(self, data: ProfilerReport) -> Self
Add profiling data
Sourcepub fn with_architecture_data(self, data: ArchitectureAnalysisReport) -> Self
pub fn with_architecture_data(self, data: ArchitectureAnalysisReport) -> Self
Add model architecture data (real per-layer parameter counts, shapes,
…). Without this, Self::generate_architecture_section reports
each layer’s parameter count as N/A – an honest absence, not a
fabricated number – rather than guessing.
Sourcepub fn generate(&self) -> Result<Report, ReportError>
pub fn generate(&self) -> Result<Report, ReportError>
Generate the report
Sourcepub fn export_report(&self, report: &Report) -> Result<(), ReportError>
pub fn export_report(&self, report: &Report) -> Result<(), ReportError>
Export report to file
Trait Implementations§
Auto Trait Implementations§
impl Freeze for ReportGenerator
impl RefUnwindSafe for ReportGenerator
impl Send for ReportGenerator
impl Sync for ReportGenerator
impl Unpin for ReportGenerator
impl UnsafeUnpin for ReportGenerator
impl UnwindSafe for ReportGenerator
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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> ⓘ
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.