Skip to main content

ParameterUpdate

trustformers_optim::common

Struct ParameterUpdate

pub struct ParameterUpdate;

Expand description

Common parameter update operations.

Implementations§

impl ParameterUpdate

pub fn apply_l2_regularization(grad: f32, param: f32, weight_decay: f32) -> f32

Applies weight decay to gradients (L2 regularization).

§Arguments

grad - The gradient value
param - The parameter value
weight_decay - The weight decay coefficient

pub fn apply_decoupled_weight_decay(param: &mut f32, lr: f32, weight_decay: f32)

Applies decoupled weight decay directly to parameter.

§Arguments

param - The parameter value to update
lr - The learning rate
weight_decay - The weight decay coefficient

pub fn adam_update(param: &mut f32, lr: f32, m_hat: f32, v_hat: f32, eps: f32)

Updates parameter using Adam-style formula.

§Arguments

param - The parameter to update
lr - Learning rate
m_hat - Bias-corrected first moment
v_hat - Bias-corrected second moment
eps - Epsilon for numerical stability

pub fn sgd_momentum_update(param: &mut f32, lr: f32, momentum: f32)

Updates parameter using SGD with momentum.

§Arguments

param - The parameter to update
lr - Learning rate
momentum - Momentum buffer value

pub fn update_sgd_momentum( momentum: &mut f32, grad: f32, momentum_coeff: f32, dampening: f32, nesterov: bool, ) -> f32

Updates momentum buffer for SGD.

§Arguments

momentum - The momentum buffer to update
grad - The gradient
momentum_coeff - Momentum coefficient (typically 0.9)
dampening - Dampening factor (typically 0.0)
nesterov - Whether to use Nesterov momentum

pub fn update_ema(ema: &mut f32, value: f32, beta: f32)

Updates exponential moving average (for Adam-style methods).

§Arguments

ema - The exponential moving average to update
value - The new value
beta - The decay coefficient

Auto Trait Implementations§

impl Freeze for ParameterUpdate

impl RefUnwindSafe for ParameterUpdate

impl Send for ParameterUpdate

impl Sync for ParameterUpdate

impl Unpin for ParameterUpdate

impl UnwindSafe for ParameterUpdate

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more