frankensearch-embed 0.2.2

Embedder implementations for frankensearch (hash, model2vec, fastembed)
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
//! `Model2Vec` static token embedding for the fast tier.
//!
//! Wraps the exact manifest-registered potion-multilingual-128M artifact set.
//! It looks up pre-computed per-token embeddings and mean-pools them. No
//! transformer inference, no GPU needed.
//!
//! Performance: ~0.57ms per embedding (223x faster than `MiniLM-L6-v2`).
//!
//! Memory: ~32MB resident for a 32K-vocab × 256-dim model.
//!
//! Only two files are required:
//! - `tokenizer.json` (`HuggingFace` BPE tokenizer)
//! - `model.safetensors` (static embedding matrix)

use std::fmt;
use std::path::{Path, PathBuf};
#[cfg(test)]
use std::sync::atomic::{AtomicBool, Ordering};

use asupersync::Cx;
use rayon::prelude::*;
use safetensors::SafeTensors;
use tokenizers::Tokenizer;
use tracing::instrument;

use crate::model_manifest::{
    MODEL2VEC_OUTPUT_NORMALIZATION_V1, MODEL2VEC_POOLING_V1, MODEL2VEC_PREPROCESSING_V1,
    MODEL2VEC_SEQUENCE_POLICY_V1, ModelArtifactManifestV1,
};
use crate::model_registry::{ensure_model_storage_layout, model_directory_variants};
use frankensearch_core::error::{SearchError, SearchResult};
use frankensearch_core::generation::{EmbeddingIdentityBundleV1, QuantizationFormat};
use frankensearch_core::traits::{Embedder, ModelCategory, SearchFuture};

/// Required files for a `Model2Vec` model.
const REQUIRED_FILES: [&str; 2] = ["tokenizer.json", "model.safetensors"];

/// Batch size at/above which `embed_batch` dispatches per-document embedding across
/// Rayon threads. Each `embed_sync` is ~0.57 ms of independent CPU work (tokenize →
/// static-row gather → mean-pool → normalize), so parallel dispatch amortizes Rayon
/// scheduling at a much smaller batch than the FNV hash embedder needs (256); smaller
/// batches stay serial to preserve single/few-doc latency.
const PARALLEL_BATCH_MIN: usize = 8;

/// Tensor name candidates, tried in order when discovering the embedding matrix.
const TENSOR_NAME_CANDIDATES: [&str; 5] =
    ["embeddings", "embedding", "word_embeddings", "embed", "emb"];

/// Default model name for the primary fast-tier model.
const DEFAULT_MODEL_NAME: &str = "potion-multilingual-128M";

/// Default `HuggingFace` model ID for the primary fast-tier model.
const DEFAULT_HF_ID: &str = "minishlab/potion-multilingual-128M";

/// Static token embedding model (`Model2Vec` / potion).
///
/// After construction, all fields are immutable — no `Mutex` needed.
/// The struct is `Send + Sync` by construction.
///
/// # Loading
///
/// ```rust,ignore
/// let embedder = Model2VecEmbedder::load("/path/to/model")?;
/// let embedding = embedder.embed_sync("hello world");
/// assert_eq!(embedding.len(), 256);
/// ```
pub struct Model2VecEmbedder {
    /// `HuggingFace` BPE tokenizer.
    tokenizer: Tokenizer,
    /// Flat embedding matrix: `embeddings[token_id * dim .. (token_id + 1) * dim]`.
    embeddings: Vec<f32>,
    /// Output dimensionality.
    dimensions: usize,
    /// Vocabulary size (number of rows in the embedding matrix).
    vocab_size: usize,
    /// Human-readable model name.
    name: String,
    /// Directory the model was loaded from.
    model_dir: PathBuf,
    /// Complete identity derived from the verified frozen manifest.
    identity: EmbeddingIdentityBundleV1,
    /// Test-only witness that the shipping tokenizer returned the offset-free encoding shape.
    #[cfg(test)]
    last_tokenizer_route_was_offset_free: AtomicBool,
}

impl fmt::Debug for Model2VecEmbedder {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Model2VecEmbedder")
            .field("name", &self.name)
            .field("dimensions", &self.dimensions)
            .field("vocab_size", &self.vocab_size)
            .field("model_dir", &"<redacted>")
            .field("identity", &self.identity.fingerprint())
            .finish_non_exhaustive()
    }
}

impl Model2VecEmbedder {
    /// Load a `Model2Vec` model from a directory containing `tokenizer.json`
    /// and `model.safetensors`.
    ///
    /// # Errors
    ///
    /// Returns `SearchError::ModelNotFound` if required files are missing.
    /// Returns `SearchError::ModelLoadFailed` if files exist but cannot be parsed.
    #[instrument(skip_all, fields(model = DEFAULT_MODEL_NAME))]
    pub fn load(model_dir: impl AsRef<Path>) -> SearchResult<Self> {
        Self::load_with_name(model_dir, DEFAULT_MODEL_NAME)
    }

    /// Load the registered potion model with a custom display identifier.
    ///
    /// The supplied name does not select or attest compatibility; production
    /// model bytes and runtime identity still come exclusively from the frozen
    /// potion manifest.
    ///
    /// # Errors
    ///
    /// Returns `SearchError::ModelNotFound` if required files are missing.
    /// Returns `SearchError::ModelLoadFailed` if files exist but cannot be parsed.
    pub fn load_with_name(model_dir: impl AsRef<Path>, name: &str) -> SearchResult<Self> {
        let model_dir = model_dir.as_ref();
        #[cfg(test)]
        {
            Self::load_explicit_test_model(model_dir, name)
        }
        #[cfg(not(test))]
        {
            let verified = ModelArtifactManifestV1::potion_128m_native()?.verify_dir(model_dir)?;
            let identity = verified.identity_bundle(QuantizationFormat::F32, "in-memory-f32-v1")?;
            validate_registered_execution_contract(&identity)?;
            Self::load_preverified(model_dir, name, identity)
        }
    }

