Enum DiffMode

source

pub enum DiffMode {
    Error,
    Source,
    Forward,
    Reverse,
    ForwardFirst,
    ReverseFirst,
}

Expand description

Forward and Reverse Mode are well known names for automatic differentiation implementations. Enzyme does support both, but with different semantics, see DiffActivity. The First variants are a hack to support higher order derivatives. We need to compute first order derivatives before we compute second order derivatives, otherwise we would differentiate our placeholder functions. The proper solution is to recognize and resolve this DAG of autodiff invocations, as it’s already done in the C++ and Julia frontend of Enzyme.

(FIXME) remove *First variants. Documentation for using reverse and forward mode is available online.

Variants§

§

Error

No autodiff is applied (used during error handling).

§

Source

The primal function which we will differentiate.

§

Forward

The target function, to be created using forward mode AD.

§

Reverse

The target function, to be created using reverse mode AD.

§

ForwardFirst

The target function, to be created using forward mode AD. This target function will also be used as a source for higher order derivatives, so compute it before all Forward/Reverse targets and optimize it through llvm.

§

ReverseFirst

The target function, to be created using reverse mode AD. This target function will also be used as a source for higher order derivatives, so compute it before all Forward/Reverse targets and optimize it through llvm.

Enum DiffModeCopy item path

Variants§

Error

Source

Forward

Reverse

ForwardFirst

ReverseFirst

Implementations§

impl DiffMode

pub fn is_rev(&self) -> bool

pub fn is_fwd(&self) -> bool

Trait Implementations§

impl Clone for DiffMode

fn clone(&self) -> DiffMode

fn clone_from(&mut self, source: &Self)

impl Debug for DiffMode

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

impl<__D: SpanDecoder> Decodable<__D> for DiffMode

fn decode(__decoder: &mut __D) -> Self

impl Display for DiffMode

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

impl<__E: SpanEncoder> Encodable<__E> for DiffMode

fn encode(&self, __encoder: &mut __E)

impl FromStr for DiffMode

type Err = ()

fn from_str(s: &str) -> Result<DiffMode, ()>

impl<__CTX> HashStable<__CTX> for DiffModewhere __CTX: HashStableContext,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl PartialEq for DiffMode

fn eq(&self, other: &DiffMode) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Copy for DiffMode

impl Eq for DiffMode

impl StructuralPartialEq for DiffMode

Auto Trait Implementations§

impl DynSend for DiffMode

impl DynSync for DiffMode

impl Freeze for DiffMode

impl RefUnwindSafe for DiffMode

impl Send for DiffMode

impl Sync for DiffMode

impl Unpin for DiffMode

impl UnwindSafe for DiffMode

Blanket Implementations§

impl<T> Aligned for T

const ALIGN: Alignment = _

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize = _

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Same for T

type Output = T

Enum DiffMode

impl<D: SpanDecoder> Decodable<D> for DiffMode

fn decode(decoder: &mut D) -> Self

impl<E: SpanEncoder> Encodable<E> for DiffMode

fn encode(&self, encoder: &mut E)

impl<CTX> HashStable<CTX> for DiffMode
where __CTX: HashStableContext,

fn hash_stable(&self, hcx: &mut CTX, __hasher: &mut StableHasher)

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T> ToString for T
where T: Display + ?Sized,

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

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

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

impl<'a, T> Captures<'a> for T
where T: ?Sized,