Struct GradientProcessor

Source

pub struct GradientProcessor<A: Float> { /* private fields */ }

Expand description

Gradient clipping processor

Implementations§

Source §

impl<A: Float + ScalarOperand + Debug> GradientProcessor<A>

Source

pub fn new() -> Self

Create a new gradient processor with default configuration

Source

pub fn with_config(config: GradientClipConfig<A>) -> Self

Create a new gradient processor with a specific configuration

Source

pub fn set_max_value(&mut self, value: A) -> &mut Self

Set max value clipping

Source

pub fn set_min_value(&mut self, value: A) -> &mut Self

Set min value clipping

Source

pub fn set_max_norm(&mut self, value: A) -> &mut Self

Set max L2 norm clipping

Source

pub fn set_max_l1_norm(&mut self, value: A) -> &mut Self

Set max L1 norm clipping

Source

pub fn set_centralization(&mut self, enabled: bool) -> &mut Self

Enable gradient centralization

Source

pub fn set_zero_threshold(&mut self, value: A) -> &mut Self

Set threshold for zeroing small gradients

Source

pub fn set_value_clip(&mut self, min: A, max: A) -> &mut Self

Set value clipping range

Source

pub fn set_norm_clip(&mut self, max_norm: A) -> &mut Self

Set norm clipping

Source

pub fn set_l1_norm_clip(&mut self, max_l1_norm: A) -> &mut Self

Set L1 norm clipping

Source

pub fn enable_centralization(&mut self) -> &mut Self

Enable gradient centralization

Source

pub fn process<D: Dimension>(&self, gradients: &mut Array<A, D>) -> Result<()>

Process gradients according to configuration

Trait Implementations§

Source §

impl<A: Float + ScalarOperand + Debug> Default for GradientProcessor<A>

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl<A> UnwindSafe for GradientProcessor<A>
where A: UnwindSafe,

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