Struct Softmax

pub struct Softmax {
    pub axis: i32,
}

Applies the Softmax function.

This is:

softmax(&x, None, None)

Fields

axis: i32

The axis to apply the softmax.

Implementations

impl Softmax

pub fn new() -> Self

Creates a new instance of Softmax.

impl Softmax

pub const DEFAULT_AXIS: i32 = -1i32

The default axis value.

Trait Implementations

impl Buildable for Softmax

type Builder = SoftmaxBuilder

The builder type for this buildable type

impl Builder<Softmax> for SoftmaxBuilder

type Error = Infallible

Error with building

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

Build the type

impl Clone for Softmax

fn clone(&self) -> Softmax

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Softmax

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

Formats the value using the given formatter.

impl Module<&Array> for Softmax

type Error = Exception

Error type for the module.

type Output = Array

Output type of the module.

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

Forward pass of the module.

fn training_mode(&mut self, _: bool)

Set whether the module is in training mode.

impl ModuleParameters for Softmax

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.