meddies-pii-v2

Meddies PII v2

<p align="left"> <a href="https://huggingface.co/spaces/Meddies/meddies-pii-extractor"><img alt="Try the browser demo" src="https://img.shields.io/badge/Demo-0F172A?style=flat&logo=googlechrome&logoColor=white"></a> <a href="https://huggingface.co/datasets/Meddies/meddies-pii-v2"><img alt="Training dataset" src="https://img.shields.io/badge/Dataset-024C6F?style=flat&logo=huggingface&logoColor=white"></a> <a href="https://huggingface.co/Meddies/meddies-pii-v2-onnx"><img alt="ONNX build" src="https://img.shields.io/badge/ONNX-1ABBC7?style=flat&logo=huggingface&logoColor=white"></a> <a href="https://creativecommons.org/licenses/by-nc/4.0/"><img alt="CC BY-NC 4.0" src="https://img.shields.io/badge/license-CC--BY--NC--4.0-475569"></a> </p>

A 350M encoder that finds nine types of personally identifiable information across 17 languages and returns exact character spans for review and redaction.

[!CAUTION] Keep a human in the loop

This model can miss identifiers. It cannot certify that text is safe to share. Test it on your documents and keep human review in any regulated workflow.

[!NOTE] Commercial licensing

CC BY-NC 4.0 applies to the rights MeddiesAI can license in this release. Contact [email protected] about commercial terms for those contributions. The underlying LiquidAI materials remain subject to LFM Open License v1.0.

<p align="center"> <img src="./assets/hero-meddies-pii-v2.png" alt="Meddies PII v2 detects nine PII entity families across 17 languages and returns exact character spans" width="100%" /> </p>

Why this model

Clinical records rarely keep identifiers tidy. One note can mix a patient name, hospital ID, phone number, signed portal link, login secret, and a date format that only makes sense locally. Rules catch the obvious cases, then lose ground when the language or document template changes.

Meddies PII v2 handles those cases through one span extraction interface. We built it for clinical text, but its nine labels also cover general documents that need review before release.

What the model returns

Pass in raw text. The model returns the label, text, start offset, and end offset for every detected span.

• Nine fixed labels with address, company_name, date, email_address, human_name, id_number, phone_number, private_url, and secret.
• Seventeen languages with German, English, Spanish, French, Indonesian, Japanese, Korean, Lao, Malay, Burmese, Portuguese, Russian, Tamil, Thai, Filipino, Vietnamese, and Chinese.
• Character offsets included so every prediction maps back to the source text for review or redaction.
• Outside the label set are images, layout, diagnoses, lab results, ages, doses, medical measurements, and public links.

Quick start

import sys

from huggingface_hub import snapshot_download

path = snapshot_download("Meddies/meddies-pii-v2")
sys.path.insert(0, path)

from modeling_meddies_pii import MeddiesPiiExtractor

model = MeddiesPiiExtractor.from_pretrained(path)
spans = model.extract(
    "Bệnh nhân Nguyễn Văn A, SĐT 0912 345 678, tái khám ngày 12/08/2026."
)

for span in spans:
    print(span.label, span.start, span.end, span.text)

Expected output

human_name 10 22 Nguyễn Văn A
phone_number 28 40 0912 345 678
date 56 66 12/08/2026

Choose the weight form

Merging folds the adapter into the base weights and changes the numerical path. Borderline BIOES decisions can move. Use the adapter when exact release reproduction matters.

ONNX and local browser use

The ONNX companion packages the same checkpoint for ONNX Runtime and WebGPU. Its full precision graph matched the PyTorch adapter on all 200 parity rows. The current int8 graph differed on 12 of 200 rows.

The browser demo runs on the user's device. Raw clinical text never leaves the device.

Evaluation

Meddies PII v2 reached 0.8937 exact typed micro F1 and 0.9429 containment typed micro F1 on 263,785 benchmark rows. It had the highest exact typed F1 in all 17 evaluation cells, all 17 language slices, and all nine entity families against the six reference systems in this comparison.

<p align="center"> <img src="./assets/evaluation-meddies-pii-v2.png" alt="Meddies PII v2 evaluation snapshot with overall, comparative, entity, and language results" width="100%" /> </p>

Exact typed F1 requires the label and both character boundaries to match. Containment typed F1 accepts a correct label when one span contains the other. Each macro average gives the same weight to the unit named in the column.

<details> <summary>Exact typed F1 in all 17 evaluation cells</summary>

The v2 preview is the earlier 150-step checkpoint that preceded this release.

</details> <details> <summary>Exact and containment F1 by entity family</summary> </details>

The benchmark combines synthetic and public corpora. A strong benchmark score does not tell you how the model behaves inside one hospital. Evaluate it on local document types before deployment.

How it was built

We adapted LiquidAI LFM2.5 Encoder 350M PII Detector with rank 128 Low-Rank Adaptation and a 37-tag BIOES classification head.

Training used the Meddies PII v2 dataset and external public corpora rebuilt from their original sources. We do not rehost those external corpora. Checkpoint selection used a pinned control set before the full benchmark. The complete recipe and release checks live in TRAINING.md.

Where it fits

• Review before redaction for clinical notes, referrals, messages, and exported records.
• Span extraction inside a de-identification workflow that keeps the source text visible to a reviewer.
• Multilingual evaluation and domain adaptation for local document formats.

Limits

• Postal addresses reached 0.681 exact F1 and 0.866 containment F1. Expect trimmed or extended boundaries.
• The label set is closed. An unsupported identifier will not receive its own label.
• Hospital templates, abbreviations, copied headers, and optical character recognition errors vary by site.
• Synthetic and public benchmark data cannot establish performance on every patient population or production system.
• Inputs designed to evade detection can still break the model.

License

MeddiesAI applies CC BY-NC 4.0 to the copyright and related rights it can license in this release. See LICENSE.

The underlying LiquidAI materials remain under LFM Open License v1.0. Upstream attribution and the MeddiesAI change record are preserved in NOTICE. Review both licenses before redistribution.

Feedback

Found a bad miss or a wrong boundary? Share the language, document type, expected span, predicted span, and whether optical character recognition was involved. Use a safe synthetic example. Never post real patient text or credentials in a public issue.

Open a thread in the Community tab or email [email protected].

Collaboration

We are looking for hospitals, research groups, and privacy teams that can contribute de-identified failure cases, independent evaluations, or review in underrepresented languages. Email [email protected] to work with us.

Citation

@misc{meddies-pii-v2,
  title={Meddies PII v2 for multilingual clinical de-identification},
  author={MeddiesAI},
  year={2026},
  url={https://huggingface.co/Meddies/meddies-pii-v2}
}