Struct dfdx::nn::Dropout

pub struct Dropout {
    pub p: f32,
    /* private fields */
}

A Module that calls dropout() in Module::forward() with probability self.p.

This also implements [Module<(Tensor, Rng)>] if you want to pass in an Rng externally, though this may be harder to use and infect other modules.

Default is implemented as p=0.5 and seeds.

Implementation details: This stores the Rng in a RefCell to maintain compatibility with forward taking a non-mutable reference to self.

Example:

type MlpWithDropout = (
    Dropout,
    Linear<5, 10>,
    ReLU,
    Dropout,
);

// or
let my_mlp = (
    Dropout::p(0.5),
    Linear::<5, 10>::default(),
    ReLU::default(),
    Dropout::p(0.1),
);

Fields

p: f32

Implementations

impl Dropout

pub fn new(p: f32, rng_seed: u64) -> Self

Constructs Dropout with p and rng.

pub fn p(p: f32) -> Self

Constructs Dropout with p and a different seed every call.

Trait Implementations

impl CanUpdateWithGradients for Dropout

fn update<G: GradientProvider>(&mut self, _: &mut G)

Does nothing.

impl Clone for Dropout

fn clone(&self) -> Dropout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dropout

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

Formats the value using the given formatter.

impl Default for Dropout

fn default() -> Self

Sets self.p to 0.5, and seeds StdRng with 0.

impl LoadFromNpz for Dropout

fn load<P: AsRef<Path>>(&mut self, path: P) -> Result<(), NpzError>

Loads data from a .npz zip archive at the specified path.

fn read<R>(
    &mut self,
    _filename_prefix: &str,
    _r: &mut ZipArchive<R>
) -> Result<(), NpzError> where
    R: Read + Seek, 

Reads this object from a ZipArchive. r with a base filename of filename_prefix.

impl<R: Rng + SeedableRng, T: Tensor<Dtype = f32>> Module<(T, R)> for Dropout

fn forward(&self, input: (T, R)) -> Self::Output

Calls dropout() using input.1.

type Output = (T, R)

The type that this unit produces given Input.

impl<T: Tensor<Dtype = f32>> Module<T> for Dropout

fn forward(&self, input: T) -> Self::Output

Calls dropout() using self.rng.

type Output = T

The type that this unit produces given Input.

impl ResetParams for Dropout

fn reset_params<R: Rng>(&mut self, _: &mut R)

Does nothing.

impl SaveToNpz for Dropout

fn save<P: AsRef<Path>>(&self, path: P) -> ZipResult<()>

Save this object into the .npz file determined located at path.

fn write<W>(&self, _filename_prefix: &str, _w: &mut ZipWriter<W>) -> ZipResult<()> where
    W: Write + Seek, 

Write this object into ZipWriter w with a base filename of filename_prefix.