Gradients

Struct Gradients 

Source
pub struct Gradients<T> { /* private fields */ }
Expand description

The gradients computed by Var::backward.

Query individual gradients using get.

§Example

use autodiff::Tape;

let tape = Tape::new();
let x = tape.var(3.0);
let y = tape.var(4.0);
let z = x.clone() * y.clone();  // z = x * y

let grads = z.backward();
assert_eq!(grads.get(&x), 4.0);  // dz/dx = y
assert_eq!(grads.get(&y), 3.0);  // dz/dy = x

Implementations§

Source§

impl<T: Copy> Gradients<T>

Source

pub fn get(&self, var: &Var<T>) -> T

Returns the gradient with respect to the given variable.

Auto Trait Implementations§

§

impl<T> Freeze for Gradients<T>

§

impl<T> !RefUnwindSafe for Gradients<T>

§

impl<T> !Send for Gradients<T>

§

impl<T> !Sync for Gradients<T>

§

impl<T> Unpin for Gradients<T>

§

impl<T> !UnwindSafe for Gradients<T>

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<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, 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.