bunsen 0.21.0

bunsen is acceleration tooling for burn
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

use burn::optim::LearningRate;
use hashbrown::HashMap;

/// Selection function for learning rates.
pub trait LrSelector: Send + Sync {
    /// Select the learning rate for this group.
    fn select(
        &self,
        lr: LearningRate,
        named_lrs: &HashMap<String, LearningRate>,
    ) -> LearningRate;
}

impl<F> LrSelector for F
where
    F: Fn(LearningRate, &HashMap<String, LearningRate>) -> LearningRate + Send + Sync,
{
    fn select(
        &self,
        lr: LearningRate,
        named_lrs: &HashMap<String, LearningRate>,
    ) -> LearningRate {
        (self)(lr, named_lrs)
    }
}

/// Learning rate selector that always returns the given learning rate.
pub struct GlobalLrSelector;

impl LrSelector for GlobalLrSelector {
    fn select(
        &self,
        lr: LearningRate,
        _named_lrs: &HashMap<String, LearningRate>,
    ) -> LearningRate {
        lr
    }
}

/// [`LrSelector`] that always selects a fixed learning rate.
pub struct FixedLrSelector {
    lr: LearningRate,
}

impl FixedLrSelector {
    /// Create a new selector.
    pub fn new(lr: LearningRate) -> Self {
        Self { lr }
    }

    /// Get the fixed learning rate.
    pub fn lr(&self) -> LearningRate {
        self.lr
    }
}

impl LrSelector for FixedLrSelector {
    fn select(
        &self,
        _lr: LearningRate,
        _named_lrs: &HashMap<String, LearningRate>,
    ) -> LearningRate {
        self.lr
    }
}

impl LrSelector for NamedLrSelector {
    fn select(
        &self,
        _lr: LearningRate,
        named_lrs: &HashMap<String, LearningRate>,
    ) -> LearningRate {
        *named_lrs
            .get(&self.name)
            .unwrap_or_else(|| panic!("No learning rate for {}", self.name))
    }
}

/// [`LrSelector`] that always selects a given key.
pub struct NamedLrSelector {
    name: String,
}

impl NamedLrSelector {
    /// Create a new selector.
    pub fn new(name: String) -> Self {
        Self { name }
    }

    /// Get the name of the learning rate.
    pub fn name(&self) -> &str {
        &self.name
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use super::*;

    #[test]
    fn test_fn_selector_impl() {
        let selector: Arc<dyn LrSelector> = Arc::new(
            |lr: LearningRate, named_lrs: &HashMap<String, LearningRate>| lr + named_lrs["foo"],
        );
        let lrs: HashMap<String, LearningRate> = [("foo".to_string(), 0.5)].into_iter().collect();

        assert_eq!(selector.select(1.0, &lrs), 1.5);
    }

    #[test]
    fn test_global_selector() {
        let selector = GlobalLrSelector;
        assert_eq!(selector.select(0.0, &HashMap::new()), 0.0);
    }

    #[test]
    fn test_fixed_selector() {
        let selector = FixedLrSelector::new(0.01);
        assert_eq!(selector.select(0.0, &HashMap::new()), 0.01);
    }

    #[test]
    fn test_named_selector() {
        let selector = NamedLrSelector::new("foo".to_string());
        let lrs: HashMap<String, LearningRate> = [("foo".to_string(), 0.5)].into_iter().collect();

        assert_eq!(selector.select(0.0, &lrs), 0.5);
    }
}