anno 0.8.0

NER, coreference resolution, relation extraction, PII detection, and zero-shot entity types
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
use super::*;

#[test]
fn test_encoder_config_defaults() {
    let bert = EncoderConfig::bert_base();
    assert_eq!(bert.hidden_size, 768);
    assert_eq!(bert.max_position_embeddings, 512);
    assert!(!bert.use_rope);

    let modern = EncoderConfig::modernbert_base();
    assert_eq!(modern.hidden_size, 768);
    assert_eq!(modern.max_position_embeddings, 8192);
    assert!(modern.use_rope);
    assert!(modern.use_geglu);
}

#[test]
fn test_modernbert_large() {
    let config = EncoderConfig::modernbert_large();
    assert_eq!(config.hidden_size, 1024);
    assert_eq!(config.num_hidden_layers, 28);
}

#[test]
fn test_deberta_v3_base_config() {
    let config = EncoderConfig::deberta_v3_base();
    assert_eq!(config.vocab_size, 128100);
    assert_eq!(config.hidden_size, 768);
    assert_eq!(config.num_attention_heads, 12);
    assert_eq!(config.num_hidden_layers, 12);
    assert_eq!(config.intermediate_size, 3072);
    assert_eq!(config.max_position_embeddings, 512);
    assert!(!config.use_rope);
    assert!(!config.use_geglu);
    assert!(config.use_pre_norm);
    assert!((config.layer_norm_eps - 1e-7).abs() < 1e-15);
}

#[test]
fn test_deberta_v3_large_config() {
    let config = EncoderConfig::deberta_v3_large();
    assert_eq!(config.vocab_size, 128100);
    assert_eq!(config.hidden_size, 1024);
    assert_eq!(config.num_attention_heads, 16);
    assert_eq!(config.num_hidden_layers, 24);
    assert_eq!(config.intermediate_size, 4096);
    assert_eq!(config.max_position_embeddings, 512);
    assert!(!config.use_rope);
    assert!(!config.use_geglu);
    assert!(config.use_pre_norm);
    // Shared vocab and eps with base
    assert_eq!(
        config.vocab_size,
        EncoderConfig::deberta_v3_base().vocab_size
    );
    assert!(
        (config.layer_norm_eps - EncoderConfig::deberta_v3_base().layer_norm_eps).abs() < 1e-15
    );
}

#[test]
fn test_modernbert_base_config() {
    let config = EncoderConfig::modernbert_base();
    assert_eq!(config.vocab_size, 50368);
    assert_eq!(config.hidden_size, 768);
    assert_eq!(config.num_attention_heads, 12);
    assert_eq!(config.num_hidden_layers, 22);
    assert_eq!(config.intermediate_size, 1152);
    assert_eq!(config.max_position_embeddings, 8192);
    assert!(config.use_rope);
    assert!(config.use_geglu);
    assert!(config.use_pre_norm);
    assert_eq!(config.hidden_dropout_prob, 0.0);
    assert!((config.rope_theta - 160000.0).abs() < f64::EPSILON);
}

#[test]
fn test_from_model_name_dispatch() {
    // ModernBERT variants
    let cfg = EncoderConfig::from_model_name("answerdotai/ModernBERT-base");
    assert_eq!(cfg.hidden_size, 768);
    assert!(cfg.use_rope);
    assert_eq!(cfg.num_hidden_layers, 22);

    let cfg = EncoderConfig::from_model_name("answerdotai/ModernBERT-large");
    assert_eq!(cfg.hidden_size, 1024);
    assert_eq!(cfg.num_hidden_layers, 28);

    // DeBERTa variants
    let cfg = EncoderConfig::from_model_name("microsoft/deberta-v3-base");
    assert_eq!(cfg.hidden_size, 768);
    assert_eq!(cfg.vocab_size, 128100);
    assert!(!cfg.use_rope);

    let cfg = EncoderConfig::from_model_name("microsoft/deberta-v3-large");
    assert_eq!(cfg.hidden_size, 1024);
    assert_eq!(cfg.num_hidden_layers, 24);

    // Unknown model falls back to BERT-base
    let cfg = EncoderConfig::from_model_name("some-unknown/model-name");
    assert_eq!(cfg.hidden_size, 768);
    assert_eq!(cfg.vocab_size, 30522);
    assert!(!cfg.use_rope);
    assert!(!cfg.use_geglu);
}

