topos 0.13.1

An autodiff compiler stack in Rust.
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

use smallvec::smallvec;

use crate::{Element, Recordable, Shape, Tensor};

use super::{Cotangents, Operation, Reads, binary};

/// The elementwise maximum of two values, with operands `[left, right]`.
///
/// The gradient flows to whichever operand won each position, routed by
/// the 0/1 [`step`](Elementary::step) indicator. On a tie the left
/// operand takes the whole gradient rather than splitting it, so the two
/// cotangents always partition the incoming gradient.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct Maximum;

impl Maximum {
    /// Returns the arity: two operands.
    pub(crate) fn arity(&self) -> usize {
        2
    }

    /// Returns the read set of the derivative rule below.
    /// It reads both operands to mask the winners.
    pub(crate) fn reads(&self) -> Reads {
        Reads {
            operands: [true, true],
            output: false,
        }
    }

    /// Infers the shape of the result, which both operands must share.
    pub(crate) fn infer_shape(&self, operands: &[Shape]) -> Shape {
        let (left, right) = binary(operands);
        assert_eq!(left, right, "maximum requires operands of equal shapes");
        left.clone()
    }
}

impl Maximum {
    pub(crate) fn forward<E: Element>(&self, operands: &[&Tensor<E>]) -> Tensor<E> {
        let (&left, &right) = binary(operands);
        left.maximum(right)
    }
}

impl<Rule: Recordable> Operation<Rule> for Maximum {
    fn backward(&self, operands: &[&Rule], _output: &Rule, gradient: &Rule) -> Cotangents<Rule> {
        let (&left, &right) = binary(operands);
        let winners = left.step(right);
        let left_cotangent = gradient.clone() * winners.clone();
        let right_cotangent = gradient.clone() * (winners.one_like() - winners);
        smallvec![Some(left_cotangent), Some(right_cotangent)]
    }
}

#[cfg(test)]
#[path = "tests/maximum_tests.rs"]
mod tests;