topos 0.12.0

An autodiff compiler stack in Rust.
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

//! The plan card: the schedule as text, and its memory as a curve.
//!
//! This is the display the crate exists for. Eager frameworks hide the
//! graph and lazy ones hide the schedule; a plan card puts the whole
//! schedule in the cell output and draws the live volume beside it, so
//! what a pass costs is a picture rather than a claim.

use malevich::{Frame, Line, Plot, Theme};

use super::html;
use crate::{Element, Plan};

impl<E: Element> Plan<E> {
    /// Renders the plan as a self-contained HTML card: every scheduled
    /// node with its operation, shape, and liveness, then the live
    /// volume the analysis licenses, plotted along the schedule.
    ///
    /// Rendering is pure and deterministic for a given plan and theme.
    pub fn to_html(&self, theme: Theme) -> String {
        let schedule = html::dump_pre(&self.describe());
        let series: Vec<f64> = self
            .live_series()
            .iter()
            .map(|&elements| elements as f64)
            .collect();
        if series.len() < 2 {
            return html::card(theme, "plan", &schedule);
        }
        let mut frame = Frame::plain(72, 16);
        frame.theme = theme;
        let plot = Plot::new()
            .layer(Line::y(&series[..]).label("live"))
            .title("live volume (elements)")
            .x_label("scheduled node");
        let body = format!(
            "{schedule}<div style=\"margin-top:10px\">{}</div>",
            plot.to_html(&frame)
        );
        html::card(theme, "plan", &body)
    }

    /// Displays the plan when it is the last expression in an Evcxr
    /// cell.
    pub fn evcxr_display(&self) {
        html::show(&self.to_html(Theme::detect()), &self.describe());
    }
}

#[cfg(test)]
#[path = "tests/plan_tests.rs"]
mod tests;