#[test]
fn test_from_model_name_case_insensitive() {
    // Dispatch should be case-insensitive
    let lower = EncoderConfig::from_model_name("modernbert-base");
    let upper = EncoderConfig::from_model_name("MODERNBERT-BASE");
    assert_eq!(lower.hidden_size, upper.hidden_size);
    assert_eq!(lower.num_hidden_layers, upper.num_hidden_layers);

    let lower = EncoderConfig::from_model_name("deberta-large");
    let upper = EncoderConfig::from_model_name("DEBERTA-LARGE");
    assert_eq!(lower.hidden_size, upper.hidden_size);
    assert_eq!(lower.num_hidden_layers, upper.num_hidden_layers);
}

#[test]
fn test_architecture_properties() {
    // RoPE: only ModernBERT
    assert!(EncoderArchitecture::ModernBert.uses_rope());
    assert!(!EncoderArchitecture::Bert.uses_rope());
    assert!(!EncoderArchitecture::DeBertaV3.uses_rope());

    // Max length: 512 for BERT/DeBERTa, 8192 for ModernBERT
    assert_eq!(EncoderArchitecture::Bert.max_length(), 512);
    assert_eq!(EncoderArchitecture::DeBertaV3.max_length(), 512);
    assert_eq!(EncoderArchitecture::ModernBert.max_length(), 8192);

    // Display strings
    assert_eq!(EncoderArchitecture::Bert.as_str(), "BERT");
    assert_eq!(EncoderArchitecture::DeBertaV3.as_str(), "DeBERTa-v3");
    assert_eq!(EncoderArchitecture::ModernBert.as_str(), "ModernBERT");
}

#[test]
fn test_architecture_default_config_consistency() {
    // default_config() should return the same config as the named constructor
    let arch_cfg = EncoderArchitecture::Bert.default_config();
    let direct_cfg = EncoderConfig::bert_base();
    assert_eq!(arch_cfg.hidden_size, direct_cfg.hidden_size);
    assert_eq!(arch_cfg.num_hidden_layers, direct_cfg.num_hidden_layers);
    assert_eq!(arch_cfg.vocab_size, direct_cfg.vocab_size);

    let arch_cfg = EncoderArchitecture::ModernBert.default_config();
    let direct_cfg = EncoderConfig::modernbert_base();
    assert_eq!(arch_cfg.hidden_size, direct_cfg.hidden_size);
    assert_eq!(arch_cfg.num_hidden_layers, direct_cfg.num_hidden_layers);
    assert_eq!(arch_cfg.use_rope, direct_cfg.use_rope);

    let arch_cfg = EncoderArchitecture::DeBertaV3.default_config();
    let direct_cfg = EncoderConfig::deberta_v3_base();
    assert_eq!(arch_cfg.hidden_size, direct_cfg.hidden_size);
    assert_eq!(arch_cfg.num_hidden_layers, direct_cfg.num_hidden_layers);
}

#[test]
fn test_architecture_default_is_modernbert() {
    let arch = EncoderArchitecture::default();
    assert_eq!(arch, EncoderArchitecture::ModernBert);
}

#[test]
fn test_encoder_config_default_is_bert_base() {
    let cfg = EncoderConfig::default();
    let bert = EncoderConfig::bert_base();
    assert_eq!(cfg.hidden_size, bert.hidden_size);
    assert_eq!(cfg.vocab_size, bert.vocab_size);
    assert_eq!(cfg.num_hidden_layers, bert.num_hidden_layers);
}

#[cfg(feature = "candle")]
#[test]
fn test_geglu() {
    use candle_core::{Device, Tensor};

    let device = Device::Cpu;
    let x = Tensor::randn(0f32, 1., (2, 8), &device).unwrap();
    let result = super::implementations::candle_impl::geglu(&x);
    assert!(result.is_ok());
    let result = result.unwrap();
    assert_eq!(result.dims(), &[2, 4]);
}

#[cfg(feature = "candle")]
#[test]
fn test_geglu_various_sizes() {
    use candle_core::{Device, Tensor};

    let device = Device::Cpu;

    // GeGLU always halves the last dimension
    for dim in [4, 16, 64, 256] {
        let x = Tensor::randn(0f32, 1., (1, dim), &device).unwrap();
        let result = super::implementations::candle_impl::geglu(&x).unwrap();
        assert_eq!(
            result.dims(),
            &[1, dim / 2],
            "GeGLU should halve dim={}",
            dim
        );
    }

    // Batch dimension preserved
    let x = Tensor::randn(0f32, 1., (5, 32), &device).unwrap();
    let result = super::implementations::candle_impl::geglu(&x).unwrap();
    assert_eq!(result.dims(), &[5, 16]);
}

