Skip to main content

meddeid-eval

Reproducible evaluation for clinical de-identification. meddeid-eval computes exact-span metrics, character-level recall, core-PII recall, non-PII redaction rate, and stability results from canonical MedDeID JSONL files.

See the suite evaluation workflow for the end-to-end handoff. This repository remains authoritative for metric definitions, commands, stability configuration, and plotting support.

Installation

python -m pip install meddeid-eval

Optional extras add model inference and plotting support:

python -m pip install 'meddeid-eval[infer,plots]'

Usage

meddeid-eval score --gold meddeid-dutch-synthetic-benchmark.jsonl --predictions predictions.jsonl
meddeid-eval stability expand --config stability.yaml

Gold and prediction files are matched by document_id and use half-open [begin, end) Unicode-code-point offsets. The score command reports exact precision, recall, and F1 together with character coverage and redaction metrics.

Core-PII recall is the label-agnostic fraction of protocol-defined core PII characters covered by any predicted redaction. Each primary gold span owns a nested subannotations list. formatting, additional_info, medical_info, title, and time segments are excluded from the denominator.

Stability perturbations use the complete nl-BE resources from meddeid-language-nl; incomplete resources are reported as installation errors.

External comparators

Comparison systems run in their own environments. Export their predictions in the canonical MedDeID JSONL schema and evaluate them with the same score command. Belgian DEDUCE is not installed by meddeid-eval.

Development

pip install -e '.[dev]'
pytest

Licence

AGPL-3.0-only. External comparison systems retain their own licence terms.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meddeid_eval-0.2.0.tar.gz (45.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meddeid_eval-0.2.0-py3-none-any.whl (51.2 kB view details)

Uploaded Python 3

File details

Details for the file meddeid_eval-0.2.0.tar.gz.

File metadata

  • Download URL: meddeid_eval-0.2.0.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meddeid_eval-0.2.0.tar.gz
Algorithm Hash digest
SHA256 96642d1a24d1376b8e25b6d125e46e1842f6b1ed72c784e637734e981afdb437
MD5 7904f589250aa1b02b67c3e5dfbb9ab9
BLAKE2b-256 55d4b948116e8dbf88efbeacaf9d5a8e8843ad269b3e6fdb589773370dded13d

See more details on using hashes here.

Provenance

The following attestation bundles were made for meddeid_eval-0.2.0.tar.gz:

Publisher: publish-python.yml on stighellemans/meddeid-eval

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file meddeid_eval-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: meddeid_eval-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 51.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meddeid_eval-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4465e8e981b930bfdcf4926e87e685e68b48901c33c406521facddd2d8ea4499
MD5 53349f210350a6b5473ce36c6b4212bf
BLAKE2b-256 6032640bd38bf7ab55423d191e295a8a272e6886ce4ebcb65f9d033d77ce274e

See more details on using hashes here.

Provenance

The following attestation bundles were made for meddeid_eval-0.2.0-py3-none-any.whl:

Publisher: publish-python.yml on stighellemans/meddeid-eval

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.0

2 files

0.2.1

2 files

This release

0.2.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page