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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
impl AprV2Model {
/// Load a model from a .apr file using memory mapping.
///
/// # Memory Efficiency
///
/// For uncompressed files, uses `mmap()` for zero-copy access.
/// The kernel manages pages via demand paging - only accessed
/// pages are loaded into RAM. After GPU transfer, call
/// `release_cpu_pages()` to advise the kernel to drop pages.
///
/// For compressed files, falls back to heap allocation after
/// decompression (mmap not possible for decompressed data).
///
/// # References
///
/// - Didona et al. (2022): mmap achieves 2.3x throughput vs read()
/// - See docs/model-loading.md for design rationale
#[cfg(not(target_arch = "wasm32"))]
pub fn load<P: AsRef<Path>>(path: P) -> Result<Self> {
use std::io::Read;
let path_ref = path.as_ref();
// Read just the header first to check for compression
let mut file = File::open(path_ref).map_err(|e| RealizarError::IoError {
message: format!("Failed to open .apr file: {e}"),
})?;
let mut header_buf = [0u8; HEADER_SIZE];
file.read_exact(&mut header_buf)
.map_err(|e| RealizarError::IoError {
message: format!("Failed to read .apr header: {e}"),
})?;
let header = AprHeader::from_bytes(&header_buf)?;
// Check for unsupported features
if header.flags.is_encrypted() {
return Err(RealizarError::FormatError {
reason: "Encrypted .apr files not yet supported".to_string(),
});
}
// Choose loading strategy based on compression
let data = if header.flags.is_compressed() {
// Compressed: must read entire file into heap, then decompress
drop(file); // Close file handle
let raw_data = std::fs::read(path_ref).map_err(|e| RealizarError::IoError {
message: format!("Failed to read compressed .apr file: {e}"),
})?;
let decompressed = Self::decompress_apr_data(&header, raw_data)?;
ModelData::from_vec(decompressed)
} else {
// Uncompressed: use mmap for zero-copy access
drop(file); // Close file handle before mmap
ModelData::open_mmap(path_ref)?
};
// Advise sequential access pattern for parsing
#[cfg(unix)]
let _ = data.advise_sequential();
Self::from_model_data(header, data)
}
/// Load a model from a .apr file (WASM fallback).
#[cfg(target_arch = "wasm32")]
pub fn load<P: AsRef<Path>>(path: P) -> Result<Self> {
let raw_data = std::fs::read(path.as_ref()).map_err(|e| RealizarError::IoError {
message: format!("Failed to read .apr file: {e}"),
})?;
Self::from_bytes(raw_data)
}
/// Load a model from bytes (heap-allocated).
///
/// Use this for:
/// - Compressed files after decompression
/// - Data received over network
/// - WASM environments (no mmap support)
///
/// For file-based loading with mmap support, use `load()` instead.
pub fn from_bytes(data: Vec<u8>) -> Result<Self> {
// Parse header
let header = AprHeader::from_bytes(&data)?;
// Check for unsupported features
if header.flags.is_encrypted() {
return Err(RealizarError::FormatError {
reason: "Encrypted .apr files not yet supported".to_string(),
});
}
// Decompress data if needed (GH-35)
let data = if header.flags.is_compressed() {
Self::decompress_apr_data(&header, data)?
} else {
data
};
Self::from_model_data(header, ModelData::from_vec(data))
}
/// Internal: construct model from header and ModelData.
fn from_model_data(header: AprHeader, data: ModelData) -> Result<Self> {
let data_slice = data.as_slice();
// Parse metadata
let metadata_start = header.metadata_offset as usize;
let metadata_end = metadata_start + header.metadata_size as usize;
if data_slice.len() < metadata_end {
return Err(RealizarError::FormatError {
reason: format!(
".apr file truncated: metadata extends to {} but file is {} bytes",
metadata_end,
data_slice.len()
),
});
}
let metadata: AprMetadata = if header.metadata_size > 0 {
serde_json::from_slice(&data_slice[metadata_start..metadata_end]).unwrap_or_default()
} else {
AprMetadata::default()
};
// Parse tensor index (binary format from aprender v2)
let index_start = header.tensor_index_offset as usize;
let index_end = header.data_offset as usize;
let mut tensors = Vec::with_capacity(header.tensor_count as usize);
if index_start < index_end && index_end <= data_slice.len() {
let index_data = &data_slice[index_start..index_end];
let mut pos = 0;
while pos < index_data.len() && tensors.len() < header.tensor_count as usize {
match TensorEntry::from_binary(&index_data[pos..]) {
Ok((entry, consumed)) => {
tensors.push(entry);
pos += consumed;
},
Err(_) => break, // Stop on parse error
}
}
}
Ok(Self {
header,
metadata,
tensors,
data,
})
}
/// Decompress APR data based on compression flags (GH-35)
///
/// The compressed format stores: header (64 bytes, uncompressed) + compressed payload.
/// We decompress the payload and reconstruct the full data vector.
#[allow(unreachable_patterns)] // Pattern varies based on apr-compression feature
fn decompress_apr_data(header: &AprHeader, data: Vec<u8>) -> Result<Vec<u8>> {
#[cfg(feature = "apr-compression")]
let compressed_payload = &data[HEADER_SIZE..];
#[cfg(feature = "apr-compression")]
{
let decompressed = if header.flags.is_lz4() {
lz4_flex::decompress_size_prepended(compressed_payload).map_err(|e| {
RealizarError::FormatError {
reason: format!("LZ4 decompression failed: {e}"),
}
})?
} else if header.flags.is_zstd() {
zstd::decode_all(compressed_payload).map_err(|e| RealizarError::FormatError {
reason: format!("ZSTD decompression failed: {e}"),
})?
} else {
// Unknown compression - should not happen
return Err(RealizarError::FormatError {
reason: "Unknown compression algorithm in APR flags".to_string(),
});
};
// Reconstruct full data: header + decompressed payload
let mut result = Vec::with_capacity(HEADER_SIZE + decompressed.len());
result.extend_from_slice(&data[..HEADER_SIZE]);
result.extend_from_slice(&decompressed);
Ok(result)
}
#[cfg(not(feature = "apr-compression"))]
{
let _ = (header, &data); // Suppress unused warnings
Err(RealizarError::FormatError {
reason: "Compressed .apr files require 'apr-compression' feature".to_string(),
})
}
}
/// Get number of tensors
#[must_use]
pub fn tensor_count(&self) -> u32 {
self.header.tensor_count
}
/// Get tensor names
#[must_use]
pub fn tensor_names(&self) -> Vec<&str> {
self.tensors.iter().map(|t| t.name.as_str()).collect()
}
/// Get metadata
#[must_use]
pub fn metadata(&self) -> &AprMetadata {
&self.metadata
}
/// Get tensor by name
#[must_use]
pub fn get_tensor(&self, name: &str) -> Option<&TensorEntry> {
self.tensors.iter().find(|t| t.name == name)
}
/// Get tensor data as f32 slice
pub fn get_tensor_f32(&self, name: &str) -> Result<Vec<f32>> {
let entry = self
.get_tensor(name)
.ok_or_else(|| RealizarError::FormatError {
reason: format!("Tensor not found: {name}"),
})?;
let start = (self.header.data_offset + entry.offset) as usize;
let end = start + entry.size as usize;
let data_slice = self.data.as_slice();
if end > data_slice.len() {
return Err(RealizarError::FormatError {
reason: format!("Tensor data out of bounds: {name}"),
});
}
let bytes = &data_slice[start..end];
// Calculate total number of elements from shape
let num_elements: usize = entry.shape.iter().product();
// Parse based on dtype
// GH-250: APR-native Q8/Q4 formats differ from GGML Q8_0/Q4_K!
// APR Q8: [scale: f32 (4B)] + [i8 × N] (single whole-tensor scale)
// APR Q4: per-32-block [scale: f16 (2B)] + [16 packed nibble bytes]
// GGML Q8_0: per-32-block [scale: f16 (2B)] + [32 × i8]
// GGML Q4_K: 256-element super-blocks with sub-block scales
// APR Q4_K/Q6_K are passthrough GGML formats (from add_q4k_raw_tensor).
match entry.dtype.as_str() {
"F32" | "f32" => {
let floats: Vec<f32> = bytes
.chunks_exact(4)
.map(|chunk| f32::from_le_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]))
.collect();
Ok(floats)
},
"F16" | "f16" => Ok(dequantize_f16(bytes, num_elements)),
// APR-native formats (different from GGML!)
"q8" | "Q8" => Ok(dequant::dequantize_apr_q8(bytes, num_elements)),
"q4" | "Q4" => Ok(dequant::dequantize_apr_q4(bytes, num_elements)),
// GGML-compatible formats (passthrough from GGUF import)
"Q8_0" | "q8_0" => Ok(dequantize_q8_0(bytes, num_elements)),
"Q4_K" | "q4_k" => Ok(dequantize_q4_k(bytes, num_elements)),
"Q6_K" | "q6_k" => Ok(dequantize_q6_k(bytes, num_elements)),
dtype => Err(RealizarError::FormatError {
reason: format!("Unsupported tensor dtype: {dtype}"),
}),
}
}
/// Get raw tensor bytes
pub fn get_tensor_bytes(&self, name: &str) -> Result<&[u8]> {
let entry = self
.get_tensor(name)
.ok_or_else(|| RealizarError::FormatError {
reason: format!("Tensor not found: {name}"),
})?;
let start = (self.header.data_offset + entry.offset) as usize;
let end = start + entry.size as usize;
let data_slice = self.data.as_slice();
if end > data_slice.len() {
return Err(RealizarError::FormatError {
reason: format!("Tensor data out of bounds: {name}"),
});
}
Ok(&data_slice[start..end])
}
/// Release CPU pages after GPU transfer (Unix only).
///
/// Advises the kernel that the mapped pages are no longer needed.
/// The kernel will drop pages immediately (not compress to zram)
/// and re-fault from disk if accessed again.
///
/// # When to Call
///
/// After all tensor data has been copied to GPU via `cuMemcpy()`.
/// This is the key method for reducing zram pressure.
///
/// # Example
///
/// ```rust,ignore
/// let model = AprV2Model::load("model.apr")?;
/// for name in model.tensor_names() {
/// let bytes = model.get_tensor_bytes(&name)?;
/// cuda::memcpy_htod(gpu_ptr, bytes);
/// }
/// // Free CPU pages now that data is on GPU
/// model.release_cpu_pages()?;
/// ```
#[cfg(all(unix, not(target_arch = "wasm32")))]
pub fn release_cpu_pages(&self) -> Result<()> {
self.data.release_cpu_pages()
}
/// No-op on non-Unix platforms (madvise not available).
#[cfg(not(all(unix, not(target_arch = "wasm32"))))]
pub fn release_cpu_pages(&self) -> Result<()> {
Ok(())
}
/// Check if model is using memory-mapped I/O.
///
/// Returns `true` if the model was loaded via mmap (uncompressed file).
/// Returns `false` if the model is heap-allocated (compressed file or WASM).
#[must_use]
pub fn is_mmap(&self) -> bool {
self.data.is_mmap()
}
/// Estimate total parameters
#[must_use]
pub fn estimated_parameters(&self) -> usize {
self.tensors
.iter()
.map(|t| t.shape.iter().product::<usize>())
.sum()
}
/// Run inference on input features (for simple models)
///
/// For transformer models, use `forward()` instead.
///
/// # Arguments
///
/// * `features` - Input feature vector
///
/// # Returns
///
/// Output vector
///
/// # Errors
///
/// Returns error if model has no tensors
pub fn predict(&self, features: &[f32]) -> Result<Vec<f32>> {
if self.tensors.is_empty() && self.header.tensor_count == 0 {
let sum: f32 = features.iter().sum();
return Ok(vec![sum]);
}
// Linear model: y = Wx + b (if we have weights)
if let Some(weight) = self.get_tensor("weight") {
let weights = self.get_tensor_f32("weight")?;
let bias = self.get_tensor_f32("bias").unwrap_or_default();
let output_dim = weight.shape.first().copied().unwrap_or(1);
let input_dim = weight.shape.get(1).copied().unwrap_or(features.len());
let mut output = vec![0.0; output_dim];
for (i, out) in output.iter_mut().enumerate() {
for (j, &feat) in features.iter().take(input_dim).enumerate() {
*out += weights.get(i * input_dim + j).copied().unwrap_or(0.0) * feat;
}
*out += bias.get(i).copied().unwrap_or(0.0);
}
return Ok(output);
}
let sum: f32 = features.iter().sum();
Ok(vec![sum])
}
}