#[cfg(feature = "candle")]
#[test]
fn test_rope_cache_shape() {
    use super::implementations::candle_impl::RotaryEmbedding;
    use candle_core::Device;

    let head_dim = 64;
    let max_seq_len = 128;
    let theta = 10000.0;
    let device = Device::Cpu;

    let rope = RotaryEmbedding::new(head_dim, max_seq_len, theta, &device).unwrap();

    // Apply to a tensor: [batch=1, seq=16, heads=1, head_dim=64]
    // (RoPE broadcasts cos/sin over the head dimension via unsqueeze)
    let x = candle_core::Tensor::randn(0f32, 1., (1, 16, 1, head_dim), &device).unwrap();
    let result = rope.apply(&x, 0).unwrap();

    // Output shape must match input shape exactly
    assert_eq!(result.dims(), &[1, 16, 1, head_dim]);

    // Verify partial-sequence apply (start_pos > 0)
    let x_short = candle_core::Tensor::randn(0f32, 1., (1, 8, 1, head_dim), &device).unwrap();
    let result = rope.apply(&x_short, 10).unwrap();
    assert_eq!(result.dims(), &[1, 8, 1, head_dim]);
}

#[cfg(feature = "candle")]
#[test]
fn test_best_device_returns_ok() {
    // best_device() should always succeed (falls back to CPU)
    let device = super::implementations::candle_impl::best_device();
    assert!(device.is_ok());
}

// =========================================================================
// Architecture: default_model_id dispatch
// =========================================================================

#[test]
fn test_architecture_default_model_ids() {
    assert_eq!(
        EncoderArchitecture::Bert.default_model_id(),
        "google-bert/bert-base-uncased"
    );
    assert_eq!(
        EncoderArchitecture::DeBertaV3.default_model_id(),
        "microsoft/deberta-v3-base"
    );
    assert_eq!(
        EncoderArchitecture::ModernBert.default_model_id(),
        "answerdotai/ModernBERT-base"
    );
}

// =========================================================================
// Architecture: Display trait
// =========================================================================

#[test]
fn test_architecture_display() {
    assert_eq!(format!("{}", EncoderArchitecture::Bert), "BERT");
    assert_eq!(format!("{}", EncoderArchitecture::DeBertaV3), "DeBERTa-v3");
    assert_eq!(format!("{}", EncoderArchitecture::ModernBert), "ModernBERT");
}

// =========================================================================
// Config: head dimension divisibility invariant
// =========================================================================

#[test]
fn test_config_head_dim_divisibility() {
    // hidden_size must be evenly divisible by num_attention_heads for all configs
    let configs = [
        ("bert_base", EncoderConfig::bert_base()),
        ("modernbert_base", EncoderConfig::modernbert_base()),
        ("modernbert_large", EncoderConfig::modernbert_large()),
        ("deberta_v3_base", EncoderConfig::deberta_v3_base()),
        ("deberta_v3_large", EncoderConfig::deberta_v3_large()),
    ];
    for (name, cfg) in &configs {
        assert_eq!(
            cfg.hidden_size % cfg.num_attention_heads,
            0,
            "{}: hidden_size {} not divisible by num_attention_heads {}",
            name,
            cfg.hidden_size,
            cfg.num_attention_heads
        );
    }
}

// =========================================================================
// Config: bert_base detailed field validation
// =========================================================================

#[test]
fn test_bert_base_full_config() {
    let cfg = EncoderConfig::bert_base();
    assert_eq!(cfg.vocab_size, 30522);
    assert_eq!(cfg.hidden_size, 768);
    assert_eq!(cfg.num_attention_heads, 12);
    assert_eq!(cfg.num_hidden_layers, 12);
    assert_eq!(cfg.intermediate_size, 3072);
    assert_eq!(cfg.max_position_embeddings, 512);
    assert_eq!(cfg.hidden_dropout_prob, 0.1);
    assert!((cfg.layer_norm_eps - 1e-12).abs() < 1e-20);
    assert!(!cfg.use_rope);
    assert!(!cfg.use_geglu);
    assert!((cfg.rope_theta - 10000.0).abs() < f64::EPSILON);
    assert!(!cfg.use_pre_norm); // classic BERT uses post-norm
}

// =========================================================================
// Config: large > base ordering invariant
// =========================================================================

#[test]
fn test_large_configs_wider_than_base() {
    // ModernBERT: large has wider hidden and more layers than base
    let mb_base = EncoderConfig::modernbert_base();
    let mb_large = EncoderConfig::modernbert_large();
    assert!(mb_large.hidden_size > mb_base.hidden_size);
    assert!(mb_large.num_hidden_layers > mb_base.num_hidden_layers);
    assert!(mb_large.num_attention_heads > mb_base.num_attention_heads);
    assert!(mb_large.intermediate_size > mb_base.intermediate_size);
    // Same vocab and context window
    assert_eq!(mb_large.vocab_size, mb_base.vocab_size);
    assert_eq!(
        mb_large.max_position_embeddings,
        mb_base.max_position_embeddings
    );

    // DeBERTa-v3: large has wider hidden and more layers than base
    let db_base = EncoderConfig::deberta_v3_base();
    let db_large = EncoderConfig::deberta_v3_large();
    assert!(db_large.hidden_size > db_base.hidden_size);
    assert!(db_large.num_hidden_layers > db_base.num_hidden_layers);
    assert!(db_large.num_attention_heads > db_base.num_attention_heads);
    assert!(db_large.intermediate_size > db_base.intermediate_size);
    // Same vocab
    assert_eq!(db_large.vocab_size, db_base.vocab_size);
}

