Reza2kn commited on
Commit
cbb230d
·
verified ·
1 Parent(s): 0f7a886

Update model card with mini benchmark limitations

Browse files
Files changed (1) hide show
  1. README.md +34 -18
README.md CHANGED
@@ -12,38 +12,54 @@ tags:
12
  - ocr
13
  - document-ai
14
  - surya
 
15
  ---
16
 
17
  # Surya OCR 2 NVFP4A16
18
 
19
- This repository contains a converted/quantized artifact derived from [datalab-to/surya-ocr-2](https://huggingface.co/datalab-to/surya-ocr-2).
20
 
21
- ## What is included
22
 
23
- - Source model: `datalab-to/surya-ocr-2`
24
- - Runtime/format: llm-compressor / NVIDIA NVFP4-capable runtimes
25
- - Quantization: NVFP4A16 4-bit float weight quantization; selected unsupported/sensitive modules remain bf16
26
- - Vision weights included: yes, included; the current recipe preserves vision tower weights in bf16 rather than dropping them
27
- - Created for: local OCR/document-understanding experiments and parity testing
28
 
29
- ## Validation status
 
 
 
 
30
 
31
- Mini olmOCR-bench score: **79.2% ± 6.2%**. This did not meet the current >98% parity target against the source mini baseline. Failures concentrated on long tiny text and old scans.
32
 
33
- ## Known caveats
 
 
 
34
 
35
- Early artifact. The recipe intentionally avoids quantizing unsupported/sensitive visual and linear-attention modules. Use only in runtimes that understand the serialized NVFP4 format.
36
 
37
- ## Files
38
 
39
- Quantized safetensors, config, tokenizer, processor, generation config, chat template, and quantization recipe metadata.
40
 
41
- ## Usage
42
 
43
- Load with a compatible NVIDIA/NVFP4 runtime stack. Generic Transformers may not execute this format directly.
44
 
45
- ## Provenance
46
 
47
- This artifact was generated non-destructively from the original Hugging Face checkpoint. It is not a new fine-tune.
48
 
49
- If you need production parity, compare against the original model on your own document distribution before deployment.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  - ocr
13
  - document-ai
14
  - surya
15
+ - experimental
16
  ---
17
 
18
  # Surya OCR 2 NVFP4A16
19
 
20
+ This repository contains an **experimental quantized** artifact derived from [datalab-to/surya-ocr-2](https://huggingface.co/datalab-to/surya-ocr-2).
21
 
22
+ This NVFP4 artifact is useful for NVIDIA/NVFP4 runtime experimentation. On the mini benchmark it matches the 8-bit MLX split profile: strong on most clean/layout-heavy sections, weak on long tiny text, and not usable for old degraded scans yet.
23
 
24
+ ## What is included
 
 
 
 
25
 
26
+ - Source model: `datalab-to/surya-ocr-2`
27
+ - Runtime/format: llm-compressor / NVIDIA NVFP4-capable runtimes
28
+ - Quantization: NVFP4A16 4-bit float weight quantization; sensitive/unsupported modules remain bf16
29
+ - Vision weights included: Yes. Vision weights are included; the current recipe preserves the vision tower in bf16 rather than dropping it.
30
+ - Processor/tokenizer assets: included
31
 
32
+ ## Mini olmOCR-bench results
33
 
34
+ | Candidate | Overall | Arxiv math | Headers/footers | Long tiny text | Multi-column | Old scans | Old scans math | Tables | Baseline |
35
+ |---|---:|---:|---:|---:|---:|---:|---:|---:|---:|
36
+ | Source mini baseline | 91.0% ± 6.3% | 100.0% | 100.0% | 100.0% | 100.0% | 33.3% | 100.0% | 100.0% | 94.7% |
37
+ | Surya OCR 2 NVFP4A16 | 79.2% ± 6.2% | 100.0% | 100.0% | 33.3% | 100.0% | 0.0% | 100.0% | 100.0% | 100.0% |
38
 
 
39
 
 
40
 
41
+ ## How to read the benchmark table
42
 
43
+ This is an early quant release with transparent limitations. The table uses our local 40-test mini slice of `allenai/olmOCR-bench`, with 3 samples from each named section plus the benchmark baseline checks. It is **not** the full public score and it is **not** a claim of >98% parity.
44
 
45
+ The useful signal is the split behavior: this artifact is currently strong on clean academic/math, headers/footers, multi-column layouts, tables, old-scan math, and baseline OCR checks, but it should not be used for old degraded scans and is weak on long tiny text.
46
 
47
+ ## Recommended use
48
 
49
+ Use this checkpoint for local experimentation and constrained OCR workloads whose documents resemble the passing sections above. Avoid using it as a production replacement for the original model on degraded historical scans, very small dense body text, or workloads requiring full benchmark parity.
50
 
51
+
52
+ ## Loading
53
+
54
+ Load with a runtime stack that understands NVFP4A16 serialized weights. Generic Transformers runtimes may not execute this checkpoint without NVFP4 support.
55
+
56
+ ## Limitations
57
+
58
+ - This is not a full-parity release yet.
59
+ - Do **not** use this artifact for degraded old scans; the current mini split score is 0.0% there.
60
+ - Do **not** use this artifact for long tiny text unless you independently validate your data; the current mini split score is 33.3%.
61
+ - Math-heavy and table/layout-heavy mini examples looked good in this slice, but full olmOCR-bench is still pending.
62
+
63
+ ## Provenance
64
+
65
+ Generated non-destructively from the original Hugging Face checkpoint. This is not a fine-tune. The goal of publishing this artifact now is transparency: the files are usable for the passing workload slices above, and the known failing slices are documented clearly.