Struct RandomSampler 

pub struct RandomSampler { /* private fields */ }

Random sampler that yields indices in random order

This sampler shuffles the indices and yields them in random order. Can optionally sample with or without replacement and control the number of samples returned.

Examples

use torsh_data::sampler::{RandomSampler, Sampler};

// Sample all indices in random order
let sampler = RandomSampler::new(5, None, false).with_generator(42);
let indices: Vec<usize> = sampler.iter().collect();
assert_eq!(indices.len(), 5);

// Sample 3 indices without replacement
let sampler = RandomSampler::new(10, Some(3), false).with_generator(42);
let indices: Vec<usize> = sampler.iter().collect();
assert_eq!(indices.len(), 3);

Implementations

impl RandomSampler

pub fn new( dataset_size: usize, num_samples: Option<usize>, replacement: bool, ) -> Self

Create a new random sampler

Arguments

• dataset_size - Number of samples in the dataset
• num_samples - Number of samples to yield (None for all)
• replacement - Whether to sample with replacement

Panics

Panics if dataset_size is 0 or if sampling without replacement but num_samples > dataset_size

pub fn simple(dataset_size: usize) -> Self

Create a simple random sampler with default settings (no replacement, all samples)

Arguments

• dataset_size - Number of samples in the dataset

Panics

Panics if dataset_size is 0

pub fn with_replacement( dataset_size: usize, replacement: bool, num_samples: Option<usize>, ) -> Self

Create a random sampler with specific replacement setting

Arguments

• dataset_size - Number of samples in the dataset
• replacement - Whether to sample with replacement
• num_samples - Number of samples to yield (None for all)

Panics

Panics if dataset_size is 0

pub fn with_generator(self, seed: u64) -> Self

Set the random number generator seed

Arguments

• seed - Random seed for reproducible sampling

pub fn dataset_size(&self) -> usize

Get the dataset size

pub fn num_samples(&self) -> usize

Get the number of samples that will be yielded

pub fn replacement(&self) -> bool

Check if sampling with replacement

pub fn generator(&self) -> Option<u64>

Get the generator seed if set

Trait Implementations

impl Clone for RandomSampler

fn clone(&self) -> RandomSampler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RandomSampler

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

Formats the value using the given formatter.

impl Sampler for RandomSampler

type Iter = SamplerIterator

Iterator type returned by the sampler

fn iter(&self) -> Self::Iter

Create an iterator over indices

fn len(&self) -> usize

Total number of samples that will be yielded

fn is_empty(&self) -> bool

Check if sampler is empty

fn into_batch_sampler( self, batch_size: usize, drop_last: bool, ) -> BatchingSampler<Self>

where Self: Sized,

Convert this sampler into a batch sampler

fn into_distributed( self, num_replicas: usize, rank: usize, ) -> DistributedWrapper<Self>

where Self: Sized,

Create a distributed version of this sampler