Struct MemoryProfilerCallback 

pub struct MemoryProfilerCallback {
    pub stats: MemoryStats,
    /* private fields */
}

Memory profiler callback for tracking memory usage during training.

Example

use tensorlogic_train::{MemoryProfilerCallback, Callback};

let mut profiler = MemoryProfilerCallback::new()
    .with_epoch_tracking(true)
    .with_batch_tracking(false);

// Use in training loop

Fields

stats: MemoryStats

Memory statistics.

Implementations

impl MemoryProfilerCallback

pub fn new() -> Self

Create a new memory profiler callback.

pub fn with_epoch_tracking(self, enabled: bool) -> Self

Enable epoch-level tracking.

pub fn with_batch_tracking(self, enabled: bool) -> Self

Enable batch-level tracking.

pub fn with_log_frequency(self, frequency: usize) -> Self

Set logging frequency.

pub fn get_stats(&self) -> &MemoryStats

Get memory statistics.

pub fn estimate_tensor_memory(tensors: &[&[f64]]) -> usize

Estimate current memory usage based on tensors.

This is a simplified estimation - actual memory usage depends on allocator behavior, alignment, and fragmentation.

pub fn estimate_parameter_memory( parameters: &HashMap<String, Array<f64, IxDyn>>, ) -> usize

Estimate memory for parameters.

pub fn report(&self) -> String

Get memory usage report.

Trait Implementations

impl Callback for MemoryProfilerCallback

fn on_train_begin(&mut self, _state: &TrainingState) -> TrainResult<()>

Called at the beginning of training.

fn on_epoch_begin( &mut self, _epoch: usize, _state: &TrainingState, ) -> TrainResult<()>

Called at the beginning of an epoch.

fn on_epoch_end( &mut self, epoch: usize, state: &TrainingState, ) -> TrainResult<()>

Called at the end of an epoch.

fn on_batch_end( &mut self, batch: usize, state: &TrainingState, ) -> TrainResult<()>

Called at the end of a batch.

fn on_train_end(&mut self, _state: &TrainingState) -> TrainResult<()>

Called at the end of training.

fn on_batch_begin( &mut self, _batch: usize, _state: &TrainingState, ) -> TrainResult<()>

Called at the beginning of a batch.

fn on_validation_end(&mut self, _state: &TrainingState) -> TrainResult<()>

Called after validation.

fn should_stop(&self) -> bool

Check if training should stop early.

impl Clone for MemoryProfilerCallback

fn clone(&self) -> MemoryProfilerCallback

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryProfilerCallback

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MemoryProfilerCallback

fn default() -> Self

Returns the “default value” for a type.