Skip to main content

GradientTape

Struct GradientTape 

Source
pub struct GradientTape { /* private fields */ }
Expand description

Gradient tape for reverse-mode automatic differentiation.

§Usage

  1. Create a tape.
  2. Record operations during the forward pass using record_* methods. Each method returns an output tensor index.
  3. After computing the scalar loss, call backward with the gradient of the loss w.r.t. the output to accumulate gradients into all upstream tensors.

Implementations§

Source§

impl GradientTape

Source

pub fn new() -> Self

Create an empty tape.

Source

pub fn record_add(&mut self, a: usize, b: usize) -> usize

Record an elementwise add: out = tensors[a] + tensors[b].

Returns the output tensor index.

Source

pub fn record_mul( &mut self, a: usize, a_data: &Array1<f32>, b: usize, b_data: &Array1<f32>, ) -> usize

Record an elementwise multiply: out = tensors[a] * tensors[b].

a_data and b_data are the forward values saved for gradient computation (product rule).

Returns the output tensor index.

Source

pub fn record_matmul( &mut self, a: usize, a_mat: &Array2<f32>, b: usize, b_mat: &Array2<f32>, ) -> usize

Record a matrix-matrix multiply: out = A @ B (result flattened to 1-D).

Returns the output tensor index.

Source

pub fn record_silu(&mut self, input: usize, input_data: &Array1<f32>) -> usize

Record a SiLU activation: out = x * sigmoid(x).

input_data is the pre-activation tensor value.

Returns the output tensor index.

Source

pub fn record_layer_norm( &mut self, input: usize, mean: f32, var: f32, scale: &Array1<f32>, ) -> usize

Record a layer-norm operation.

Returns the output tensor index.

Source

pub fn record_ssm_scan( &mut self, input: usize, a_vals: &Array1<f32>, b_vals: &Array1<f32>, ) -> usize

Record a simplified SSM scan step.

Returns the output tensor index.

Source

pub fn backward( &self, loss_grad: Array1<f32>, tensors: &mut Vec<Array1<f32>>, ) -> ModelResult<()>

Run reverse-mode backpropagation.

§Parameters
  • loss_grad: gradient of the scalar loss w.r.t. the final output (shape must match the last recorded output).
  • tensors: gradient buffers, one Array1<f32> per allocated tensor slot. The caller is responsible for initialising these to zeros and ensuring tensors.len() >= self.num_tensors. After the call each buffer holds the accumulated gradient for that tensor slot.
§Errors

Returns ModelError::numerical_instability if any gradient contains NaN or Inf values.

Trait Implementations§

Source§

impl Default for GradientTape

Source§

fn default() -> Self

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

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<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> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,