flodl 0.2.1

floDl — a flow-graph deep learning framework built on libtorch
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

use std::rc::Rc;

use crate::autograd::Variable;
use crate::nn::{Linear, Module};
use crate::tensor::{Device, Result, Tensor};

/// Threshold-based halt condition for Loop.While / Loop.Until.
///
/// Signals halt (positive output) when the maximum element of the state
/// exceeds the threshold.
///
/// ```ignore
/// FlowBuilder::from(body)
///     .loop_body(body).until_cond(ThresholdHalt::new(50.0), 20)
/// ```
pub struct ThresholdHalt {
    threshold: f32,
}

impl ThresholdHalt {
    /// Create a halt condition that triggers when max(state) > `threshold`.
    pub fn new(threshold: f32) -> Self {
        ThresholdHalt { threshold }
    }
}

impl Module for ThresholdHalt {
    fn name(&self) -> &str { "threshold_halt" }

    fn forward(&self, input: &Variable) -> Result<Variable> {
        let data = input.data().to_f32_vec()?;
        let max_val = data
            .iter()
            .copied()
            .fold(f32::NEG_INFINITY, f32::max);
        let val = max_val - self.threshold; // positive when exceeded → halt
        Ok(Variable::new(
            Tensor::from_f32(&[val], &[1], input.device())?,
            false,
        ))
    }
}

/// Learnable halt condition (Adaptive Computation Time / ACT pattern).
///
/// A linear probe projects the state to a scalar — iteration stops when
/// the output is positive. Fully differentiable.
///
/// ```ignore
/// FlowBuilder::from(body)
///     .loop_body(body).until_cond(LearnedHalt::new(hidden_dim)?, 20)
/// ```
pub struct LearnedHalt {
    proj: Rc<Linear>,
}

impl LearnedHalt {
    /// Create a learned halt probe projecting `input_dim` to a scalar on CPU.
    pub fn new(input_dim: i64) -> Result<Self> {
        Self::on_device(input_dim, Device::CPU)
    }

    /// Create a learned halt probe on the specified device.
    pub fn on_device(input_dim: i64, device: Device) -> Result<Self> {
        Ok(LearnedHalt {
            proj: Rc::new(Linear::on_device(input_dim, 1, device)?),
        })
    }
}

impl Module for LearnedHalt {
    fn name(&self) -> &str { "learned_halt" }

    fn forward(&self, input: &Variable) -> Result<Variable> {
        self.proj.forward(input)
    }

    fn sub_modules(&self) -> Vec<Rc<dyn Module>> {
        vec![self.proj.clone()]
    }
}