custos 0.7.0

A minimal OpenCL, WGPU, CUDA and host CPU array manipulation 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

use core::{cell::RefCell, fmt::Debug};

use crate::{Cache, CacheReturn, Device, GlobalCount, Graph, GraphReturn, NodeIdx, PtrConv};

/// Provides several addons for a device.
/// - `graph`: An optimizeable graph.
/// - `cache`: A cache for allocations.
/// - `tape`: A (gradient) tape.
pub struct Addons<D: Device, IdxFrom: NodeIdx = GlobalCount> {
    /// An optimizeable graph.
    pub graph: RefCell<Graph<IdxFrom>>,
    /// A cache for allocations.
    pub cache: RefCell<Cache<D>>,
    /// A (gradient) tape.
    #[cfg(feature = "autograd")]
    pub tape: RefCell<crate::Tape<D>>,
}

impl<D: Device + Debug> Debug for Addons<D>
where
    D::Ptr<u8, ()>: Debug,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        #[cfg(feature = "autograd")]
        {
            f.debug_struct("Addons")
                .field("graph", &self.graph)
                .field("cache", &self.cache)
                .field("tape", &self.tape)
                .finish()
        }

        #[cfg(not(feature = "autograd"))]
        f.debug_struct("Addons")
            .field("graph", &self.graph)
            .field("cache", &self.cache)
            .finish()
    }
}

impl<D: Device + Default> Default for Addons<D>
where
    D::Ptr<u8, ()>: Default,
{
    fn default() -> Self {
        Self {
            graph: Default::default(),
            cache: Default::default(),
            #[cfg(feature = "autograd")]
            tape: Default::default(),
        }
    }
}

/// `AddonsReturn` is probably implemented for all devices that have an [`Addons`] field.
pub trait AddonsReturn: Device {
    /// Returns a reference to [`Addons`].
    fn addons(&self) -> &Addons<Self>;
}

impl<D: AddonsReturn> GraphReturn for D {
    #[inline]
    fn graph(&self) -> std::cell::Ref<Graph<GlobalCount>> {
        self.addons().graph.borrow()
    }

    #[inline]
    fn graph_mut(&self) -> std::cell::RefMut<Graph<GlobalCount>> {
        self.addons().graph.borrow_mut()
    }
}

impl<D: AddonsReturn> CacheReturn for D {
    #[inline]
    fn cache(&self) -> core::cell::Ref<crate::Cache<Self>>
    where
        Self: PtrConv,
    {
        self.addons().cache.borrow()
    }

    #[inline]
    fn cache_mut(&self) -> core::cell::RefMut<crate::Cache<Self>>
    where
        Self: PtrConv,
    {
        self.addons().cache.borrow_mut()
    }
}

#[cfg(feature = "autograd")]
impl<D: AddonsReturn> crate::TapeReturn for D {
    #[inline]
    fn tape(&self) -> core::cell::Ref<crate::Tape<Self>> {
        self.addons().tape.borrow()
    }

    #[inline]
    fn tape_mut(&self) -> core::cell::RefMut<crate::Tape<Self>> {
        self.addons().tape.borrow_mut()
    }
}