Skip to main content

LayerWeightResidency

Enum LayerWeightResidency 

Source
#[non_exhaustive]
pub enum LayerWeightResidency { FullyResident, LayerwiseHost(LayerwiseLoadOptions), DenseDiskStream(DenseDiskStreamLoadOptions), }
Expand description

Placement policy for ordinary architecture execution units.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

FullyResident

Construct every rank-local module once and retain it on the execution device.

§

LayerwiseHost(LayerwiseLoadOptions)

Eagerly materialize units on a host stream and use a bounded device window.

§

DenseDiskStream(DenseDiskStreamLoadOptions)

Leave units cold on disk and use finite host and device caches.

Implementations§

Source§

impl LayerWeightResidency

Source

pub const fn max_cached_shards(self) -> usize

Returns the checkpoint shard/reader cache bound carried by this policy.

Source

pub const fn sample_backend_memory(self) -> bool

Returns whether backend allocator memory should be sampled.

Source

pub const fn sample_process_memory(self) -> bool

Returns whether process memory should be sampled.

Source

pub fn device_depth(self, unit_count: usize) -> usize

Returns the maximum execution-device unit window.

Source

pub fn offload(self) -> Result<OffloadConfig, WeightResidencyPolicyError>

Resolves this policy into the shared offload configuration.

Source

pub const fn dense(self) -> Option<DenseDiskStreamLoadOptions>

Returns dense-stream controls when this policy streams from disk.

Source

pub const fn is_fully_resident(self) -> bool

Returns whether every ordinary execution unit remains device-resident.

Source

pub const fn execution_residency(self) -> ExecutionResidency

Returns the stable physical execution classification.

Trait Implementations§

Source§

impl Clone for LayerWeightResidency

Source§

fn clone(&self) -> LayerWeightResidency

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LayerWeightResidency

Source§

impl Debug for LayerWeightResidency

Source§

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

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

impl Default for LayerWeightResidency

Source§

fn default() -> LayerWeightResidency

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

impl Eq for LayerWeightResidency

Source§

impl From<DenseDiskStreamLoadOptions> for LayerWeightResidency

Source§

fn from(value: DenseDiskStreamLoadOptions) -> Self

Converts to this type from the input type.
Source§

impl From<LayerwiseLoadOptions> for LayerWeightResidency

Source§

fn from(value: LayerwiseLoadOptions) -> Self

Converts to this type from the input type.
Source§

impl From<OrdinaryWeightResidency> for LayerWeightResidency

Source§

fn from(value: OrdinaryWeightResidency) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for LayerWeightResidency

Source§

fn eq(&self, other: &LayerWeightResidency) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LayerWeightResidency

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.