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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
use std::fs::File;
use std::io::{BufReader, Read, Seek, Write};
use failure::Error;
pub trait ReadEmbeddings
where
Self: Sized,
{
fn read_embeddings<R>(read: &mut R) -> Result<Self, Error>
where
R: Read + Seek;
}
pub trait ReadMetadata
where
Self: Sized,
{
fn read_metadata<R>(read: &mut R) -> Result<Self, Error>
where
R: Read + Seek;
}
pub trait MmapEmbeddings
where
Self: Sized,
{
fn mmap_embeddings(read: &mut BufReader<File>) -> Result<Self, Error>;
}
pub trait WriteEmbeddings {
fn write_embeddings<W>(&self, write: &mut W) -> Result<(), Error>
where
W: Write + Seek;
}
pub(crate) mod private {
use std::fs::File;
use std::io::{BufReader, Read, Seek, Write};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use failure::{ensure, format_err, Error, ResultExt};
const MODEL_VERSION: u32 = 0;
const MAGIC: [u8; 4] = [b'F', b'i', b'F', b'u'];
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum ChunkIdentifier {
Header = 0,
SimpleVocab = 1,
NdArray = 2,
SubwordVocab = 3,
QuantizedArray = 4,
Metadata = 5,
}
impl ChunkIdentifier {
pub fn try_from(identifier: u32) -> Option<Self> {
use ChunkIdentifier::*;
match identifier {
1 => Some(SimpleVocab),
2 => Some(NdArray),
3 => Some(SubwordVocab),
4 => Some(QuantizedArray),
5 => Some(Metadata),
_ => None,
}
}
}
pub trait TypeId {
fn type_id() -> u32;
}
macro_rules! typeid_impl {
($type:ty, $id:expr) => {
impl TypeId for $type {
fn type_id() -> u32 {
$id
}
}
};
}
typeid_impl!(f32, 10);
typeid_impl!(u8, 1);
pub trait ReadChunk
where
Self: Sized,
{
fn read_chunk<R>(read: &mut R) -> Result<Self, Error>
where
R: Read + Seek;
}
pub trait MmapChunk
where
Self: Sized,
{
fn mmap_chunk(read: &mut BufReader<File>) -> Result<Self, Error>;
}
pub trait WriteChunk {
fn chunk_identifier(&self) -> ChunkIdentifier;
fn write_chunk<W>(&self, write: &mut W) -> Result<(), Error>
where
W: Write + Seek;
}
#[derive(Debug, Eq, PartialEq)]
pub(crate) struct Header {
chunk_identifiers: Vec<ChunkIdentifier>,
}
impl Header {
pub fn new(chunk_identifiers: impl Into<Vec<ChunkIdentifier>>) -> Self {
Header {
chunk_identifiers: chunk_identifiers.into(),
}
}
pub fn chunk_identifiers(&self) -> &[ChunkIdentifier] {
&self.chunk_identifiers
}
}
impl WriteChunk for Header {
fn chunk_identifier(&self) -> ChunkIdentifier {
ChunkIdentifier::Header
}
fn write_chunk<W>(&self, write: &mut W) -> Result<(), Error>
where
W: Write + Seek,
{
write.write_all(&MAGIC)?;
write.write_u32::<LittleEndian>(MODEL_VERSION)?;
write.write_u32::<LittleEndian>(self.chunk_identifiers.len() as u32)?;
for &identifier in &self.chunk_identifiers {
write.write_u32::<LittleEndian>(identifier as u32)?
}
Ok(())
}
}
impl ReadChunk for Header {
fn read_chunk<R>(read: &mut R) -> Result<Self, Error>
where
R: Read + Seek,
{
let mut magic = [0u8; 4];
read.read_exact(&mut magic)?;
ensure!(
magic == MAGIC,
"File does not have finalfusion magic, expected: {}, was: {}",
String::from_utf8_lossy(&MAGIC),
String::from_utf8_lossy(&magic)
);
let version = read.read_u32::<LittleEndian>()?;
ensure!(
version == MODEL_VERSION,
"Unknown model version, expected: {}, was: {}",
MODEL_VERSION,
version
);
let chunk_identifiers_len = read.read_u32::<LittleEndian>()? as usize;
let mut chunk_identifiers = Vec::with_capacity(chunk_identifiers_len);
for _ in 0..chunk_identifiers_len {
let identifier = read
.read_u32::<LittleEndian>()
.with_context(|e| format!("Cannot read chunk identifier: {}", e))?;
let chunk_identifier = ChunkIdentifier::try_from(identifier)
.ok_or_else(|| format_err!("Unknown chunk identifier: {}", identifier))?;
chunk_identifiers.push(chunk_identifier);
}
Ok(Header { chunk_identifiers })
}
}
}
#[cfg(test)]
mod tests {
use std::io::{Cursor, Seek, SeekFrom};
use crate::io::private::{ChunkIdentifier, Header, ReadChunk, WriteChunk};
#[test]
fn header_write_read_roundtrip() {
let check_header =
Header::new(vec![ChunkIdentifier::SimpleVocab, ChunkIdentifier::NdArray]);
let mut cursor = Cursor::new(Vec::new());
check_header.write_chunk(&mut cursor).unwrap();
cursor.seek(SeekFrom::Start(0)).unwrap();
let header = Header::read_chunk(&mut cursor).unwrap();
assert_eq!(header, check_header);
}
}