Skip to main content

Dropout

Struct Dropout 

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

Dropout regularization layer.

During training, randomly zeroes elements with probability p. During evaluation, returns input unchanged.

The output is scaled by 1/(1-p) during training to maintain expected values (inverted dropout).

§Example

use aprender::nn::{Module, Dropout};
use aprender::autograd::Tensor;

let mut dropout = Dropout::new(0.5);
let x = Tensor::ones(&[10, 10]);

dropout.train();
let y_train = dropout.forward(&x);  // ~50% zeros, rest scaled by 2

dropout.eval();
let y_eval = dropout.forward(&x);   // same as input

Implementations§

Source§

impl Dropout

Source

pub fn new(p: f32) -> Self

Create a new Dropout layer.

§Arguments
  • p - Probability of element being zeroed (must be in [0, 1))
§Panics

Panics if p is not in [0, 1).

Source

pub fn with_seed(p: f32, seed: u64) -> Self

Create a new Dropout layer with a specific seed for reproducibility.

Source

pub fn probability(&self) -> f32

Get the dropout probability.

Trait Implementations§

Source§

impl Debug for Dropout

Source§

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

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

impl Module for Dropout

Source§

fn forward(&self, input: &Tensor) -> Tensor

Forward pass with dropout.

§Panics

Panics if the RNG mutex is poisoned (indicates prior thread panic - unrecoverable). This is acceptable per Toyota Way: mutex poisoning means the system is already in a catastrophic state from a prior panic.

Source§

fn train(&mut self)

Set the module to training mode. Read more
Source§

fn eval(&mut self)

Set the module to evaluation mode. Read more
Source§

fn training(&self) -> bool

Check if the module is in training mode.
Source§

fn parameters(&self) -> Vec<&Tensor>

Get references to all learnable parameters. Read more
Source§

fn parameters_mut(&mut self) -> Vec<&mut Tensor>

Get mutable references to all learnable parameters. Read more
Source§

fn refresh_caches(&mut self)

Refresh any cached computations after parameters have been modified. Read more
Source§

fn zero_grad(&mut self)

Zero out gradients for all parameters. Read more
Source§

fn num_parameters(&self) -> usize

Get the number of learnable parameters.

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V