    fn load_preverified(
        model_dir: &Path,
        name: &str,
        mut identity: EmbeddingIdentityBundleV1,
    ) -> SearchResult<Self> {
        // Validate required files exist
        for filename in &REQUIRED_FILES {
            let path = model_dir.join(filename);
            if !path.exists() {
                return Err(SearchError::ModelNotFound {
                    name: format!("{name} (missing {filename} in {})", model_dir.display()),
                });
            }
        }

        // Load tokenizer
        let tokenizer_path = model_dir.join("tokenizer.json");
        let tokenizer =
            Tokenizer::from_file(&tokenizer_path).map_err(|e| SearchError::ModelLoadFailed {
                path: tokenizer_path,
                source: format!("failed to load tokenizer: {e}").into(),
            })?;

        // Load safetensors
        let safetensors_path = model_dir.join("model.safetensors");
        let safetensors_data =
            std::fs::read(&safetensors_path).map_err(|e| SearchError::ModelLoadFailed {
                path: safetensors_path.clone(),
                source: Box::new(e),
            })?;

        let safetensors = SafeTensors::deserialize(&safetensors_data).map_err(|e| {
            SearchError::ModelLoadFailed {
                path: safetensors_path.clone(),
                source: format!("failed to parse safetensors: {e}").into(),
            }
        })?;

        // Discover the embedding tensor
        let tensor_name = discover_tensor_name(&safetensors).ok_or_else(|| {
            let available: Vec<_> = safetensors.names().into_iter().collect();
            SearchError::ModelLoadFailed {
                path: safetensors_path.clone(),
                source: format!(
                    "no embedding tensor found. Tried: {TENSOR_NAME_CANDIDATES:?}. Available: {available:?}"
                )
                .into(),
            }
        })?;

        let tensor =
            safetensors
                .tensor(&tensor_name)
                .map_err(|e| SearchError::ModelLoadFailed {
                    path: safetensors_path.clone(),
                    source: format!("failed to get tensor '{tensor_name}': {e}").into(),
                })?;

        // Validate tensor shape
        let shape = tensor.shape();
        if shape.len() != 2 {
            return Err(SearchError::ModelLoadFailed {
                path: safetensors_path,
                source: format!(
                    "expected 2D tensor, got {}D with shape {shape:?}",
                    shape.len()
                )
                .into(),
            });
        }

        let vocab_size = shape[0];
        let dimensions = shape[1];
        let parsed_dimension =
            u32::try_from(dimensions).map_err(|_| SearchError::InvalidConfig {
                field: "model2vec.dimension".to_owned(),
                value: dimensions.to_string(),
                reason: "parsed tensor dimension exceeds the identity schema".to_owned(),
            })?;

        if identity.producer.backend == "explicit-test-backend" {
            identity.space.dimension = parsed_dimension;
            identity.storage.dimension = parsed_dimension;
            identity.producer.golden_vectors.dimension = parsed_dimension;
            identity.producer.space_fingerprint = identity.space.fingerprint();
        }
        if identity.space.dimension != parsed_dimension {
            return Err(SearchError::ModelLoadFailed {
                path: safetensors_path.clone(),
                source: format!(
                    "parsed embedding dimension {parsed_dimension} disagrees with attested dimension {}",
                    identity.space.dimension
                )
                .into(),
            });
        }
        identity.validate()?;

        // Parse the raw f32 data into the embedding matrix
        let embeddings = parse_f32_matrix(tensor.data(), vocab_size, dimensions).map_err(|e| {
            SearchError::ModelLoadFailed {
                path: safetensors_path,
                source: e.into(),
            }
        })?;

        tracing::info!(
            model = DEFAULT_MODEL_NAME,
            vocab_size,
            dimensions,
            manifest = %identity.producer.provenance_manifest_fingerprint,
            identity = %identity.fingerprint(),
            "Model2Vec model loaded"
        );

        Ok(Self {
            tokenizer,
            embeddings,
            dimensions,
            vocab_size,
            name: name.to_owned(),
            model_dir: model_dir.to_owned(),
            identity,
            #[cfg(test)]
            last_tokenizer_route_was_offset_free: AtomicBool::new(false),
        })
    }

    #[cfg(test)]
    fn load_explicit_test_model(model_dir: &Path, name: &str) -> SearchResult<Self> {
        Self::load_preverified(
            model_dir,
            name,
            EmbeddingIdentityBundleV1::explicit_test_model(name, 1),
        )
    }

    /// Synchronous embedding (no async overhead for ~0.57ms operation).
    ///
    /// # Errors
    ///
    /// Returns `SearchError::EmbeddingFailed` if tokenization fails or
    /// all tokens are out-of-vocabulary.
    pub fn embed_sync(&self, text: &str) -> SearchResult<Vec<f32>> {
        if text.is_empty() {
            // Empty text → return zero vector (consistent with hash embedder)
            return Ok(vec![0.0; self.dimensions]);
        }

        // `Model2Vec` consumes token IDs only. Avoid constructing offsets, token strings, and
        // word IDs that this private boundary immediately discards.
        let encoding =
            self.tokenizer
                .encode_fast(text, false)
                .map_err(|e| SearchError::EmbeddingFailed {
                    model: self.name.clone(),
                    source: format!("tokenization failed: {e}").into(),
                })?;

        #[cfg(test)]
        self.last_tokenizer_route_was_offset_free.store(
            !encoding.get_ids().is_empty()
                && encoding.get_tokens().iter().all(String::is_empty)
                && encoding
                    .get_offsets()
                    .iter()
                    .all(|&offset| offset == (0, 0))
                && encoding.get_word_ids().iter().all(Option::is_none),
            Ordering::Relaxed,
        );

        Ok(self.embed_token_ids(encoding.get_ids()))
    }

    #[inline]
    fn embed_token_ids(&self, token_ids: &[u32]) -> Vec<f32> {
        if token_ids.is_empty() {
            return vec![0.0; self.dimensions];
        }

        // Mean pool: accumulate embeddings for in-vocabulary tokens
        let mut sum = vec![0.0_f32; self.dimensions];
        let count = crate::simd::accumulate_model2vec_rows(
            &mut sum,
            &self.embeddings,
            token_ids,
            self.vocab_size,
        );

        if count == 0 {
            // All tokens were OOV — return zero vector
            return vec![0.0; self.dimensions];
        }

        // Store each rounded mean value before adding its square in the same strict
        // left-to-right `Iterator::sum()` order, starting from 0.0, as the former pass.
        finish_mean_pool_and_normalize(&mut sum, count);
        sum
    }

    #[cfg(test)]
    fn last_tokenizer_route_was_offset_free(&self) -> bool {
        self.last_tokenizer_route_was_offset_free
            .load(Ordering::Relaxed)
    }

    /// Former pre-lever `encode` route retained only for the existing internal benchmark.
    #[cfg(feature = "bench-internals")]
    #[doc(hidden)]
    pub fn benchmark_embed_sync_former_encode(&self, text: &str) -> SearchResult<Vec<f32>> {
        if text.is_empty() {
            return Ok(vec![0.0; self.dimensions]);
        }

        let encoding =
            self.tokenizer
                .encode(text, false)
                .map_err(|e| SearchError::EmbeddingFailed {
                    model: self.name.clone(),
                    source: format!("tokenization failed: {e}").into(),
                })?;
        Ok(self.embed_token_ids(encoding.get_ids()))
    }

    /// Former pre-lever mean-pool finish retained only for the internal paired benchmark.
    #[cfg(feature = "bench-internals")]
    #[doc(hidden)]
    pub fn benchmark_embed_sync_former_finish(&self, text: &str) -> SearchResult<Vec<f32>> {
        if text.is_empty() {
            return Ok(vec![0.0; self.dimensions]);
        }

        let encoding =
            self.tokenizer
                .encode_fast(text, false)
                .map_err(|e| SearchError::EmbeddingFailed {
                    model: self.name.clone(),
                    source: format!("tokenization failed: {e}").into(),
                })?;
        Ok(self.embed_token_ids_with_former_finish(encoding.get_ids()))
    }

