Struct burn::backend::autodiff::ops::OpsPrep

pub struct OpsPrep<Backward, B, S, C, const N: usize, Mode = Init> { /* private fields */ }
Expand description

Operation in preparation.

Each mode has its own set of functions to minimize cloning for unused backward states.

Implementations§

§

impl<Backward, B, S, C, const N: usize, Mode> OpsPrep<Backward, B, S, C, N, Mode>

pub fn new( nodes: [Arc<Node>; N], requirement: Requirement, backward: Backward, compute_property: ComputingProperty, checkpointer_builder: CheckpointerBuilder, ) -> OpsPrep<Backward, B, S, C, N, Mode>

Constructs a new OpsPrep.

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N>
where B: Backend, BO: Backward<B, N, State = S>,

pub fn compute_bound(self) -> OpsPrep<BO, B, S, C, N, ComputePropertyDone>

Indicates that the operation is compute bound, meaning its computation is heavy and should not be recomputed

pub fn memory_bound(self) -> OpsPrep<BO, B, S, C, N, MemoryBound>

Indicates that the operation is memory bound, meaning its computation is light and can be recomputed

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N, MemoryBound>
where B: Backend, BO: Backward<B, N, State = S>, C: CheckpointStrategy,

pub fn retro_forward<R>( self, retro_forward: R, ) -> OpsPrep<BO, B, S, C, N, MemoryBoundRetroForward>
where R: RetroForward,

Registers the retro forward, if needed

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N, MemoryBoundRetroForward>
where B: Backend, BO: Backward<B, N, State = S>, C: CheckpointStrategy,

pub fn parents<'a, B2, A>( self, parents: A, ) -> OpsPrep<BO, B, S, C, N, ComputePropertyDone>
where B2: Backend, A: IntoIterator<Item = &'a AutodiffTensor<B2>>,

Checkpoints the parents, if needed

§

impl<BO, B, C, const N: usize> OpsPrep<BO, B, (), C, N, ComputePropertyDone>
where B: Backend, BO: Backward<B, N, State = ()>,

pub fn stateless( self, output: <B as Backend>::FloatTensorPrimitive, ) -> AutodiffTensor<B>

Prepare a stateless operation.

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N, ComputePropertyDone>
where B: Backend, S: Clone + Send + Debug + 'static, BO: Backward<B, N, State = S>,

pub fn stateful(self) -> OpsKind<BO, B, S, C, N>

Prepare an operation that requires a state during the backward pass.

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N, UnTracked>
where B: Backend, S: Clone + Send + Debug + 'static, BO: Backward<B, N, State = S>,

pub fn finish( self, output: <B as Backend>::FloatTensorPrimitive, ) -> AutodiffTensor<B>

Finish the preparation of an untracked operation and returns the output tensor.

§

impl<BO, B, S, C, const N: usize> OpsPrep<BO, B, S, C, N, Tracked>
where B: Backend, S: Clone + Send + Debug + 'static, BO: Backward<B, N, State = S>,

pub fn finish( self, state: S, output: <B as Backend>::FloatTensorPrimitive, ) -> AutodiffTensor<B>

Finish the preparation of a tracked operation and returns the output tensor.

pub fn checkpoint(&mut self, tensor: &AutodiffTensor<B>) -> NodeID

Checkpoints the tensor

Auto Trait Implementations§

§

impl<Backward, B, S, C, const N: usize, Mode> Freeze for OpsPrep<Backward, B, S, C, N, Mode>
where Backward: Freeze,

§

impl<Backward, B, S, C, const N: usize, Mode = Init> !RefUnwindSafe for OpsPrep<Backward, B, S, C, N, Mode>

§

impl<Backward, B, S, C, const N: usize, Mode> Send for OpsPrep<Backward, B, S, C, N, Mode>
where Backward: Send, C: Send, B: Send, S: Send, Mode: Send,

§

impl<Backward, B, S, C, const N: usize, Mode = Init> !Sync for OpsPrep<Backward, B, S, C, N, Mode>

§

impl<Backward, B, S, C, const N: usize, Mode> Unpin for OpsPrep<Backward, B, S, C, N, Mode>
where Backward: Unpin, C: Unpin, B: Unpin, S: Unpin, Mode: Unpin,

§

impl<Backward, B, S, C, const N: usize, Mode = Init> !UnwindSafe for OpsPrep<Backward, B, S, C, N, Mode>

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.
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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

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

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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
§

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

§

impl<T> WasmNotSend for T
where T: Send,