concision-core 0.3.1

this crate implements the core modules for the concision framework
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

/*
    appellation: impl_layer_repr <module>
    authors: @FL03
*/
use crate::activate::{Activator, HyperbolicTangent, Linear, ReLU, Sigmoid};
use crate::nn::layer::LayerBase;
use concision_params::{ParamsBase, RawParams};
use ndarray::{ArrayBase, DataOwned, Dimension, RawData, RemoveAxis, ShapeBuilder};

impl<F, S, D, A> LayerBase<F, ArrayBase<S, D, A>>
where
    F: Activator<A, Output = A>,
    D: Dimension,
    S: RawData<Elem = A>,
{
    /// create a new instance from the given activation function and shape.
    pub fn from_rho_with_shape<Sh>(rho: F, shape: Sh) -> Self
    where
        A: Clone + Default,
        S: DataOwned,
        D: RemoveAxis,
        Sh: ShapeBuilder<Dim = D>,
    {
        Self {
            rho,
            params: ArrayBase::default(shape),
        }
    }

    pub fn dim(&self) -> D::Pattern {
        self.params().dim()
    }

    pub fn raw_dim(&self) -> D {
        self.params().raw_dim()
    }

    pub fn shape(&self) -> &[usize] {
        self.params().shape()
    }
}

impl<F, S, D, E, A> LayerBase<F, ParamsBase<S, D, A>>
where
    F: Activator<A, Output = A>,
    D: Dimension<Smaller = E>,
    E: Dimension<Larger = D>,
    S: RawData<Elem = A>,
{
    /// create a new layer from the given activation function and shape.
    pub fn from_rho_with_shape<Sh>(rho: F, shape: Sh) -> Self
    where
        A: Clone + Default,
        S: DataOwned,
        D: RemoveAxis,
        Sh: ShapeBuilder<Dim = D>,
    {
        Self {
            rho,
            params: ParamsBase::default(shape),
        }
    }

    pub const fn bias(&self) -> &ArrayBase<S, E, A> {
        self.params().bias()
    }

    pub const fn bias_mut(&mut self) -> &mut ArrayBase<S, E, A> {
        self.params_mut().bias_mut()
    }

    pub const fn weights(&self) -> &ArrayBase<S, D, A> {
        self.params().weights()
    }

    pub const fn weights_mut(&mut self) -> &mut ArrayBase<S, D, A> {
        self.params_mut().weights_mut()
    }

    pub fn dim(&self) -> D::Pattern {
        self.params().dim()
    }

    pub fn raw_dim(&self) -> D {
        self.params().raw_dim()
    }

    pub fn shape(&self) -> &[usize] {
        self.params().shape()
    }
}

impl<F, P, A> LayerBase<F, P>
where
    F: Fn(A) -> A,
    P: RawParams<Elem = A>,
{
}

impl<A, P> LayerBase<Linear, P>
where
    P: RawParams<Elem = A>,
{
    /// initialize a layer using the [`Linear`] activation function and the given params.
    pub const fn linear(params: P) -> Self {
        Self {
            rho: Linear,
            params,
        }
    }
}

impl<A, P> LayerBase<Sigmoid, P>
where
    P: RawParams<Elem = A>,
{
    /// initialize a layer using the [`Sigmoid`] activation function and the given params.
    pub const fn sigmoid(params: P) -> Self {
        Self {
            rho: Sigmoid,
            params,
        }
    }
}

impl<A, P> LayerBase<HyperbolicTangent, P>
where
    P: RawParams<Elem = A>,
{
    /// initialize a new layer using a [`TanhActivator`] activation function and the given
    /// parameters.
    pub const fn tanh(params: P) -> Self {
        Self {
            rho: HyperbolicTangent,
            params,
        }
    }
}

impl<A, P> LayerBase<ReLU, P>
where
    P: RawParams<Elem = A>,
{
    /// initialize a layer using the [`Sigmoid`] activation function and the given params.
    pub const fn relu(params: P) -> Self {
        Self { rho: ReLU, params }
    }
}