briny_ai 0.4.1

A tiny & efficient AI inference engine
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Flexible tensor backends based on features and targets.

mod optim;
#[cfg(feature = "alloc")]
mod vec;

use core::marker::PhantomData;

#[cfg(not(feature = "dyntensor"))]
pub use tensor_optim::ConstTensorOps;
pub use tensor_optim::TensorOps;

use crate::nn::TensorFloat;

pub use self::optim::{Flatten, StaticShape, Tensor, TensorGrad};
#[cfg(feature = "alloc")]
pub use vec::VecTensor;

/// A trait mainly for converting `Tensor`s to `WithGrad`.
pub trait IntoWithGrad<T>: TensorGrad<T> + Sized {
    /// Wraps the tensor with a zero-initialized gradient.
    fn with_grad(self) -> WithGrad<Self, T> {
        WithGrad::new(self)
    }

    /// Defines a `self` with a gradient of `grad`.
    fn grad_of(self, grad: Self) -> WithGrad<Self, T> {
        let mut w = WithGrad::new(self);
        w.set_grad(grad);
        w
    }
}

impl<T: TensorGrad<U>, U> IntoWithGrad<U> for T {}

/// A container for tracking gradients of values (used in autograd).
///
/// Typically used as `WithGrad<f32>` or `WithGrad<f64>`.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord)]
pub struct WithGrad<T, U = TensorFloat> {
    value: T,
    grad: T,
    _marker: PhantomData<U>,
}

impl<T: TensorGrad<U>, U> WithGrad<T, U> {
    /// Creates a new `WithGrad`.
    ///
    /// The gradient is zeroed, whereas the value is initialized
    /// witht the data given.
    pub fn new(value: T) -> Self {
        let grad = value.zeros_like();
        Self {
            value,
            grad,
            _marker: PhantomData,
        }
    }

    /// Overwrites the gradient.
    pub fn set_grad(&mut self, grad: T) {
        self.grad = grad;
    }

    /// Get immutable references to the items.
    ///
    /// The gradient and the value are both immutable.
    pub const fn split(&self) -> (&T, &T) {
        (&self.value, &self.grad)
    }

    /// Get mutable references to the items.
    ///
    /// The gradient and the value are both mutable.
    pub const fn split_mut(&mut self) -> (&mut T, &mut T) {
        (&mut self.value, &mut self.grad)
    }

    /// Immutably singles out the gradient.
    pub const fn get_grad(&self) -> &T {
        &self.grad
    }

    /// Immutably singles out the value.
    pub const fn get_value(&self) -> &T {
        &self.value
    }

    /// Mutably singles out the gradient.
    pub const fn get_grad_mut(&mut self) -> &mut T {
        &mut self.grad
    }

    /// Mutably singles out the value.
    pub const fn get_value_mut(&mut self) -> &mut T {
        &mut self.value
    }

    /// Discards the gradient and moves out of the value.
    pub fn into_value(self) -> T {
        self.value
    }

    /// Discards the value and moves out of the gradient.
    pub fn into_grad(self) -> T {
        self.grad
    }
}