Struct TorchCollate

pub struct TorchCollate;

Available on crate feature tch only.

Torch Collate function that mimic the default_collate function from PyTorch.

Data is collated inside a tch Tensor.

Basic transformation implemented for the default Collate :

• Vec<Scalar> -> tch::Tensor<scalar>
• Vec<tuple> -> tuple(ndarray)
• Vec<HashMap<Key, Value>> -> HasMap<Key, TorchCollate::default().collate(Vec<Value>)
• Vec<Array> -> Vec<Stack Array>
• Vec[V1_i, V2_i, ...] -> Vec[TorchCollate::default().collate([V1_1, V1_2, ...]), TorchCollate::default().collate([V2_1, V2_2, ...]), ...]

Like for PyTorch version, String and u8 aren’t changed by the collation (No Op).

• Vec<String> -> Vec<String>
• Vec<&str> -> Vec<&str>
• Vec<u8> -> Vec<u8>

Trait Implementations

impl Clone for TorchCollate

fn clone(&self) -> TorchCollate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Collate<&'a CStr> for TorchCollate

type Output = Vec<&'a CStr>

The type of the collate function’s output

fn collate(&self, batch: Vec<&'a CStr>) -> Self::Output

Take a batch of samples and collate them

impl<T> Collate<&T> for TorchCollate

where T: Clone, Self: Collate<T>,

We think it makes no sense to but a bench of reference into a Tensor. That’s why if the dataset yield reference and they we clone their value. It is useful for having a non-consuming Iterator over the Dataloader.

type Output = <TorchCollate as Collate<T>>::Output

The type of the collate function’s output

fn collate(&self, batch: Vec<&T>) -> Self::Output

Take a batch of samples and collate them

impl<'a> Collate<&'a str> for TorchCollate

type Output = Vec<&'a str>

The type of the collate function’s output

fn collate(&self, batch: Vec<&'a str>) -> Self::Output

Take a batch of samples and collate them

impl<T, const N: usize> Collate<[T; N]> for TorchCollate

where Self: Collate<T>, T: Clone,

type Output = Vec<<TorchCollate as Collate<T>>::Output>

The type of the collate function’s output

fn collate(&self, batch: Vec<[T; N]>) -> Self::Output

Take a batch of samples and collate them

impl<A> Collate<(A,)> for TorchCollate

where A: Clone, TorchCollate: Collate<A>,

type Output = (<TorchCollate as Collate<A>>::Output,)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A,)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B> Collate<(A, B)> for TorchCollate

where A: Clone, B: Clone, TorchCollate: Collate<A> + Collate<B>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C> Collate<(A, B, C)> for TorchCollate

where A: Clone, B: Clone, C: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D> Collate<(A, B, C, D)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E> Collate<(A, B, C, D, E)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F> Collate<(A, B, C, D, E, F)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G> Collate<(A, B, C, D, E, F, G)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F, G)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G, H> Collate<(A, B, C, D, E, F, G, H)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, H: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G> + Collate<H>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output, <TorchCollate as Collate<H>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F, G, H)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G, H, I> Collate<(A, B, C, D, E, F, G, H, I)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, H: Clone, I: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G> + Collate<H> + Collate<I>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output, <TorchCollate as Collate<H>>::Output, <TorchCollate as Collate<I>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F, G, H, I)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G, H, I, J> Collate<(A, B, C, D, E, F, G, H, I, J)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, H: Clone, I: Clone, J: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G> + Collate<H> + Collate<I> + Collate<J>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output, <TorchCollate as Collate<H>>::Output, <TorchCollate as Collate<I>>::Output, <TorchCollate as Collate<J>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F, G, H, I, J)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G, H, I, J, K> Collate<(A, B, C, D, E, F, G, H, I, J, K)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, H: Clone, I: Clone, J: Clone, K: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G> + Collate<H> + Collate<I> + Collate<J> + Collate<K>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output, <TorchCollate as Collate<H>>::Output, <TorchCollate as Collate<I>>::Output, <TorchCollate as Collate<J>>::Output, <TorchCollate as Collate<K>>::Output)

The type of the collate function’s output

fn collate(&self, batch: Vec<(A, B, C, D, E, F, G, H, I, J, K)>) -> Self::Output

Take a batch of samples and collate them

impl<A, B, C, D, E, F, G, H, I, J, K, L> Collate<(A, B, C, D, E, F, G, H, I, J, K, L)> for TorchCollate

where A: Clone, B: Clone, C: Clone, D: Clone, E: Clone, F: Clone, G: Clone, H: Clone, I: Clone, J: Clone, K: Clone, L: Clone, TorchCollate: Collate<A> + Collate<B> + Collate<C> + Collate<D> + Collate<E> + Collate<F> + Collate<G> + Collate<H> + Collate<I> + Collate<J> + Collate<K> + Collate<L>,

