Text Classification
Transformers
grounding
hallucination-detection
fact-verification
nli
zero-shot-classification
document-ai
cross-encoder
Instructions to use nutrientdocs/grounding-multilingual with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use nutrientdocs/grounding-multilingual with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-classification", model="nutrientdocs/grounding-multilingual")# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("nutrientdocs/grounding-multilingual", dtype="auto") - Notebooks
- Google Colab
- Kaggle
Commit Β·
1c69352
0
Parent(s):
Public release
Browse files- .gitattributes +35 -0
- README.md +103 -0
.gitattributes
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
*.7z filter=lfs diff=lfs merge=lfs -text
|
| 2 |
+
*.arrow filter=lfs diff=lfs merge=lfs -text
|
| 3 |
+
*.bin filter=lfs diff=lfs merge=lfs -text
|
| 4 |
+
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
| 5 |
+
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
| 6 |
+
*.ftz filter=lfs diff=lfs merge=lfs -text
|
| 7 |
+
*.gz filter=lfs diff=lfs merge=lfs -text
|
| 8 |
+
*.h5 filter=lfs diff=lfs merge=lfs -text
|
| 9 |
+
*.joblib filter=lfs diff=lfs merge=lfs -text
|
| 10 |
+
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
| 11 |
+
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
| 12 |
+
*.model filter=lfs diff=lfs merge=lfs -text
|
| 13 |
+
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
| 14 |
+
*.npy filter=lfs diff=lfs merge=lfs -text
|
| 15 |
+
*.npz filter=lfs diff=lfs merge=lfs -text
|
| 16 |
+
*.onnx filter=lfs diff=lfs merge=lfs -text
|
| 17 |
+
*.ot filter=lfs diff=lfs merge=lfs -text
|
| 18 |
+
*.parquet filter=lfs diff=lfs merge=lfs -text
|
| 19 |
+
*.pb filter=lfs diff=lfs merge=lfs -text
|
| 20 |
+
*.pickle filter=lfs diff=lfs merge=lfs -text
|
| 21 |
+
*.pkl filter=lfs diff=lfs merge=lfs -text
|
| 22 |
+
*.pt filter=lfs diff=lfs merge=lfs -text
|
| 23 |
+
*.pth filter=lfs diff=lfs merge=lfs -text
|
| 24 |
+
*.rar filter=lfs diff=lfs merge=lfs -text
|
| 25 |
+
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
| 26 |
+
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 27 |
+
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 28 |
+
*.tar filter=lfs diff=lfs merge=lfs -text
|
| 29 |
+
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 30 |
+
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 31 |
+
*.wasm filter=lfs diff=lfs merge=lfs -text
|
| 32 |
+
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 33 |
+
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
+
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
+
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
README.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
license_name: nutrient-commercial
|
| 4 |
+
library_name: transformers
|
| 5 |
+
pipeline_tag: text-classification
|
| 6 |
+
language:
|
| 7 |
+
- multilingual
|
| 8 |
+
- en
|
| 9 |
+
- de
|
| 10 |
+
- fr
|
| 11 |
+
- es
|
| 12 |
+
- zh
|
| 13 |
+
- ja
|
| 14 |
+
- ar
|
| 15 |
+
- hi
|
| 16 |
+
- ru
|
| 17 |
+
- tr
|
| 18 |
+
- vi
|
| 19 |
+
- ko
|
| 20 |
+
- sw
|
| 21 |
+
- ur
|
| 22 |
+
- th
|
| 23 |
+
tags:
|
| 24 |
+
- grounding
|
| 25 |
+
- hallucination-detection
|
| 26 |
+
- fact-verification
|
| 27 |
+
- nli
|
| 28 |
+
- zero-shot-classification
|
| 29 |
+
- multilingual
|
| 30 |
+
- document-ai
|
| 31 |
+
- cross-encoder
|
| 32 |
+
datasets:
|
| 33 |
+
- nutrientdocs/grounding-benchmark
|
| 34 |
+
metrics:
|
| 35 |
+
- roc_auc
|
| 36 |
+
---
|
| 37 |
+
|
| 38 |
+
# grounding-multilingual Β· _commercial_
|
| 39 |
+
|
| 40 |
+
**Does the document actually support this claim β in 15+ languages?** `grounding-multilingual` is a
|
| 41 |
+
cross-encoder that scores whether a hypothesis (a number, date, or fact) is **entailed by** a premise
|
| 42 |
+
drawn from a real document β a
|
| 43 |
+
financial table, a filing, prose evidence.
|
| 44 |
+
|
| 45 |
+
It is the strongest, multilingual member of Nutrient's grounding model family. **Weights are commercial**
|
| 46 |
+
(not downloadable here); this page is a spec + scorecard. For the open, English model see
|
| 47 |
+
[`grounding-en`](https://huggingface.co/nutrientdocs/grounding-en).
|
| 48 |
+
|
| 49 |
+
- π― **Try it:** [grounding-demo](https://huggingface.co/spaces/nutrientdocs/grounding-demo?model=multi)
|
| 50 |
+
- π **Leaderboard:** [grounding-leaderboard](https://huggingface.co/spaces/nutrientdocs/grounding-leaderboard)
|
| 51 |
+
- π **Benchmark:** [grounding-benchmark](https://huggingface.co/datasets/nutrientdocs/grounding-benchmark)
|
| 52 |
+
|
| 53 |
+
## Results
|
| 54 |
+
|
| 55 |
+
On the held-out multilingual [grounding-benchmark](https://huggingface.co/datasets/nutrientdocs/grounding-benchmark)
|
| 56 |
+
(ROC-AUC), against the top open multilingual NLI models:
|
| 57 |
+
|
| 58 |
+
| Facet | `grounding-multilingual` | mDeBERTa-v3-base XNLI-2mil7 | mDeBERTa-v3-base MNLI-XNLI | XLM-R-large XNLI |
|
| 59 |
+
| --- | ---: | ---: | ---: | ---: |
|
| 60 |
+
| **Overall** | **.965** | .894 | .831 | .811 |
|
| 61 |
+
| Number | **.999** | .775 | .806 | .765 |
|
| 62 |
+
| Table premises | **.999** | .727 | .780 | .715 |
|
| 63 |
+
| Prose premises | .926 | **.961** | .864 | .869 |
|
| 64 |
+
|
| 65 |
+
It leads on **number** (.999 vs .77β.81) and **table** grounding (.999 vs .72β.78) across 15+ languages;
|
| 66 |
+
on general prose NLI the best multilingual zero-shot model edges it. Full ranking on the
|
| 67 |
+
[leaderboard](https://huggingface.co/spaces/nutrientdocs/grounding-leaderboard). (Date/string grounding
|
| 68 |
+
is too rare in the multilingual corpus to score reliably, so it's omitted here.)
|
| 69 |
+
|
| 70 |
+
## Calibrating the score
|
| 71 |
+
|
| 72 |
+
Fine-tuning maximizes _ranking_ (AUC), which can leave the raw probability overconfident. For a score you
|
| 73 |
+
can gate on ("0.9 means ~90% right"), apply **temperature scaling** β divide the logits by a fitted `T`
|
| 74 |
+
before softmax. It's monotonic, so AUC/ranking is untouched and only the confidence values are repaired.
|
| 75 |
+
On the serving distribution we fit **T = 0.94** (ECE 0.012 β 0.007). Re-fit `T` on your distribution
|
| 76 |
+
whenever your input pipeline changes.
|
| 77 |
+
|
| 78 |
+
## Intended use & limits
|
| 79 |
+
|
| 80 |
+
- **Use it for:** verifying extracted values against source documents, hallucination/citation checking,
|
| 81 |
+
and routing low-confidence extractions for review β across 15+ languages, on-prem.
|
| 82 |
+
- **Limits:** the remaining ceiling is _reasoning_ table-claim negatives and multi-step
|
| 83 |
+
arithmetic. As a dedicated grounding checkpoint it trades a little general-NLI accuracy for grounding.
|
| 84 |
+
|
| 85 |
+
## License & data
|
| 86 |
+
|
| 87 |
+
The model **weights** are offered under a commercial Nutrient license β on-prem, so documents never leave
|
| 88 |
+
your infrastructure. The training set is not redistributed. The **evaluation** data is public and
|
| 89 |
+
reproducible: [grounding-benchmark](https://huggingface.co/datasets/nutrientdocs/grounding-benchmark)
|
| 90 |
+
(CC-BY-SA-4.0); the full training set is not redistributed.
|
| 91 |
+
|
| 92 |
+
> ### π© Get access
|
| 93 |
+
>
|
| 94 |
+
> `grounding-multilingual` is commercial and its weights are not downloadable here. To run it on-prem β
|
| 95 |
+
> multilingual, calibrated, private β **contact Nutrient: [nutrient.io/contact-sales](https://www.nutrient.io/contact-sales/).**
|
| 96 |
+
|
| 97 |
+
## About the author
|
| 98 |
+
|
| 99 |
+
<a href="https://nutrient.io/">
|
| 100 |
+
<img src="https://avatars2.githubusercontent.com/u/1527679?v=3&s=200" height="80" />
|
| 101 |
+
</a>
|
| 102 |
+
|
| 103 |
+
This project is maintained and funded by [Nutrient](https://nutrient.io/) - The #1 PDF SDK library for viewing, editing, eSigning, and more.
|