    #[cfg(feature = "bench-internals")]
    fn embed_token_ids_with_former_finish(&self, token_ids: &[u32]) -> Vec<f32> {
        if token_ids.is_empty() {
            return vec![0.0; self.dimensions];
        }

        let mut sum = vec![0.0_f32; self.dimensions];
        let count = crate::simd::accumulate_model2vec_rows(
            &mut sum,
            &self.embeddings,
            token_ids,
            self.vocab_size,
        );
        if count == 0 {
            return vec![0.0; self.dimensions];
        }

        finish_mean_pool_and_normalize_former(&mut sum, count);
        sum
    }

    /// Embed a batch of texts, dispatching per-document `embed_sync` across Rayon
    /// threads once the batch reaches [`PARALLEL_BATCH_MIN`]. Each document is
    /// independent CPU-bound work, so the result is **identical** to the serial loop
    /// (Rayon's indexed `collect` preserves input order); only the wall-clock differs.
    ///
    /// # Errors
    ///
    /// Returns `SearchError::EmbeddingFailed` if tokenization fails or
    /// all tokens are out-of-vocabulary for any text in the batch.
    pub fn embed_batch_sync(&self, texts: &[&str]) -> SearchResult<Vec<Vec<f32>>> {
        if texts.len() >= PARALLEL_BATCH_MIN {
            texts.par_iter().map(|text| self.embed_sync(text)).collect()
        } else {
            let mut results = Vec::with_capacity(texts.len());
            for text in texts {
                results.push(self.embed_sync(text)?);
            }
            Ok(results)
        }
    }

    /// The directory this model was loaded from.
    #[must_use]
    pub fn model_dir(&self) -> &Path {
        &self.model_dir
    }

    /// Vocabulary size (number of token embeddings in the matrix).
    #[must_use]
    pub const fn vocab_size(&self) -> usize {
        self.vocab_size
    }
}

#[inline]
fn finish_mean_pool_and_normalize(sum: &mut [f32], count: usize) {
    #[allow(clippy::cast_precision_loss)]
    let inv = 1.0 / count as f32;
    let mut norm_sq = 0.0_f32;
    for value in sum.iter_mut() {
        *value *= inv;
        norm_sq += *value * *value;
    }
    if norm_sq.is_finite() && norm_sq > f32::EPSILON {
        let inv_norm = 1.0 / norm_sq.sqrt();
        for value in sum {
            *value *= inv_norm;
        }
    } else {
        sum.fill(0.0);
    }
}

/// Exact former finish sequence retained only as an independently callable oracle.
#[cfg(any(test, feature = "bench-internals"))]
fn finish_mean_pool_and_normalize_former(sum: &mut [f32], count: usize) {
    #[allow(clippy::cast_precision_loss)]
    let inv = 1.0 / count as f32;
    for value in sum.iter_mut() {
        *value *= inv;
    }
    let norm_sq: f32 = sum.iter().map(|value| value * value).sum();
    if norm_sq.is_finite() && norm_sq > f32::EPSILON {
        let inv_norm = 1.0 / norm_sq.sqrt();
        for value in sum {
            *value *= inv_norm;
        }
    } else {
        sum.fill(0.0);
    }
}

fn validate_registered_execution_contract(
    identity: &EmbeddingIdentityBundleV1,
) -> SearchResult<()> {
    for (field, actual, expected) in [
        (
            "model preprocessing",
            identity.space.model_preprocessing.as_str(),
            MODEL2VEC_PREPROCESSING_V1,
        ),
        (
            "sequence policy",
            identity.space.sequence_policy.as_str(),
            MODEL2VEC_SEQUENCE_POLICY_V1,
        ),
        (
            "pooling",
            identity.space.pooling.as_str(),
            MODEL2VEC_POOLING_V1,
        ),
        (
            "output normalization",
            identity.space.output_normalization.as_str(),
            MODEL2VEC_OUTPUT_NORMALIZATION_V1,
        ),
    ] {
        if actual != expected {
            return Err(SearchError::InvalidConfig {
                field: "model2vec.execution_contract".to_owned(),
                value: identity.space.logical_model_id.clone(),
                reason: format!("registered {field} disagrees with the native Model2Vec backend"),
            });
        }
    }
    Ok(())
}

fn embed_checkpoint(cx: &Cx, phase: &'static str) -> SearchResult<()> {
    cx.checkpoint().map_err(|error| SearchError::Cancelled {
        phase: phase.to_owned(),
        reason: cx
            .cancel_reason()
            .map_or_else(|| error.to_string(), |reason| reason.to_string()),
    })
}

impl Embedder for Model2VecEmbedder {
    fn embed<'a>(&'a self, cx: &'a Cx, text: &'a str) -> SearchFuture<'a, Vec<f32>> {
        Box::pin(async move {
            embed_checkpoint(cx, "model2vec.embed")?;
            self.embed_sync(text)
        })
    }

    fn embed_batch<'a>(
        &'a self,
        cx: &'a Cx,
        texts: &'a [&'a str],
    ) -> SearchFuture<'a, Vec<Vec<f32>>> {
        Box::pin(async move {
            embed_checkpoint(cx, "model2vec.embed_batch")?;
            self.embed_batch_sync(texts)
        })
    }

    fn identity(&self) -> SearchResult<&EmbeddingIdentityBundleV1> {
        Ok(&self.identity)
    }

    fn dimension(&self) -> usize {
        self.dimensions
    }

    fn id(&self) -> &str {
        &self.name
    }

    fn model_name(&self) -> &str {
        &self.name
    }

    fn is_semantic(&self) -> bool {
        true
    }

    fn category(&self) -> ModelCategory {
        ModelCategory::StaticEmbedder
    }
}

/// Discover the embedding tensor name in a safetensors file.
///
/// Tries known names first, then falls back to using the only tensor
/// if the file contains exactly one.
fn discover_tensor_name(safetensors: &SafeTensors<'_>) -> Option<String> {
    let names = safetensors.names();

    // Try known candidate names
    for candidate in &TENSOR_NAME_CANDIDATES {
        if names.iter().any(|n| n == candidate) {
            return Some((*candidate).to_owned());
        }
    }

    // Fallback: if exactly one tensor exists, use it regardless of name
    if names.len() == 1 {
        return Some(names[0].to_owned());
    }

    None
}

/// Parse raw bytes from a safetensors tensor into a flat `Vec<f32>` matrix.
///
/// Expects little-endian f32 data with shape `[vocab_size, dimensions]`.
fn parse_f32_matrix(data: &[u8], vocab_size: usize, dimensions: usize) -> Result<Vec<f32>, String> {
    let expected_elements = vocab_size
        .checked_mul(dimensions)
        .ok_or_else(|| format!("matrix size overflow for [{vocab_size} x {dimensions}]"))?;
    let expected_bytes = expected_elements
        .checked_mul(4)
        .ok_or_else(|| format!("byte size overflow for [{vocab_size} x {dimensions}] f32"))?;
    if data.len() != expected_bytes {
        return Err(format!(
            "tensor data size mismatch: expected {expected_bytes} bytes for [{vocab_size} x {dimensions}] f32, got {}",
            data.len()
        ));
    }

    // Pre-allocate the exact size
    let mut matrix = Vec::with_capacity(expected_elements);

    // Parse bytes in 4-byte chunks (length is validated above to be a
    // multiple of 4, so `as_chunks` leaves no remainder)
    for &bytes in data.as_chunks::<4>().0 {
        matrix.push(f32::from_le_bytes(bytes));
    }

    if matrix.len() != expected_elements {
        return Err(format!(
            "parsed element count mismatch: expected {}, got {}",
            expected_elements,
            matrix.len()
        ));
    }

    Ok(matrix)
}

