Struct Softmax

Source
pub struct Softmax(pub f32);
Expand description

A softmax activation layer with no trainable parameters.

Tuple Fields§

§0: f32

Trait Implementations§

Source§

impl Clone for Softmax

Source§

fn clone(&self) -> Softmax

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Softmax

Source§

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

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

impl Default for Softmax

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl LoadableModule for Softmax

Source§

fn save( &self, _path: String, _dict: &mut HashMap<String, Vec<f64>>, ) -> Result<(), LoadSaveError>

Saves the parameters to the given dictionary. Read more
Source§

fn load( &mut self, _path: String, _dict: &HashMap<String, Vec<f64>>, ) -> Result<(), LoadSaveError>

Loads the parameters from the given dictionary. Read more
Source§

impl<E: Float, const I: usize> Module<[E; I]> for Softmax

Source§

type Output = [E; I]

The type that this unit produces given Input.
Source§

fn forward(&self, x: &[E; I]) -> Result<Self::Output, Error>

Source§

impl ResetParams for Softmax

Source§

fn rand_params<RNG: Rng>( &mut self, _rng: &mut RNG, _scale: f32, ) -> Result<(), Error>

Sensibly initializes the learnable parameters of some module. Read more
Source§

impl<E: Float, const I: usize> RevModule<[E; I]> for Softmax

Source§

type SelfGrads = ()

The type describing gradients with respect to the modules’ own parameters.
Source§

fn reverse( &self, inputs: &[E; I], grads_wrt_output: &[E; I], ) -> ([E; I], Self::SelfGrads)

Returns the gradients with respect to the input, and the gradients with respect to any internal parameters.
Source§

fn apply( &mut self, _applyer: &mut impl GradApplyer, _updates: Self::SelfGrads, ) -> Result<(), Error>

Applies a gradient update step: adding product of the provided gradients and the scalar to the parameters.
Source§

impl VisualizableUnit for Softmax

Source§

const KIND: &'static str = "softmax"

Source§

type Params = ()

Source§

fn params(&self) -> &Self::Params

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<Input, M> BackpropModule<Input> for M
where M: TracedModule<Input, Trace = Input> + RevModule<Input> + BaseModule,

Source§

type SelfGrads = <M as RevModule<Input>>::SelfGrads

Type describing movement in the modules’ own parameters in response to backpropagation.
Source§

fn backprop( &self, trace: &<M as TracedModule<Input>>::Trace, grads_wrt_output: <M as Module<Input>>::Output, ) -> (Input, <M as BackpropModule<Input>>::SelfGrads)

Computes gradients for this layer/module, given tracing state from forward execution, and the gradients of the output. Read more
Source§

fn update( &mut self, applyer: &mut impl GradApplyer, updates: <M as BackpropModule<Input>>::SelfGrads, ) -> Result<(), ()>

Applies a gradient update step, given (Self::SelfGrads) and a GradApplyer. Read more
Source§

fn new_momentum( &self, params: TrainParams, momentum_coefficient: f32, ) -> Momentum<Self::SelfGrads>
where <Self as BackpropModule<X>>::SelfGrads: Gradients,

Returns a GradApplyer object needed to train using SGD + momentum.
Source§

fn new_rmsprop( &self, params: TrainParams, beta: f32, ) -> RMSProp<Self::SelfGrads>
where <Self as BackpropModule<X>>::SelfGrads: Gradients, <Self::SelfGrads as Gradients>::Concrete: Float,

Returns a GradApplyer object needed to train using rmsprop.
Source§

fn new_rmsprop_with_momentum( &self, params: TrainParams, momentum_coefficient: f32, beta: f32, ) -> RMSProp<Self::SelfGrads>
where <Self as BackpropModule<X>>::SelfGrads: Gradients, <Self::SelfGrads as Gradients>::Concrete: Float,

Returns a GradApplyer object needed to train using rmsprop + momentum.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<Input, M> TracedModule<Input> for M
where M: Module<Input> + BaseModule,

Source§

type Trace = Input

The type that this unit produces to describe intermediate state. Read more
Source§

fn traced_forward( &self, x: Input, ) -> Result<(<M as Module<Input>>::Output, <M as TracedModule<Input>>::Trace), ()>

Same as Module::forward, except intermediate computations that are needed for backprop are returned.
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