tidu 0.2.0

Automatic-differentiation transforms (linearize, transpose, eager reverse-mode) for primitive computation graphs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use std::hash::Hash;

/// Unique identifier for a [`crate::linearize`] call.
pub type DiffPassId = u64;

/// Constraint on `GraphOperation::InputKey` for AD use.
///
/// `tidu` uses this trait to generate tangent input keys during
/// [`crate::linearize`].
///
/// # Examples
///
/// ```
/// use tidu::{ADKey, DiffPassId};
///
/// #[derive(Clone, Debug, PartialEq, Eq, Hash)]
/// enum MyKey {
///     User(String),
///     Tangent { of: Box<MyKey>, pass: DiffPassId },
/// }
///
/// impl ADKey for MyKey {
///     fn tangent_of(&self, pass: DiffPassId) -> Self {
///         MyKey::Tangent {
///             of: Box::new(self.clone()),
///             pass,
///         }
///     }
/// }
/// ```
pub trait ADKey: Clone + std::fmt::Debug + Hash + Eq + Send + Sync + 'static {
    /// Create a tangent input key derived from this key.
    /// `pass` is a unique identifier for the `linearize` call.
    fn tangent_of(&self, pass: DiffPassId) -> Self;
}