/// Search for a `Model2Vec` model directory in standard locations.
///
/// Checks these paths in order:
/// 1. `$FRANKENSEARCH_MODEL_DIR/<model_name>/`
/// 2. `$XDG_DATA_HOME/frankensearch/models/<model_name>/`
/// 3. `~/.local/share/frankensearch/models/<model_name>/` (or macOS
///    `~/Library/Application Support/frankensearch/models/<model_name>/`)
/// 4. `~/.cache/huggingface/hub/models--<hf_id>/snapshots/*/`
///
/// Returns `None` if no directory with the required files is found.
#[must_use]
pub fn find_model_dir(model_name: &str) -> Option<PathBuf> {
    find_model_dir_with_hf_id(model_name, DEFAULT_HF_ID)
}

/// Search for a `Model2Vec` model directory with a specific `HuggingFace` ID.
#[must_use]
pub fn find_model_dir_with_hf_id(model_name: &str, hf_id: &str) -> Option<PathBuf> {
    let mut candidates = Vec::new();

    // 1. Explicit env var override
    if let Ok(dir) = std::env::var("FRANKENSEARCH_MODEL_DIR") {
        let base = PathBuf::from(dir);
        for variant in model_directory_variants(model_name) {
            candidates.push(base.join(variant));
        }
        candidates.push(base);
    }

    // 2-3. Standard frankensearch model layout (created on first access)
    let model_root = ensure_model_storage_layout();
    for variant in model_directory_variants(model_name) {
        candidates.push(model_root.join(variant));
    }

    // 4. HuggingFace cache
    if let Some(cache_dir) = frankensearch_core::platform_dirs::cache_dir() {
        let hf_dir = cache_dir
            .join("huggingface/hub")
            .join(format!("models--{}", hf_id.replace('/', "--")));
        if let Ok(snapshots) = std::fs::read_dir(hf_dir.join("snapshots")) {
            for entry in snapshots.flatten() {
                candidates.push(entry.path());
            }
        }
    }

    // Check each candidate for required files
    for candidate in &candidates {
        if has_required_files(candidate) {
            return Some(candidate.clone());
        }
    }

    None
}

