PullbackPlan

Struct PullbackPlan 

Source
pub struct PullbackPlan<V: Differentiable> { /* private fields */ }
Expand description

Compiled pullback execution plan.

§Examples

let plan = chainrules::PullbackPlan::<MyType>::build(&loss).unwrap();

Implementations§

Source§

impl<V: Differentiable> PullbackPlan<V>

Source

pub fn build(_loss: &TrackedTensor<V>) -> AdResult<Self>

Builds a pullback plan from a loss value.

§Examples
let plan = chainrules::PullbackPlan::build(&loss).unwrap();
Source

pub fn execute(&self, _loss: &TrackedTensor<V>) -> AdResult<Gradients<V>>

Executes the pre-built pullback plan.

§Examples
let grads = plan.execute(&loss).unwrap();
Source

pub fn loss_node(&self) -> NodeId

Returns loss node ID for this plan.

§Examples
use chainrules::{PullbackPlan, NodeId};
let _id_fn: fn(&PullbackPlan<f64>) -> NodeId = PullbackPlan::loss_node;

Trait Implementations§

Source§

impl<V: Clone + Differentiable> Clone for PullbackPlan<V>

Source§

fn clone(&self) -> PullbackPlan<V>

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<V: Debug + Differentiable> Debug for PullbackPlan<V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V> Freeze for PullbackPlan<V>

§

impl<V> RefUnwindSafe for PullbackPlan<V>
where V: RefUnwindSafe,

§

impl<V> Send for PullbackPlan<V>
where V: Send,

§

impl<V> Sync for PullbackPlan<V>
where V: Sync,

§

impl<V> Unpin for PullbackPlan<V>
where V: Unpin,

§

impl<V> UnwindSafe for PullbackPlan<V>
where V: 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> 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> 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<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.