MemoryTracker

Struct MemoryTracker 

Source
pub struct MemoryTracker { /* private fields */ }
Expand description

Tracks tensor memory allocations for profiling.

Call [alloc] when a tensor is created and [dealloc] when freed.

§Example

use shrew::profiler::MemoryTracker;

let mut mem = MemoryTracker::new();
mem.alloc("weight", 1024 * 4);
mem.alloc("bias", 128 * 4);
assert_eq!(mem.current_bytes(), 1024 * 4 + 128 * 4);
mem.dealloc("bias");
assert_eq!(mem.current_bytes(), 1024 * 4);

Implementations§

Source§

impl MemoryTracker

Source

pub fn new() -> Self

Create a new tracker with zero allocations.

Source

pub fn alloc(&mut self, name: &str, bytes: usize)

Record a tensor allocation.

Source

pub fn dealloc(&mut self, name: &str)

Record a tensor deallocation.

Source

pub fn current_bytes(&self) -> usize

Current live memory in bytes.

Source

pub fn peak_bytes(&self) -> usize

Peak memory usage in bytes.

Source

pub fn total_allocated(&self) -> usize

Total bytes allocated over the tracker’s lifetime.

Source

pub fn alloc_count(&self) -> usize

Number of allocations recorded.

Source

pub fn dealloc_count(&self) -> usize

Number of deallocations recorded.

Source

pub fn live_count(&self) -> usize

Number of currently live allocations.

Source

pub fn reset(&mut self)

Reset the tracker.

Source

pub fn summary(&self) -> String

Format a human-readable memory summary.

Trait Implementations§

Source§

impl Default for MemoryTracker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V