/// Check if a directory contains all required `Model2Vec` files.
fn has_required_files(dir: &Path) -> bool {
    REQUIRED_FILES.iter().all(|f| dir.join(f).exists())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::simd::{Model2VecAccumulationRoute, last_model2vec_accumulation_route_for_test};
    use std::fs;

    /// Create a minimal `Model2Vec` model in a temp directory for testing.
    ///
    /// Creates a tiny tokenizer and a small safetensors file with known values.
    fn create_test_model(dir: &Path, vocab_size: usize, dimensions: usize) {
        // Create a minimal tokenizer.json
        // This is a minimal valid HuggingFace tokenizer config
        let tokenizer_json = serde_json::json!({
            "version": "1.0",
            "truncation": null,
            "padding": null,
            "added_tokens": [
                {
                    "id": 0,
                    "content": "[UNK]",
                    "single_word": false,
                    "lstrip": false,
                    "rstrip": false,
                    "normalized": false,
                    "special": true
                }
            ],
            "normalizer": {
                "type": "Lowercase"
            },
            "pre_tokenizer": {
                "type": "Whitespace"
            },
            "post_processor": null,
            "decoder": null,
            "model": {
                "type": "WordLevel",
                "vocab": create_test_vocab(vocab_size),
                "unk_token": "[UNK]"
            }
        });

        fs::write(
            dir.join("tokenizer.json"),
            serde_json::to_string_pretty(&tokenizer_json).unwrap(),
        )
        .unwrap();

        // Create safetensors file with known embedding values
        create_test_safetensors(dir, vocab_size, dimensions);
    }

    /// Create a tokenizer fixture that exercises added tokens and truncation while retaining
    /// enough rows to pool every emitted ID.
    fn create_tokenizer_parity_model(dir: &Path) {
        let mut vocab = create_test_vocab(16)
            .as_object()
            .expect("test vocabulary is an object")
            .clone();
        vocab.insert("café".to_owned(), serde_json::Value::from(11));

        let tokenizer_json = serde_json::json!({
            "version": "1.0",
            "truncation": {
                "direction": "Right",
                "max_length": 512,
                "strategy": "LongestFirst",
                "stride": 0
            },
            "padding": null,
            "added_tokens": [
                {
                    "id": 0,
                    "content": "[UNK]",
                    "single_word": false,
                    "lstrip": false,
                    "rstrip": false,
                    "normalized": false,
                    "special": true
                },
                {
                    "id": 12,
                    "content": "<added>",
                    "single_word": false,
                    "lstrip": false,
                    "rstrip": false,
                    "normalized": true,
                    "special": false
                },
                {
                    "id": 13,
                    "content": "[SPECIAL]",
                    "single_word": false,
                    "lstrip": false,
                    "rstrip": false,
                    "normalized": false,
                    "special": true
                }
            ],
            "normalizer": {
                "type": "Lowercase"
            },
            "pre_tokenizer": {
                "type": "Whitespace"
            },
            "post_processor": null,
            "decoder": null,
            "model": {
                "type": "WordLevel",
                "vocab": vocab,
                "unk_token": "[UNK]"
            }
        });

        fs::write(
            dir.join("tokenizer.json"),
            serde_json::to_string_pretty(&tokenizer_json).unwrap(),
        )
        .unwrap();
        create_test_safetensors(dir, 16, 256);
    }

    /// Create a test vocabulary mapping words to token IDs.
    fn create_test_vocab(vocab_size: usize) -> serde_json::Value {
        let mut vocab = serde_json::Map::new();
        vocab.insert("[UNK]".to_owned(), serde_json::Value::from(0));

        let test_words = [
            "hello", "world", "test", "rust", "search", "embed", "vector", "model", "fast", "query",
        ];

        for (i, word) in test_words.iter().enumerate() {
            if i + 1 < vocab_size {
                vocab.insert((*word).to_owned(), serde_json::Value::from(i + 1));
            }
        }

        serde_json::Value::Object(vocab)
    }

    /// Create a minimal safetensors file with a known embedding matrix.
    fn create_test_safetensors(dir: &Path, vocab_size: usize, dimensions: usize) {
        use std::collections::HashMap;

        // Build embedding matrix: each row is [row_idx * 0.1, row_idx * 0.1 + 0.01, ...]
        let mut data = Vec::with_capacity(vocab_size * dimensions * 4);
        for row in 0..vocab_size {
            for col in 0..dimensions {
                #[allow(clippy::cast_precision_loss)]
                let val = (row as f32).mul_add(0.1, (col as f32) * 0.01);
                data.extend_from_slice(&val.to_le_bytes());
            }
        }

        let mut tensors = HashMap::new();
        tensors.insert(
            "embeddings".to_owned(),
            safetensors::tensor::TensorView::new(
                safetensors::Dtype::F32,
                vec![vocab_size, dimensions],
                &data,
            )
            .unwrap(),
        );

        let serialized = safetensors::tensor::serialize(&tensors, None).unwrap();
        fs::write(dir.join("model.safetensors"), serialized).unwrap();
    }

    // ── Loading ────────────────────────────────────────────────────────

    #[test]
    fn load_valid_model() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load_with_name(dir.path(), "test-model").unwrap();
        assert_eq!(embedder.dimensions, 8);
        assert_eq!(embedder.vocab_size, 12);
        assert_eq!(embedder.name, "test-model");
    }

    #[test]
    fn load_preverified_rejects_tensor_dimension_drift() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);
        let mut identity = EmbeddingIdentityBundleV1::explicit_test_model("dimension-drift", 7);
        identity.producer.backend = "attested-fixture-backend".to_owned();
        identity.validate().unwrap();

        let error = Model2VecEmbedder::load_preverified(dir.path(), "dimension-drift", identity)
            .expect_err("parsed tensor width must agree with the attested identity");
        assert!(matches!(error, SearchError::ModelLoadFailed { .. }));
    }

    #[test]
    fn registered_identity_matches_native_execution_contract() {
        let identity = ModelArtifactManifestV1::potion_128m_native()
            .unwrap()
            .declared_identity_bundle(QuantizationFormat::F32, "in-memory-f32-v1")
            .unwrap();
        validate_registered_execution_contract(&identity).unwrap();

        let mut drifted = identity;
        drifted.space.model_preprocessing.push_str("-drift");
        assert!(validate_registered_execution_contract(&drifted).is_err());
    }

    #[test]
    fn embed_batch_sync_matches_serial_across_parallel_boundary() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);
        let embedder = Model2VecEmbedder::load_with_name(dir.path(), "test-model").unwrap();

        // Straddle PARALLEL_BATCH_MIN so both the serial and Rayon paths are exercised.
        for &batch_size in &[0_usize, 1, PARALLEL_BATCH_MIN - 1, PARALLEL_BATCH_MIN, 17] {
            let docs: Vec<String> = (0..batch_size)
                .map(|i| format!("hello world test rust search {i}"))
                .collect();
            let texts: Vec<&str> = docs.iter().map(String::as_str).collect();

            let serial: Vec<Vec<f32>> = texts
                .iter()
                .map(|t| former_embed_sync(&embedder, t))
                .collect();
            let batched = embedder.embed_batch_sync(&texts).unwrap();

            assert_eq!(batched.len(), serial.len(), "len at n={batch_size}");
            for (index, (batched, former)) in batched.iter().zip(&serial).enumerate() {
                assert_f32_bits_eq(
                    batched,
                    former,
                    &format!("batch order or output diverged at n={batch_size}, index={index}"),
                );
            }
        }
    }

    #[test]
    fn load_missing_tokenizer() {
        let dir = tempfile::tempdir().unwrap();
        // Only create safetensors, not tokenizer
        create_test_safetensors(dir.path(), 10, 4);

        let result = Model2VecEmbedder::load(dir.path());
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(
            matches!(err, SearchError::ModelNotFound { .. }),
            "expected ModelNotFound, got {err:?}"
        );
    }

    #[test]
    fn load_missing_safetensors() {
        let dir = tempfile::tempdir().unwrap();
        // Only create tokenizer
        fs::write(dir.path().join("tokenizer.json"), "{}").unwrap();

        let result = Model2VecEmbedder::load(dir.path());
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            SearchError::ModelNotFound { .. }
        ));
    }

    #[test]
    fn load_nonexistent_directory() {
        let result = Model2VecEmbedder::load("/nonexistent/path/to/model");
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            SearchError::ModelNotFound { .. }
        ));
    }

    // ── Embedding ──────────────────────────────────────────────────────

    #[test]
    fn embed_produces_correct_dimension() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let vec = embedder.embed_sync("hello world").unwrap();
        assert_eq!(vec.len(), 8);
    }

    #[test]
    fn embed_output_is_l2_normalized() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let vec = embedder.embed_sync("hello world").unwrap();

        let norm: f32 = vec.iter().map(|x| x * x).sum::<f32>().sqrt();
        assert!((norm - 1.0).abs() < 1e-5, "expected unit norm, got {norm}");
    }

    #[test]
    fn embed_empty_string_returns_zero_vector() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let vec = embedder.embed_sync("").unwrap();
        assert_eq!(vec.len(), 8);
        assert!(vec.iter().all(|&x| x == 0.0));
    }

    #[test]
    fn embed_deterministic() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let a = embedder.embed_sync("hello world").unwrap();
        let b = embedder.embed_sync("hello world").unwrap();
        assert_eq!(a, b, "same input must produce same output");
    }

    #[test]
    fn embed_different_inputs_different_outputs() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let a = embedder.embed_sync("hello").unwrap();
        let b = embedder.embed_sync("world").unwrap();
        assert_ne!(a, b, "different inputs should produce different embeddings");
    }

    #[test]
    fn embed_sync_observes_offset_free_tokenizer_route() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);
        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();

        let former = embedder.tokenizer.encode("hello world", false).unwrap();
        assert!(
            former.get_tokens().iter().any(|token| !token.is_empty()),
            "the former encode route must materialize token text for this planted route witness"
        );

        embedder.embed_sync("hello world").unwrap();
        assert!(
            embedder.last_tokenizer_route_was_offset_free(),
            "shipping Model2Vec must retain the encode_fast offset-free tokenizer route"
        );
    }

    #[test]
    fn encode_fast_token_ids_and_vectors_match_former_oracle() {
        let dir = tempfile::tempdir().unwrap();
        create_tokenizer_parity_model(dir.path());
        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();

        let mut inputs = crate::model_manifest::MODEL_CONFORMANCE_TEXTS_V1
            .iter()
            .map(|text| (*text).to_owned())
            .collect::<Vec<_>>();
        inputs.extend([
            String::new(),
            "HELLO world".to_owned(),
            "CAFÉ cafe\u{301}".to_owned(),
            "hello 東京 world".to_owned(),
            "definitely-oov-token".to_owned(),
            "hello <ADDED> [SPECIAL] world".to_owned(),
        ]);

        for tokens in [511_usize, 512, 513] {
            inputs.push(
                std::iter::repeat_n("hello", tokens)
                    .collect::<Vec<_>>()
                    .join(" "),
            );
        }

        for input in &inputs {
            assert_fast_ids_and_former_vector_bits(&embedder, input, input);
        }

        let special_ids = former_token_ids(&embedder, "hello <ADDED> [SPECIAL] world");
        assert!(
            special_ids.contains(&12) && special_ids.contains(&13),
            "fixture must exercise both the normalized added token and the added special token"
        );
        for tokens in [511_usize, 512, 513] {
            let input = std::iter::repeat_n("hello", tokens)
                .collect::<Vec<_>>()
                .join(" ");
            let expected_len = tokens.min(512);
            let former_ids = former_token_ids(&embedder, &input);
            let fast_ids = embedder
                .tokenizer
                .encode_fast(input.as_str(), false)
                .unwrap()
                .get_ids()
                .to_vec();
            assert_eq!(
                former_ids.len(),
                expected_len,
                "former tokenizer truncation at {tokens} input tokens"
            );
            assert_eq!(
                fast_ids.len(),
                expected_len,
                "fast tokenizer truncation at {tokens} input tokens"
            );
        }

        let texts = inputs.iter().map(String::as_str).collect::<Vec<_>>();
        let former = texts
            .iter()
            .map(|text| former_embed_sync(&embedder, text))
            .collect::<Vec<_>>();
        let batched = embedder.embed_batch_sync(&texts).unwrap();
        assert_eq!(batched.len(), former.len());
        for (index, (actual, expected)) in batched.iter().zip(&former).enumerate() {
            assert_f32_bits_eq(
                actual,
                expected,
                &format!("batch order or vector bits changed at index={index}"),
            );
        }
    }

    /// The former `embed_sync` pooling and finish sequence, retained independently
    /// of the production gather helper for exact native-256 parity checks.
    fn former_embed_sync(embedder: &Model2VecEmbedder, text: &str) -> Vec<f32> {
        if text.is_empty() {
            return vec![0.0; embedder.dimensions];
        }

        let token_ids = former_token_ids(embedder, text);
        former_embed_token_ids(embedder, &token_ids)
    }

    fn former_embed_token_ids(embedder: &Model2VecEmbedder, token_ids: &[u32]) -> Vec<f32> {
        let mut sum = vec![0.0_f32; embedder.dimensions];
        let mut count = 0_usize;
        for &token_id in token_ids {
            let index = token_id as usize;
            if index < embedder.vocab_size {
                let start = index * embedder.dimensions;
                crate::simd::accumulate_f32_into(
                    &mut sum,
                    &embedder.embeddings[start..start + embedder.dimensions],
                );
                count += 1;
            }
        }
        if count == 0 {
            return vec![0.0; embedder.dimensions];
        }

        finish_mean_pool_and_normalize_former(&mut sum, count);
        sum
    }

    fn former_token_ids(embedder: &Model2VecEmbedder, text: &str) -> Vec<u32> {
        embedder
            .tokenizer
            .encode(text, false)
            .unwrap()
            .get_ids()
            .to_vec()
    }

    fn assert_fast_ids_and_former_vector_bits(
        embedder: &Model2VecEmbedder,
        text: &str,
        scenario: &str,
    ) {
        let former_ids = former_token_ids(embedder, text);
        let fast_ids = embedder
            .tokenizer
            .encode_fast(text, false)
            .unwrap()
            .get_ids()
            .to_vec();
        assert_eq!(fast_ids, former_ids, "token IDs diverged for {scenario}");

        let expected = former_embed_sync(embedder, text);
        let actual = embedder.embed_sync(text).unwrap();
        assert_f32_bits_eq(&actual, &expected, scenario);
    }

    fn assert_f32_bits_eq(actual: &[f32], expected: &[f32], scenario: &str) {
        assert_eq!(
            actual
                .iter()
                .map(|value| value.to_bits())
                .collect::<Vec<_>>(),
            expected
                .iter()
                .map(|value| value.to_bits())
                .collect::<Vec<_>>(),
            "{scenario}"
        );
    }

    fn expected_native_256_route(token_count: usize) -> Model2VecAccumulationRoute {
        #[cfg(target_arch = "x86_64")]
        {
            if token_count < 512 {
                if std::is_x86_feature_detected!("avx2") {
                    Model2VecAccumulationRoute::Native256ShortAvx2
                } else {
                    Model2VecAccumulationRoute::Base
                }
            } else {
                Model2VecAccumulationRoute::Prefetched
            }
        }

        #[cfg(not(target_arch = "x86_64"))]
        {
            let _ = token_count;
            Model2VecAccumulationRoute::Base
        }
    }

    #[test]
    fn native_256_embed_sync_matches_former_pool_and_finish_bits() {
        const DIMENSIONS: usize = 256;
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, DIMENSIONS);
        let mut embedder = Model2VecEmbedder::load(dir.path()).unwrap();

        for &tokens in &[0_usize, 1, 2, 3, 4, 8, 16, 32, 64, 511, 512, 513] {
            let text = (0..tokens)
                .map(|position| match position % 4 {
                    0 => "hello",
                    1 => "world",
                    2 => "missing-token",
                    _ => "hello",
                })
                .collect::<Vec<_>>()
                .join(" ");
            let expected = former_embed_sync(&embedder, &text);
            let actual = embedder.embed_sync(&text).unwrap();
            assert_f32_bits_eq(&actual, &expected, &format!("tokens={tokens}"));
            assert_eq!(
                embedder
                    .tokenizer
                    .encode_fast(text.as_str(), false)
                    .unwrap()
                    .get_ids(),
                former_token_ids(&embedder, &text),
                "token IDs at native-256 boundary tokens={tokens}"
            );
            if !text.is_empty() {
                let token_count = embedder
                    .tokenizer
                    .encode(text.as_str(), false)
                    .unwrap()
                    .len();
                assert_eq!(
                    last_model2vec_accumulation_route_for_test(),
                    expected_native_256_route(token_count),
                    "shipping embed_sync route for {tokens} input words ({token_count} token IDs)"
                );
            }
        }

        for text in [
            "hello caf\u{e9} world",
            "hello \u{6771}\u{4eac} hello",
            "HELLO hello HELLO",
        ] {
            let expected = former_embed_sync(&embedder, text);
            let actual = embedder.embed_sync(text).unwrap();
            assert_f32_bits_eq(&actual, &expected, text);
        }

        let hello = DIMENSIONS..DIMENSIONS * 2;
        embedder.embeddings[hello.clone()].fill(-0.0);
        let expected = former_embed_sync(&embedder, "hello hello");
        let actual = embedder.embed_sync("hello hello").unwrap();
        assert_f32_bits_eq(&actual, &expected, "signed-zero row");

        embedder.embeddings[hello.clone()].fill(1.0e-20);
        let expected = former_embed_sync(&embedder, "hello");
        let actual = embedder.embed_sync("hello").unwrap();
        assert_f32_bits_eq(&actual, &expected, "below normalization guard");

        embedder.embeddings[hello.clone()].fill(1.0e-4);
        let expected = former_embed_sync(&embedder, "hello");
        let actual = embedder.embed_sync("hello").unwrap();
        assert_f32_bits_eq(&actual, &expected, "above normalization guard");

        embedder.embeddings[hello].fill(f32::NAN);
        let expected = former_embed_sync(&embedder, "hello world hello");
        let actual = embedder.embed_sync("hello world hello").unwrap();
        assert_f32_bits_eq(&actual, &expected, "non-finite pooled row");
    }

    #[test]
    fn fused_mean_and_ordered_norm_finish_matches_former_bits() {
        let arbitrary_initial_sum = (0_u32..256)
            .map(|index| {
                let value = f32::from_bits(0x3f80_0000 + index);
                if index % 2 == 0 { value } else { -value }
            })
            .collect::<Vec<_>>();
        let cases = vec![
            ("arbitrary finite sum", arbitrary_initial_sum),
            (
                "normalization guard boundary",
                vec![f32::MIN_POSITIVE, f32::EPSILON.sqrt(), -f32::EPSILON.sqrt()],
            ),
            ("signed zero", vec![-0.0, 0.0, -0.0, 0.0]),
            (
                "non-finite values",
                vec![f32::NAN, f32::INFINITY, f32::NEG_INFINITY, f32::MAX],
            ),
        ];

        for (label, initial_sum) in cases {
            for &count in &[1_usize, 2, 3, 4, 511, 512, 513] {
                let mut former = initial_sum.clone();
                let mut fused = initial_sum.clone();
                finish_mean_pool_and_normalize_former(&mut former, count);
                finish_mean_pool_and_normalize(&mut fused, count);
                assert_f32_bits_eq(&fused, &former, &format!("{label}, count={count}"));
            }
        }
    }

    #[test]
    fn full_embed_sync_fused_finish_matches_former_bits_across_shapes_and_values() {
        for &dimensions in &[1_usize, 255, 256, 257] {
            let dir = tempfile::tempdir().unwrap();
            create_test_model(dir.path(), 12, dimensions);
            let mut embedder = Model2VecEmbedder::load(dir.path()).unwrap();

            let mut full_embed_sync_corpus =
                vec![String::new(), "hello definitely-oov-token hello".to_owned()];
            for token_count in [1_usize, 2, 3, 4, 511, 512, 513] {
                full_embed_sync_corpus.push(
                    std::iter::repeat_n("hello", token_count)
                        .collect::<Vec<_>>()
                        .join(" "),
                );
            }

            let oov_grouping_ids = former_token_ids(&embedder, &full_embed_sync_corpus[1]);
            assert!(
                oov_grouping_ids.contains(&0),
                "the full embed_sync OOV grouping corpus must emit the [UNK] token at dim={dimensions}"
            );

            let hello = dimensions..dimensions * 2;
            for (lane, value) in embedder.embeddings[hello.clone()].iter_mut().enumerate() {
                let lane = u32::try_from(lane).expect("fixture dimension fits u32");
                let magnitude = f32::from_bits(0x3f80_0000 + lane);
                *value = if lane % 2 == 0 { magnitude } else { -magnitude };
            }
            for text in &full_embed_sync_corpus {
                assert_fast_ids_and_former_vector_bits(
                    &embedder,
                    text,
                    &format!("finite full embed_sync corpus dim={dimensions}"),
                );
            }

            #[allow(clippy::cast_precision_loss)]
            let guard_center = (f32::EPSILON / dimensions as f32).sqrt();
            let below_guard = f32::from_bits(guard_center.to_bits() - 1);
            let above_guard = f32::from_bits(guard_center.to_bits() + 1);
            for (scenario, value) in [
                ("subnormal", f32::from_bits(1)),
                ("below guard", below_guard),
                ("above guard", above_guard),
                ("signed zero", -0.0),
                ("NaN", f32::from_bits(0x7fc0_0001)),
                ("infinity", f32::INFINITY),
            ] {
                embedder.embeddings[hello.clone()].fill(value);
                for text in &full_embed_sync_corpus {
                    assert_fast_ids_and_former_vector_bits(
                        &embedder,
                        text,
                        &format!("{scenario} full embed_sync corpus dim={dimensions}"),
                    );
                }
            }

            let invalid_token_ids = [
                1_u32,
                u32::try_from(embedder.vocab_size).expect("fixture vocabulary fits u32"),
                u32::MAX,
                2_u32,
            ];
            let former = former_embed_token_ids(&embedder, &invalid_token_ids);
            let fused = embedder.embed_token_ids(&invalid_token_ids);
            assert_f32_bits_eq(
                &fused,
                &former,
                &format!("mixed valid/OOV token IDs dim={dimensions}"),
            );

            let all_oov_token_ids = [
                u32::try_from(embedder.vocab_size).expect("fixture vocabulary fits u32"),
                u32::MAX,
            ];
            let former = former_embed_token_ids(&embedder, &all_oov_token_ids);
            let fused = embedder.embed_token_ids(&all_oov_token_ids);
            assert_f32_bits_eq(
                &fused,
                &former,
                &format!("all OOV token IDs dim={dimensions}"),
            );
        }
    }

    // ── OOV Handling ───────────────────────────────────────────────────

    #[test]
    fn embed_all_oov_returns_zero_vector() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        // "zzzzzzz" is not in our test vocab
        let vec = embedder.embed_sync("xyzxyzxyz qqqqq").unwrap();
        // All tokens should be OOV → zero vector
        assert_eq!(vec.len(), 8);
    }

    // ── Embedder Trait ─────────────────────────────────────────────────

    #[test]
    fn trait_is_semantic() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert!(embedder.is_semantic());
    }

    #[test]
    fn trait_category_is_static() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert_eq!(embedder.category(), ModelCategory::StaticEmbedder);
    }

    #[test]
    fn trait_dimension() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert_eq!(embedder.dimension(), 8);
    }

    #[test]
    fn trait_does_not_infer_mrl_from_model2vec_backend() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert!(!embedder.supports_mrl());
    }

    #[test]
    fn trait_id_and_name() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load_with_name(dir.path(), "my-model").unwrap();
        assert_eq!(embedder.id(), "my-model");
        assert_eq!(embedder.model_name(), "my-model");
    }

    // ── Thread Safety ──────────────────────────────────────────────────

    #[test]
    fn embedder_is_send_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<Model2VecEmbedder>();
    }

    /// Bit-exact producer conformance proof for the frozen potion manifest.
    #[test]
    #[ignore = "requires a verified potion model dir via POTION_FIXTURE_DIR"]
    fn conformance_certificate_matches_fixture() {
        let dir = std::env::var("POTION_FIXTURE_DIR")
            .expect("set POTION_FIXTURE_DIR to a potion-multilingual-128M directory");
        let manifest = crate::model_manifest::ModelArtifactManifestV1::potion_128m_native()
            .expect("registered potion manifest");
        let verified = manifest
            .verify_dir(Path::new(&dir))
            .expect("verify frozen potion artifacts");
        let expected_identity = verified
            .identity_bundle(QuantizationFormat::F32, "in-memory-f32-v1")
            .expect("derive verified potion identity");
        let embedder = Model2VecEmbedder::load_preverified(
            Path::new(&dir),
            DEFAULT_MODEL_NAME,
            expected_identity.clone(),
        )
        .expect("load verified potion embedder");
        assert_eq!(embedder.identity().unwrap(), &expected_identity);

        let added_vocabulary = embedder.tokenizer.get_added_vocabulary().get_vocab();
        let pad_id = *added_vocabulary
            .get("[PAD]")
            .expect("verified Potion tokenizer must retain [PAD] as an added special token");
        let unk_id = *added_vocabulary
            .get("[UNK]")
            .expect("verified Potion tokenizer must retain [UNK] as an added special token");
        let added_special_text = "hello [PAD] [UNK] world";
        let long_over_512_text = std::iter::repeat_n("hello", 1024)
            .collect::<Vec<_>>()
            .join(" ");
        let mut parity_texts = crate::model_manifest::MODEL_CONFORMANCE_TEXTS_V1
            .iter()
            .map(|text| (*text).to_owned())
            .collect::<Vec<_>>();
        parity_texts.extend([
            "Caf\u{e9} na\u{ef}ve \u{2014} \u{6771}\u{4eac} \u{1f980}".to_owned(),
            added_special_text.to_owned(),
            "\tmetaspace  boundaries\tand unseen-oov-\u{10ffff}".to_owned(),
            long_over_512_text.clone(),
        ]);
        for text in &parity_texts {
            assert_fast_ids_and_former_vector_bits(
                &embedder,
                text,
                "verified Potion tokenizer parity input",
            );
        }

        let added_special_ids = former_token_ids(&embedder, added_special_text);
        assert!(
            added_special_ids.contains(&pad_id) && added_special_ids.contains(&unk_id),
            "verified Potion tokenizer must emit both literal added special-token IDs"
        );
        let former_long = embedder
            .tokenizer
            .encode(long_over_512_text.as_str(), false)
            .expect("encode long verified Potion input");
        let fast_long = embedder
            .tokenizer
            .encode_fast(long_over_512_text.as_str(), false)
            .expect("encode_fast long verified Potion input");
        assert!(
            embedder.tokenizer.get_truncation().is_none(),
            "registered Potion tokenizer must preserve its configured no-truncation policy"
        );
        assert!(
            former_long.len() > 512,
            "long verified Potion input must exceed the former 512-token synthetic boundary"
        );
        assert_eq!(
            fast_long.len(),
            former_long.len(),
            "verified Potion long-input token count diverged"
        );
        assert_eq!(
            fast_long.get_ids(),
            former_long.get_ids(),
            "verified Potion long-input token IDs diverged"
        );
        assert!(
            former_long.get_overflowing().is_empty() && fast_long.get_overflowing().is_empty(),
            "configured no-truncation policy must not emit overflow encodings"
        );

        let texts = &crate::model_manifest::MODEL_CONFORMANCE_TEXTS_V1;
        let former_vectors = texts
            .iter()
            .map(|text| {
                assert_fast_ids_and_former_vector_bits(
                    &embedder,
                    text,
                    "verified Potion conformance input",
                );
                former_embed_sync(&embedder, text)
            })
            .collect::<Vec<_>>();
        let vectors = embedder
            .embed_batch_sync(texts)
            .expect("embed bounded conformance corpus");
        assert_eq!(vectors.len(), former_vectors.len());
        for (index, (actual, expected)) in vectors.iter().zip(&former_vectors).enumerate() {
            assert_f32_bits_eq(
                actual,
                expected,
                &format!("verified Potion batch order or vector bits changed at index={index}"),
            );
        }
        let observed = frankensearch_core::generation::GoldenVectorCertificateV1::from_exact_f32(
            texts, &vectors,
        )
        .expect("compute exact conformance certificate");
        let expected = manifest.execution.golden_vectors;
        assert_eq!(
            observed, expected,
            "Model2Vec output bits drifted from the registered producer certificate"
        );
    }

    // ── Debug impl ─────────────────────────────────────────────────────

    #[test]
    fn debug_does_not_dump_embeddings() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 12, 8);

        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        let debug = format!("{embedder:?}");
        assert!(debug.contains("Model2VecEmbedder"));
        assert!(debug.contains("dimensions: 8"));
        assert!(debug.contains("vocab_size: 12"));
        // Must NOT contain actual embedding data
        assert!(!debug.contains("0.1"));
    }

    // ── Tensor Discovery ───────────────────────────────────────────────

    #[test]
    fn tensor_discovery_finds_standard_name() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 4, 2);

        // The test model uses "embeddings" as tensor name
        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert_eq!(embedder.vocab_size, 4);
    }

    #[test]
    fn tensor_discovery_single_tensor_fallback() {
        let dir = tempfile::tempdir().unwrap();

        // Create tokenizer
        let tokenizer_json = serde_json::json!({
            "version": "1.0",
            "added_tokens": [],
            "model": {
                "type": "WordLevel",
                "vocab": {"hello": 0, "world": 1},
                "unk_token": "hello"
            }
        });
        fs::write(
            dir.path().join("tokenizer.json"),
            serde_json::to_string(&tokenizer_json).unwrap(),
        )
        .unwrap();

        // Create safetensors with a non-standard tensor name
        let mut data = vec![0u8; 2 * 3 * 4]; // 2 rows × 3 dims × 4 bytes
        for (i, chunk) in data.as_chunks_mut::<4>().0.iter_mut().enumerate() {
            #[allow(clippy::cast_precision_loss)]
            let val = i as f32;
            chunk.copy_from_slice(&val.to_le_bytes());
        }

        let mut tensors = std::collections::HashMap::new();
        tensors.insert(
            "my_custom_tensor_name".to_owned(),
            safetensors::tensor::TensorView::new(safetensors::Dtype::F32, vec![2, 3], &data)
                .unwrap(),
        );

        let serialized = safetensors::tensor::serialize(&tensors, None).unwrap();
        fs::write(dir.path().join("model.safetensors"), serialized).unwrap();

        // Should fall back to the single tensor
        let embedder = Model2VecEmbedder::load(dir.path()).unwrap();
        assert_eq!(embedder.vocab_size, 2);
        assert_eq!(embedder.dimensions, 3);
    }

    // ── Model Directory Search ─────────────────────────────────────────

    #[test]
    fn has_required_files_positive() {
        let dir = tempfile::tempdir().unwrap();
        create_test_model(dir.path(), 4, 2);
        assert!(has_required_files(dir.path()));
    }

    #[test]
    fn has_required_files_negative() {
        let dir = tempfile::tempdir().unwrap();
        assert!(!has_required_files(dir.path()));
    }

    // ── Parse Matrix ───────────────────────────────────────────────────

    #[test]
    fn parse_f32_matrix_correct() {
        // 2 rows × 2 dims = 16 bytes
        let data: Vec<u8> = [1.0_f32, 2.0, 3.0, 4.0]
            .iter()
            .flat_map(|f| f.to_le_bytes())
            .collect();

        let matrix = parse_f32_matrix(&data, 2, 2).unwrap();
        assert_eq!(matrix.len(), 4);
        assert_eq!(&matrix[0..2], &[1.0, 2.0]);
        assert_eq!(&matrix[2..4], &[3.0, 4.0]);
    }

    #[test]
    fn parse_f32_matrix_too_short() {
        let data = vec![0u8; 4]; // Only 1 float, need more
        let result = parse_f32_matrix(&data, 2, 2);
        assert!(result.is_err());
    }

    #[test]
    fn parse_f32_matrix_too_long() {
        // 16 bytes expected for [2 x 2] f32, plus one trailing garbage byte
        let mut data: Vec<u8> = [1.0_f32, 2.0, 3.0, 4.0]
            .iter()
            .flat_map(|f| f.to_le_bytes())
            .collect();
        data.push(0xAA);

        let result = parse_f32_matrix(&data, 2, 2);
        assert!(result.is_err());
    }

    #[test]
    fn parse_f32_matrix_size_overflow() {
        let result = parse_f32_matrix(&[], usize::MAX, 2);
        assert!(result.is_err());
    }
}