Skip to main content

PlacementPlan

Struct PlacementPlan 

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

Exact logical checkpoint placement for one rank.

Implementations§

Source§

impl PlacementPlan

Source

pub const fn new(rank: PlacementRank) -> Self

Creates a strict plan in which every checkpoint source must be named.

Source

pub fn replicated(rank: PlacementRank) -> Self

Creates a plan that replicates every checkpoint source.

Source

pub const fn rank(&self) -> PlacementRank

Returns the selected logical rank.

Source

pub fn with_default(self, placement: TensorPlacement) -> Self

Sets the placement for otherwise unnamed checkpoint sources.

Source

pub fn insert(&mut self, source: impl Into<String>, placement: TensorPlacement)

Adds or replaces one exact source placement.

Source

pub fn insert_expected( &mut self, source: impl Into<String>, expected_source_shape: impl Into<Vec<usize>>, placement: TensorPlacement, ) -> Result<(), PlacementPlanError>

Adds one source placement with an exact pre-selection shape.

Source

pub fn insert_quantized_companions( &mut self, prefix: &str, placement: TensorPlacement, has_biases: bool, )

Adds a packed weight and its scale and optional bias companions together.

Source

pub fn placement(&self, source: &str) -> Option<&TensorPlacement>

Returns an explicit placement by exact source name.

Source

pub fn validate(&self) -> Result<(), PlacementPlanError>

Validates all geometry available before checkpoint access.

Source

pub fn potentially_local( &self, source: &str, ) -> Result<bool, PlacementPlanError>

Returns whether a named source can require materialization on this rank.

Source

pub fn resolve( &self, source: &str, shape: &[usize], ) -> Result<ResolvedTensorPlacement, PlacementPlanError>

Resolves one named source against its admitted logical shape.

Source

pub fn validate_loaded_sources( &self, loaded: &BTreeSet<String>, unexpected: Vec<String>, ) -> Result<(), PlacementPlanError>

Verifies exact locally required and unexpected source coverage.

Trait Implementations§

Source§

impl Clone for PlacementPlan

Source§

fn clone(&self) -> PlacementPlan

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 Debug for PlacementPlan

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<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, !>

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.