encoderfile 0.6.2

Distribute and run transformer encoders with a single file.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use crate::{
    format::assets::AssetKind,
    generated::manifest::{Artifact, EncoderfileManifest},
};
use anyhow::{Result, bail};

pub mod decoder;
pub mod encoder;

#[derive(Debug)]
pub struct EncoderfileCodec {
    absolute_offset: u64,
}

impl EncoderfileCodec {
    pub fn new(absolute_offset: u64) -> Self {
        Self { absolute_offset }
    }
}

impl EncoderfileManifest {
    fn set_artifact(&mut self, kind: &AssetKind, artifact: Artifact) {
        let slot = self.get_mut_slot(kind);

        *slot = Some(artifact);
    }

    fn set_offset(&mut self, kind: &AssetKind, offset: u64) -> Result<()> {
        let slot = self.get_mut_slot(kind);

        match slot {
            Some(s) => s.offset = offset,
            None => bail!("Cannot set offset for {kind:?}: artifact unset"),
        }
        Ok(())
    }

    fn get_mut_slot<'a>(&'a mut self, kind: &AssetKind) -> &'a mut Option<Artifact> {
        match kind {
            AssetKind::ModelWeights => &mut self.weights,
            AssetKind::ModelConfig => &mut self.model_config,
            AssetKind::Transform => &mut self.transform,
            AssetKind::Tokenizer => &mut self.tokenizer,
        }
    }

    pub fn get_slot(&self, kind: &AssetKind) -> &Option<Artifact> {
        match kind {
            AssetKind::ModelWeights => &self.weights,
            AssetKind::ModelConfig => &self.model_config,
            AssetKind::Transform => &self.transform,
            AssetKind::Tokenizer => &self.tokenizer,
        }
    }

    pub fn artifacts_iter(&self) -> impl Iterator<Item = (AssetKind, &Artifact)> {
        AssetKind::ORDERED
            .iter()
            .filter_map(|kind| self.get_slot(kind).as_ref().map(|a| (*kind, a)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::generated::manifest::Artifact;

    fn empty_manifest() -> EncoderfileManifest {
        EncoderfileManifest {
            name: "test".into(),
            version: "0.0.0".into(),
            model_type: 0,
            backend: 0,
            model_config: None,
            weights: None,
            transform: None,
            tokenizer: None,
        }
    }

    fn artifact(len: u64) -> Artifact {
        Artifact {
            offset: 0,
            length: len,
            sha256: [0u8; 32].to_vec(),
        }
    }

    #[test]
    fn set_and_get_artifact() {
        let mut m = empty_manifest();
        let a = artifact(123);

        m.set_artifact(&AssetKind::ModelWeights, a.clone());

        let slot = m.get_slot(&AssetKind::ModelWeights);
        assert!(slot.is_some());
        assert_eq!(slot.as_ref().unwrap().length, 123);
    }

    #[test]
    fn set_offset_updates_existing_artifact() {
        let mut m = empty_manifest();
        m.set_artifact(&AssetKind::Tokenizer, artifact(10));

        m.set_offset(&AssetKind::Tokenizer, 42).unwrap();

        let a = m.get_slot(&AssetKind::Tokenizer).as_ref().unwrap();
        assert_eq!(a.offset, 42);
    }

    #[test]
    fn set_offset_fails_if_artifact_unset() {
        let mut m = empty_manifest();

        let err = m.set_offset(&AssetKind::Transform, 10).unwrap_err();
        let msg = err.to_string();

        assert!(
            msg.contains("artifact unset"),
            "unexpected error message: {msg}"
        );
    }

    #[test]
    fn get_slot_returns_none_for_unset() {
        let m = empty_manifest();

        assert!(m.get_slot(&AssetKind::ModelConfig).is_none());
        assert!(m.get_slot(&AssetKind::Transform).is_none());
    }

    #[test]
    fn artifacts_iter_yields_only_present_in_order() {
        let mut m = empty_manifest();

        m.set_artifact(&AssetKind::Tokenizer, artifact(1));
        m.set_artifact(&AssetKind::ModelWeights, artifact(2));
        m.set_artifact(&AssetKind::Transform, artifact(3));

        let kinds: Vec<_> = m.artifacts_iter().map(|(kind, _)| kind).collect();

        // Must follow AssetKind::ORDERED, not insertion order
        assert_eq!(
            kinds,
            AssetKind::ORDERED
                .iter()
                .copied()
                .filter(|k| matches!(
                    k,
                    AssetKind::ModelWeights | AssetKind::Transform | AssetKind::Tokenizer
                ))
                .collect::<Vec<_>>()
        );
    }
}