Skip to main content

SamplerState

Struct SamplerState 

Source
pub struct SamplerState {
Show 13 fields pub version: u32, pub source_id: String, pub source_length: usize, pub rank: usize, pub world_size: usize, pub epoch: u64, pub shuffle_seed: Option<u64>, pub tail: SampleTail, pub epoch_size: usize, pub carried_consumed: usize, pub scope_size: usize, pub indices: Vec<usize>, pub committed: usize,
}
Available on crate feature std only.
Expand description

Actual rank-local sample order and its committed cursor.

The order itself is recorded, so restoration does not depend on reconstructing a previous rand version’s permutation. Outstanding prefetch is NOT committed: restore begins at committed, replaying issued-but-unconsumed samples.

Fields§

§version: u32

Record format, currently one.

§source_id: String

Caller-supplied identity of the immutable dataset/version.

§source_length: usize

Original source length, not a rank-local length.

§rank: usize

Data rank; tensor/pipeline ranks may use the same data coordinate.

§world_size: usize

Data replicas assigning distinct examples.

§epoch: u64

Current caller-selected epoch number.

§shuffle_seed: Option<u64>

Private shuffle seed; None selects original source order.

§tail: SampleTail

Tail policy used when starting a fresh epoch.

§epoch_size: usize

Size of the originally selected epoch, after its initial tail policy.

§carried_consumed: usize

Global consumption preceding the most recent topology change.

§scope_size: usize

Remaining global scope assigned at that topology change.

§indices: Vec<usize>

Actual local order; positions are original dataset indices.

§committed: usize

Samples actually consumed by this rank from this scope.

Implementations§

Source§

impl SamplerState

Source

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

Validate rank geometry, ordering, bounds and committed accounting.

Trait Implementations§

Source§

impl Clone for SamplerState

Source§

fn clone(&self) -> Self

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 SamplerState

Source§

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

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

impl<'de> Deserialize<'de> for SamplerState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for SamplerState

Source§

impl PartialEq for SamplerState

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl<B: Backend> Record<B> for SamplerState

Source§

type Item<P: PrecisionSettings> = SamplerState

Type of the item that can be serialized and deserialized.
Source§

fn into_item<P: PrecisionSettings>(self) -> Self

Convert the current record into the corresponding item that follows the given settings.
Source§

fn from_item<P: PrecisionSettings>(item: Self, _: &B::Device) -> Self

Convert the given item into a record.
Source§

impl Serialize for SamplerState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SamplerState

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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.