use std::fmt::Debug;
use burn::{
Tensor,
module::Module,
};
use dyn_clone::DynClone;
fn row_max(x: Tensor<3>) -> Tensor<1> {
x.max_dims(&[1, 2]).reshape([-1])
}
pub trait StreamClampPolicy: Send + Sync + Debug + DynClone {
fn observe(
&mut self,
frames: Tensor<3>,
);
fn reference(
&self,
window: Tensor<3>,
) -> Tensor<1>;
}
dyn_clone::clone_trait_object!(<> StreamClampPolicy);
impl StreamClampPolicy for Box<dyn StreamClampPolicy> {
fn observe(
&mut self,
frames: Tensor<3>,
) {
(**self).observe(frames);
}
fn reference(
&self,
window: Tensor<3>,
) -> Tensor<1> {
(**self).reference(window)
}
}
#[derive(Debug, Default, Clone, Copy)]
pub struct PerWindow;
impl StreamClampPolicy for PerWindow {
fn observe(
&mut self,
_frames: Tensor<3>,
) {
}
fn reference(
&self,
window: Tensor<3>,
) -> Tensor<1> {
row_max(window)
}
}
#[derive(Module, Debug)]
pub struct RunningMaxClamp {
seen: Option<Tensor<1>>,
}
impl Default for RunningMaxClamp {
fn default() -> Self {
Self::new()
}
}
impl RunningMaxClamp {
pub fn new() -> Self {
Self { seen: None }
}
pub fn seen(&self) -> Option<&Tensor<1>> {
self.seen.as_ref()
}
}
impl StreamClampPolicy for RunningMaxClamp {
fn observe(
&mut self,
frames: Tensor<3>,
) {
if frames.dims()[1] == 0 {
return;
}
let arriving = row_max(frames);
self.seen = Some(match self.seen.take() {
Some(seen) => seen.max_pair(arriving),
None => arriving,
});
}
fn reference(
&self,
window: Tensor<3>,
) -> Tensor<1> {
let own = row_max(window);
match &self.seen {
Some(seen) => seen.clone().max_pair(own),
None => own,
}
}
}
#[cfg(test)]
mod tests {
use burn::prelude::TensorData;
use super::*;
use crate::support::testing::{
assert_close_to_vec,
cpu_device,
};
fn frames(values: [f64; 8]) -> Tensor<3> {
Tensor::from_data(TensorData::new(values.to_vec(), [2, 2, 2]), &cpu_device())
}
fn to_vec(t: Tensor<1>) -> Vec<f64> {
t.into_data().try_into_vec_as::<f64>().unwrap()
}
#[test]
fn test_per_window_is_each_rows_own_maximum() {
let mut policy = PerWindow;
let window = frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]);
StreamClampPolicy::observe(&mut policy, frames([99.0; 8]));
assert_close_to_vec(&to_vec(policy.reference(window)), &[0.0, 5.0], 1e-12);
}
#[test]
fn test_max_seen_runs_over_observations() {
let mut policy = RunningMaxClamp::new();
assert!(policy.seen().is_none());
policy.observe(frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]));
assert_close_to_vec(&to_vec(policy.seen().unwrap().clone()), &[0.0, 5.0], 1e-12);
policy.observe(frames([7.0, -3.0, -1.0, -20.0, -5.0, -4.0, -9.0, -1.0]));
assert_close_to_vec(&to_vec(policy.seen().unwrap().clone()), &[7.0, 5.0], 1e-12);
let quiet = frames([-10.0; 8]);
assert_close_to_vec(&to_vec(policy.reference(quiet)), &[7.0, 5.0], 1e-12);
let loud = frames([-10.0, -10.0, -10.0, -10.0, 9.0, -10.0, -10.0, -10.0]);
assert_close_to_vec(&to_vec(policy.reference(loud)), &[7.0, 9.0], 1e-12);
}
#[test]
fn test_max_seen_ignores_an_empty_chunk() {
let mut policy = RunningMaxClamp::new();
policy.observe(Tensor::zeros([2, 0, 2], &cpu_device()));
assert!(policy.seen().is_none());
policy.observe(frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]));
policy.observe(Tensor::zeros([2, 0, 2], &cpu_device()));
assert_close_to_vec(&to_vec(policy.seen().unwrap().clone()), &[0.0, 5.0], 1e-12);
}
#[test]
fn test_max_seen_degrades_to_per_window() {
let policy = RunningMaxClamp::new();
let window = frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]);
assert_close_to_vec(
&to_vec(policy.reference(window.clone())),
&to_vec(PerWindow.reference(window)),
1e-12,
);
}
#[test]
fn test_reference_does_not_move() {
let mut policy = RunningMaxClamp::new();
policy.observe(frames([1.0; 8]));
let window = frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]);
let first = to_vec(policy.reference(window.clone()));
let second = to_vec(policy.reference(window));
assert_eq!(first, second);
assert_close_to_vec(&to_vec(policy.seen().unwrap().clone()), &[1.0, 1.0], 1e-12);
}
#[test]
fn test_trait_object() {
let window = frames([0.0, -3.0, -1.0, -20.0, 5.0, 4.0, -9.0, 1.0]);
let mut policies: Vec<Box<dyn StreamClampPolicy>> =
vec![Box::new(PerWindow), Box::new(RunningMaxClamp::new())];
for policy in policies.iter_mut() {
policy.observe(window.clone());
assert_close_to_vec(
&to_vec(policy.reference(window.clone())),
&[0.0, 5.0],
1e-12,
);
assert!(!format!("{policy:?}").is_empty());
let mut copy = policy.clone();
copy.observe(frames([50.0; 8]).clone());
assert_close_to_vec(
&to_vec(policy.reference(window.clone())),
&[0.0, 5.0],
1e-12,
);
assert!(to_vec(copy.reference(window.clone()))[0] >= 0.0);
}
}
}