candle-graph 0.9.0

TensorFlow Profiler-style execution graphs for candle-rs (trace-only)
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

//! Constant-cost capture selection for keeping instrumentation off the hot path.

/// Select exactly one one-based workload invocation for profiling.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CaptureSelector {
    selected_invocation: u64,
}

impl CaptureSelector {
    pub fn new(selected_invocation: u64) -> anyhow::Result<Self> {
        anyhow::ensure!(
            selected_invocation > 0,
            "selected capture invocation must be one-based"
        );
        Ok(Self {
            selected_invocation,
        })
    }

    #[inline]
    pub fn is_selected(self, invocation: u64) -> bool {
        invocation == self.selected_invocation
    }

    pub fn selected_invocation(self) -> u64 {
        self.selected_invocation
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn selects_only_the_configured_one_based_invocation() {
        let selector = CaptureSelector::new(3).unwrap();
        assert!(!selector.is_selected(2));
        assert!(selector.is_selected(3));
        assert!(!selector.is_selected(4));
        assert!(CaptureSelector::new(0).is_err());
    }
}