jyafn 0.3.1

Computational graphs for Data Science that compile to machine code
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

use std::collections::HashMap;
use std::io::{Read, Seek, Write};
use zip::write::SimpleFileOptions;

use crate::Error;

use super::{check, Graph};

impl Graph {
    /// Writes a binary representation of the graph to the supplied writer.
    pub fn dump<W: Write + Seek>(&self, writer: W) -> Result<(), Error> {
        let mut writer = zip::ZipWriter::new(writer);

        writer.start_file("graph", SimpleFileOptions::default())?;
        bincode::serialize_into(&mut writer, self).map_err(Error::Bincode)?;

        // This is the authoritative value of metadata. Why? Because it's easy to load without
        // bloating the memory.
        writer.start_file("metadata.json", SimpleFileOptions::default())?;
        serde_json::to_writer(&mut writer, &self.metadata).map_err(Error::Json)?;

        for (name, mapping) in &self.mappings {
            writer.start_file(format!("{name}.mapping"), SimpleFileOptions::default())?;
            writer.write_all(&mapping.dump())?;
        }

        for (name, resources) in &self.resources {
            writer.start_file(format!("{name}.resource"), SimpleFileOptions::default())?;
            writer.write_all(&resources.dump()?)?;
        }

        writer.finish()?;

        Ok(())
    }

    /// Loads only the metadata of a graph. This is quicker and takes less memory than
    /// loading the whole graph and reading its metadata.
    pub fn load_metadata<R: Read + Seek>(reader: R) -> Result<HashMap<String, String>, Error> {
        let mut archive = zip::ZipArchive::new(reader)?;
        let file = archive.by_name("metadata.json")?;
        let metadata: HashMap<String, String> =
            serde_json::from_reader(file).map_err(Error::Json)?;

        Ok(metadata)
    }

    /// Loads a graph in an unintialized state. This is quicker, since extra resources are
    /// not loader. However, you will not be able to compile the resulting graph.
    pub fn load_uninitialized<R: Read + Seek>(reader: R) -> Result<Self, Error> {
        let mut archive = zip::ZipArchive::new(reader)?;

        let file = archive.by_name("graph")?;
        let mut graph: Graph = bincode::deserialize_from(file).map_err(Error::Bincode)?;

        let file = archive.by_name("metadata.json")?;
        let metadata: HashMap<String, String> =
            serde_json::from_reader(file).map_err(Error::Json)?;
        graph.metadata = metadata;

        Ok(graph)
    }

    /// Loads a graph from the supplied reader.
    pub fn load<R: Read + Seek>(reader: R) -> Result<Self, Error> {
        let mut archive = zip::ZipArchive::new(reader)?;

        let file = archive.by_name("graph")?;
        let mut graph: Graph = bincode::deserialize_from(file).map_err(Error::Bincode)?;

        let file = archive.by_name("metadata.json")?;
        let metadata: HashMap<String, String> =
            serde_json::from_reader(file).map_err(Error::Json)?;
        graph.metadata = metadata;

        for id in 0..archive.len() {
            let file = archive.by_index(id)?;
            let Some(file_name) = file.name().strip_suffix(".mapping") else {
                continue;
            };
            let Some(mapping) = graph.mappings.get_mut(file_name) else {
                continue;
            };

            *mapping = mapping.read(file)?.into();
        }

        for id in 0..archive.len() {
            let file = archive.by_index(id)?;
            let Some(file_name) = file.name().strip_suffix(".resource") else {
                continue;
            };
            let Some(resource) = graph.resources.get_mut(file_name) else {
                continue;
            };

            *resource = resource.read(file)?.into();
        }

        check::run_checks(&mut graph)?;

        Ok(graph)
    }

    /// Creates a JSON representation of this graph.
    ///
    /// # Note
    ///
    /// This JSON representation _cannot_ be used for serialization purposes, since it
    /// does not fully serialize all the data necessary to recreate the graph. This is
    /// for inspection purposes only.
    pub fn to_json(&self) -> String {
        serde_json::to_string(&self).expect("can always serialize")
    }
}