type Output = (<TorchCollate as Collate<A>>::Output, <TorchCollate as Collate<B>>::Output, <TorchCollate as Collate<C>>::Output, <TorchCollate as Collate<D>>::Output, <TorchCollate as Collate<E>>::Output, <TorchCollate as Collate<F>>::Output, <TorchCollate as Collate<G>>::Output, <TorchCollate as Collate<H>>::Output, <TorchCollate as Collate<I>>::Output, <TorchCollate as Collate<J>>::Output, <TorchCollate as Collate<K>>::Output, <TorchCollate as Collate<L>>::Output)

The type of the collate function’s output

fn collate( &self, batch: Vec<(A, B, C, D, E, F, G, H, I, J, K, L)>, ) -> Self::Output

Take a batch of samples and collate them

impl<A, D> Collate<ArrayBase<OwnedRepr<A>, D>> for TorchCollate

where A: Clone + Element, D: Dimension, D::Larger: RemoveAxis,

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<Array<A, D>>) -> Self::Output

Take a batch of samples and collate them

impl<K, V> Collate<BTreeMap<K, V>> for TorchCollate

where K: Ord + Clone, V: Clone, Self: Collate<V>,

type Output = BTreeMap<K, <TorchCollate as Collate<V>>::Output>

The type of the collate function’s output

fn collate(&self, batch: Vec<BTreeMap<K, V>>) -> Self::Output

Take a batch of samples and collate them

impl Collate<CString> for TorchCollate

type Output = Vec<CString>

The type of the collate function’s output

fn collate(&self, batch: Vec<CString>) -> Self::Output

Take a batch of samples and collate them

impl<K, V, H> Collate<HashMap<K, V, H>> for TorchCollate

where K: Eq + Hash + Clone, V: Clone, Self: Collate<V>, H: BuildHasher,

type Output = HashMap<K, <TorchCollate as Collate<V>>::Output>

The type of the collate function’s output

fn collate(&self, batch: Vec<HashMap<K, V, H>>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<i128>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<i128>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroI128>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<i16>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<i16>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroI16>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<i32>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<i32>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroI32>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<i64>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<i64>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroI64>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<i8>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<i8>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroI8>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<isize>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<isize>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroIsize>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<u128>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<u128>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroU128>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<u16>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<u16>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroU16>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<u32>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<u32>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroU32>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<u64>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<u64>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroU64>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<u8>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<u8>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroU8>) -> Self::Output

Take a batch of samples and collate them

impl Collate<NonZero<usize>> for TorchCollate

type Output = ArrayBase<OwnedRepr<NonZero<usize>>, Dim<[usize; 1]>>

The type of the collate function’s output

fn collate(&self, batch: Vec<NonZeroUsize>) -> Self::Output

Take a batch of samples and collate them

impl Collate<OsString> for TorchCollate

type Output = Vec<OsString>

The type of the collate function’s output

fn collate(&self, batch: Vec<OsString>) -> Self::Output

Take a batch of samples and collate them

impl Collate<String> for TorchCollate

type Output = Vec<String>

The type of the collate function’s output

fn collate(&self, batch: Vec<String>) -> Self::Output

Take a batch of samples and collate them

impl<T> Collate<Vec<T>> for TorchCollate

where Self: Collate<T>, T: Clone,

type Output = Vec<<TorchCollate as Collate<T>>::Output>

The type of the collate function’s output

fn collate(&self, batch: Vec<Vec<T>>) -> Self::Output

Take a batch of samples and collate them

impl<T> Collate<VecDeque<T>> for TorchCollate

where Self: Collate<T>, T: Clone,

type Output = Vec<<TorchCollate as Collate<T>>::Output>

The type of the collate function’s output

fn collate(&self, batch: Vec<VecDeque<T>>) -> Self::Output

Take a batch of samples and collate them

impl Collate<bool> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<bool>) -> Self::Output

Take a batch of samples and collate them

impl Collate<f32> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<f32>) -> Self::Output

Take a batch of samples and collate them

impl Collate<f64> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<f64>) -> Self::Output

Take a batch of samples and collate them

impl Collate<i16> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<i16>) -> Self::Output

Take a batch of samples and collate them

impl Collate<i32> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<i32>) -> Self::Output

Take a batch of samples and collate them

impl Collate<i64> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<i64>) -> Self::Output

Take a batch of samples and collate them

impl Collate<i8> for TorchCollate

type Output = Tensor

The type of the collate function’s output

fn collate(&self, batch: Vec<i8>) -> Self::Output

Take a batch of samples and collate them

impl Collate<u8> for TorchCollate

NoOp for binary, as pytorch default_collate function.

type Output = Vec<u8>

The type of the collate function’s output

fn collate(&self, batch: Vec<u8>) -> Self::Output

Take a batch of samples and collate them

impl Debug for TorchCollate

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

Formats the value using the given formatter.

impl Default for TorchCollate

fn default() -> TorchCollate

Returns the “default value” for a type.

impl Ord for TorchCollate

fn cmp(&self, other: &TorchCollate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TorchCollate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TorchCollate

fn partial_cmp(&self, other: &TorchCollate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TorchCollate

impl StructuralPartialEq for TorchCollate