Skip to main content

MemoryEstimate

Struct MemoryEstimate 

Source
pub struct MemoryEstimate {
    pub total_bytes: usize,
    pub peak_bytes: usize,
    pub intermediate_count: usize,
    pub max_tensor_size: usize,
    pub total_elements: usize,
}
Expand description

Detailed memory estimate for an expression.

Fields§

§total_bytes: usize

Total memory needed for all tensors (in bytes)

§peak_bytes: usize

Peak memory usage during execution (in bytes)

§intermediate_count: usize

Number of intermediate tensors

§max_tensor_size: usize

Maximum tensor size (in elements)

§total_elements: usize

Total number of elements across all tensors

Implementations§

Source§

impl MemoryEstimate

Source

pub fn total_mb(&self) -> f64

Get total memory in megabytes.

Source

pub fn peak_mb(&self) -> f64

Get peak memory in megabytes.

Source

pub fn exceeds_limit(&self, limit_bytes: usize) -> bool

Check if this exceeds a memory limit (in bytes).

Source

pub fn suggest_batch_size( &self, budget_bytes: usize, current_batch: usize, ) -> usize

Suggest optimal batch size given a memory budget.

Trait Implementations§

Source§

impl Clone for MemoryEstimate

Source§

fn clone(&self) -> MemoryEstimate

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MemoryEstimate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MemoryEstimate

Source§

fn default() -> MemoryEstimate

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

impl Display for MemoryEstimate

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.