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

/*
    Appellation: impl_model_layout <module>
    Created At: 2025.12.09:07:46:57
    Contrib: @FL03
*/
use super::ModelLayout;

use crate::models::{Deep, NetworkDepth, RawModelLayout, Shallow};

impl<F, D> ModelLayout<F, D>
where
    F: RawModelLayout,
    D: NetworkDepth,
{
    /// creates a new instance of [`ModelLayout`] using the given features
    pub const fn new(features: F) -> Self {
        Self {
            features,
            _marker: core::marker::PhantomData::<D>,
        }
    }
    /// returns a reference to the features of the model layout
    pub const fn features(&self) -> &F {
        &self.features
    }
    /// returns a mutable reference to the features of the model layout
    pub const fn features_mut(&mut self) -> &mut F {
        &mut self.features
    }
    /// returns a reference to the input of the model layout
    pub fn input(&self) -> usize {
        self.features().input()
    }
    /// returns a reference to the output of the model layout
    pub fn output(&self) -> usize {
        self.features().output()
    }
    /// returns a reference to the hidden features of the model layout
    pub fn hidden(&self) -> usize {
        self.features().hidden()
    }
    /// returns a reference to the depth, or number of hidden layers, of the model
    pub fn layers(&self) -> usize {
        self.features().depth()
    }
}

impl<F, D> core::ops::Deref for ModelLayout<F, D>
where
    F: RawModelLayout,
    D: NetworkDepth,
{
    type Target = F;

    fn deref(&self) -> &Self::Target {
        &self.features
    }
}

impl<F, D> core::ops::DerefMut for ModelLayout<F, D>
where
    F: RawModelLayout,
    D: NetworkDepth,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.features
    }
}

impl<F> ModelLayout<F, Deep>
where
    F: RawModelLayout,
{
    /// creates a new instance of [`ModelLayout`] using the given features
    pub const fn deep(features: F) -> Self {
        Self::new(features)
    }
}

impl<F> ModelLayout<F, Shallow>
where
    F: RawModelLayout,
{
    /// returns a new instance of the model layout using the given features and a shallow depth
    pub const fn shallow(features: F) -> Self {
        Self::new(features)
    }
}