mushin 0.5.0

Computational graphs with reverse automatic differentation in the GPU
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! This module implements a pair of traits for `Variable` and `Constant` tensors
//! that are used at compile time to determine if the resulting tensor in a given
//! operation is going to be a `Variable` (tracked in the computation graph) or a
//! `Constant` (not tracked in the computation graph). As long as one of the
//! parameters is a `Variable` the resulting tensor is also a `Variable`.
//! Check the following tables for a complete overview:
//!
//! ## Single parameter operation
//! | Parameter |  Output  |
//! |-----------|----------|
//! | Variable  | Variable |
//! | Constant  | Constant |
//!
//! ## Double parameter operation
//! | First parameter | Second parameter |  Output  |
//! |-----------------|------------------|----------|
//! |     Variable    |      Variable    | Variable |
//! |     Variable    |      Constant    | Variable |
//! |     Constant    |      Variable    | Variable |
//! |     Constant    |      Constant    | Constant |

use arrayfire::Array;

use crate::graph::node::{BinaryReverseFn, Node, UnaryReverseFn};
use crate::tensor::{constant::Constant, variable::Variable};

/// Determines the output of single parameter operations (unary)
pub trait SingleParam<Y> {
    /// Creates a new tensor with the given result as data and pushes it to the computation graph (if required)
    fn push_unary(&self, result: Array<f32>, reverse: UnaryReverseFn) -> Y;
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
    > SingleParam<Variable<YB, YL, YR, YC>> for Variable<B, L, R, C>
{
    fn push_unary(&self, result: Array<f32>, reverse: UnaryReverseFn) -> Variable<YB, YL, YR, YC> {
        let node = Node::unary(result, self.into(), reverse);
        Variable::new(self.tape().clone(), node)
    }
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
    > SingleParam<Constant<YB, YL, YR, YC>> for Constant<B, L, R, C>
{
    fn push_unary(&self, result: Array<f32>, _reverse: UnaryReverseFn) -> Constant<YB, YL, YR, YC> {
        Constant::new(result)
    }
}

/// Determines the output of double parameter operations (binary)
pub trait DoubleParam<Y, Z> {
    /// Creates a new tensor with the given result as data and pushes it to the computation graph (if required)
    fn push_binary(&self, other: &Y, result: Array<f32>, reverse: BinaryReverseFn) -> Z;
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
        const ZB: u64,
        const ZL: u64,
        const ZR: u64,
        const ZC: u64,
    > DoubleParam<Variable<YB, YL, YR, YC>, Variable<ZB, ZL, ZR, ZC>> for Variable<B, L, R, C>
{
    fn push_binary(
        &self,
        other: &Variable<YB, YL, YR, YC>,
        result: Array<f32>,
        reverse: BinaryReverseFn,
    ) -> Variable<ZB, ZL, ZR, ZC> {
        let node = Node::binary_varvar(result, (self.into(), other.into()), reverse);
        Variable::new(self.tape().merge(other.tape()), node)
    }
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
        const ZB: u64,
        const ZL: u64,
        const ZR: u64,
        const ZC: u64,
    > DoubleParam<Constant<YB, YL, YR, YC>, Variable<ZB, ZL, ZR, ZC>> for Variable<B, L, R, C>
{
    fn push_binary(
        &self,
        other: &Constant<YB, YL, YR, YC>,
        result: Array<f32>,
        reverse: BinaryReverseFn,
    ) -> Variable<ZB, ZL, ZR, ZC> {
        let node = Node::binary_varconst(result, (self.into(), other.into()), reverse);
        Variable::new(self.tape().clone(), node)
    }
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
        const ZB: u64,
        const ZL: u64,
        const ZR: u64,
        const ZC: u64,
    > DoubleParam<Variable<YB, YL, YR, YC>, Variable<ZB, ZL, ZR, ZC>> for Constant<B, L, R, C>
{
    fn push_binary(
        &self,
        other: &Variable<YB, YL, YR, YC>,
        result: Array<f32>,
        reverse: BinaryReverseFn,
    ) -> Variable<ZB, ZL, ZR, ZC> {
        let node = Node::binary_constvar(result, (self.into(), other.into()), reverse);
        Variable::new(other.tape().clone(), node)
    }
}

impl<
        const B: u64,
        const L: u64,
        const R: u64,
        const C: u64,
        const YB: u64,
        const YL: u64,
        const YR: u64,
        const YC: u64,
        const ZB: u64,
        const ZL: u64,
        const ZR: u64,
        const ZC: u64,
    > DoubleParam<Constant<YB, YL, YR, YC>, Constant<ZB, ZL, ZR, ZC>> for Constant<B, L, R, C>
{
    fn push_binary(
        &self,
        _other: &Constant<YB, YL, YR, YC>,
        result: Array<f32>,
        _reverse: BinaryReverseFn,
    ) -> Constant<ZB, ZL, ZR, ZC> {
        Constant::new(result)
    }
}