// =========================================================================
// from_model_name: HuggingFace-style paths with org prefix
// =========================================================================

#[test]
fn test_from_model_name_with_org_prefixes() {
    // Full HuggingFace model paths should dispatch correctly
    let cfg = EncoderConfig::from_model_name("answerdotai/ModernBERT-base");
    assert!(cfg.use_rope);
    assert_eq!(cfg.num_hidden_layers, 22);

    let cfg = EncoderConfig::from_model_name("answerdotai/ModernBERT-large");
    assert_eq!(cfg.num_hidden_layers, 28);

    let cfg = EncoderConfig::from_model_name("microsoft/deberta-v3-base");
    assert!(!cfg.use_rope);
    assert_eq!(cfg.vocab_size, 128100);

    // A BERT-like model without known keywords
    let cfg = EncoderConfig::from_model_name("google-bert/bert-base-uncased");
    assert_eq!(cfg.vocab_size, 30522);
    assert!(!cfg.use_rope);
}

// =========================================================================
// from_model_name: embedded substrings and edge cases
// =========================================================================

#[test]
fn test_from_model_name_substring_matching() {
    // "modernbert" embedded in a larger string still matches
    let cfg = EncoderConfig::from_model_name("my-finetuned-modernbert-v2");
    assert!(cfg.use_rope);
    assert_eq!(cfg.num_hidden_layers, 22); // base (no "large")

    // "deberta" embedded in a custom path
    let cfg = EncoderConfig::from_model_name("custom/deberta-finetuned");
    assert_eq!(cfg.vocab_size, 128100);
    assert!(!cfg.use_rope);

    // "large" without a known architecture still falls back to BERT
    let cfg = EncoderConfig::from_model_name("some-large-model");
    assert_eq!(cfg.vocab_size, 30522); // BERT fallback

    // Empty string falls back to BERT
    let cfg = EncoderConfig::from_model_name("");
    assert_eq!(cfg.vocab_size, 30522);
}

// =========================================================================
// Architecture: config round-trip consistency
// =========================================================================

#[test]
fn test_architecture_config_matches_max_length() {
    // EncoderArchitecture::max_length() should agree with its default config
    for arch in [
        EncoderArchitecture::Bert,
        EncoderArchitecture::DeBertaV3,
        EncoderArchitecture::ModernBert,
    ] {
        assert_eq!(
            arch.max_length(),
            arch.default_config().max_position_embeddings,
            "max_length() disagrees with default_config() for {}",
            arch
        );
    }
}

// =========================================================================
// Architecture: uses_rope agrees with config
// =========================================================================

#[test]
fn test_architecture_uses_rope_matches_config() {
    for arch in [
        EncoderArchitecture::Bert,
        EncoderArchitecture::DeBertaV3,
        EncoderArchitecture::ModernBert,
    ] {
        assert_eq!(
            arch.uses_rope(),
            arch.default_config().use_rope,
            "uses_rope() disagrees with default_config().use_rope for {}",
            arch
        );
    }
}

// =========================================================================
// Config: Clone produces identical values
// =========================================================================

#[test]
fn test_config_clone_identity() {
    let original = EncoderConfig::modernbert_large();
    let cloned = original.clone();
    assert_eq!(original.vocab_size, cloned.vocab_size);
    assert_eq!(original.hidden_size, cloned.hidden_size);
    assert_eq!(original.num_attention_heads, cloned.num_attention_heads);
    assert_eq!(original.num_hidden_layers, cloned.num_hidden_layers);
    assert_eq!(original.intermediate_size, cloned.intermediate_size);
    assert_eq!(
        original.max_position_embeddings,
        cloned.max_position_embeddings
    );
    assert_eq!(original.hidden_dropout_prob, cloned.hidden_dropout_prob);
    assert!((original.layer_norm_eps - cloned.layer_norm_eps).abs() < f64::EPSILON);
    assert_eq!(original.use_rope, cloned.use_rope);
    assert_eq!(original.use_geglu, cloned.use_geglu);
    assert!((original.rope_theta - cloned.rope_theta).abs() < f64::EPSILON);
    assert_eq!(original.use_pre_norm, cloned.use_pre_norm);
}