Struct Dropout

pub struct Dropout {
    pub one_minus_p: f32,
    pub training: bool,
}

Randomly zero a portion of the elements during training.

The remaining elements are multiplied with 1 / (1-p) where p is the probability of zeroing an element. This is done so the expected value of a given element will remain the same.

Fields

one_minus_p: f32

1-p, where p is the probability of zeroing an element. p is default to Dropout::DEFAULT_P if not specified.

training: bool

Whether the layer is in training mode. Default to Dropout::DEFAULT_TRAINING if not specified.

Implementations

impl Dropout

pub fn new() -> Self

Creates a new instance of Dropout.

impl Dropout

pub const DEFAULT_P: f32 = 0.5f32

Default value for the probability of zeroing an element.

pub const DEFAULT_TRAINING: bool = true

Default value for the training mode.

Trait Implementations

impl Buildable for Dropout

type Builder = DropoutBuilder

The builder type for this buildable type

impl Builder<Dropout> for DropoutBuilder

type Error = DropoutBuildError

Error with building

fn build(self) -> Result<Dropout, Self::Error>

Build the type

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 Module<&Array> for Dropout

type Error = Exception

Error type for the module.

type Output = Array

Output type of the module.

fn forward(&mut self, x: &Array) -> Result<Array, Self::Error>

Forward pass of the module.

fn training_mode(&mut self, mode: bool)

Set whether the module is in training mode.

impl ModuleParameters for Dropout

fn freeze_parameters(&mut self, recursive: bool)

Freeze all parameters in the module.

fn unfreeze_parameters(&mut self, recursive: bool)

Unfreeze all parameters in the module.

fn parameters(&self) -> ModuleParamRef<'_>

Get references to the module parameters.

fn parameters_mut(&mut self) -> ModuleParamMut<'_>

Get mutable references to the module parameters.

fn trainable_parameters(&self) -> ModuleParamRef<'_>

Get references to the trainable parameters. A parameter is trainable if it is NOT frozen.

fn all_frozen(&self) -> Option<bool>

Check if all parameters in the module are frozen. Returns None if there are no parameters.

fn any_frozen(&self) -> Option<bool>

Check if any parameter in the module is frozen. Returns None if there are no parameters.

fn update(&mut self, parameters: ModuleParam)

Update the module parameters.

fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)

Update the module parameters from a flattened representation.