Skip to main content

Open-source PII anonymization agent with reproducible benchmarking for OpenAI-compatible models

Project description

AnonLM

AnonLM is an open-source Python library for LLM-based PII anonymization with reproducible benchmarking.

It provides:

  • A configurable anonymization engine for OpenAI-compatible providers.
  • A stable Python API for anonymize/deanonymize workflows.
  • A unified CLI for anonymization and benchmark execution.
  • Benchmark history artifacts for auditability and experiment tracking.

Installation

pip install anonlm-pii

For development:

python -m venv .venv
source .venv/bin/activate
pip install -e .[dev,test]

Quickstart (Python API)

from anonlm import anonymize

result = anonymize("Contact Jane Doe at jane.doe@example.com or +34 600 123 456.")
print(result.anonymized_text)
print(result.mapping_forward)

Quickstart (CLI)

# Text input
anonlm anonymize --text "Contact Jane Doe at jane.doe@example.com"

# File input -> JSON output
anonlm anonymize --file input.txt --output output.json

# Benchmark run
anonlm benchmark run --dataset datasets/pii_mvp_dataset.csv --split dev

Configuration

Configuration precedence is:

  1. Explicit CLI flags
  2. Environment variables (ANONLM_*)
  3. Provider defaults

Core environment variables:

Variable Description
ANONLM_PROVIDER openai, openrouter, groq, or custom
ANONLM_MODEL_NAME Model identifier
ANONLM_BASE_URL OpenAI-compatible base URL
ANONLM_API_KEY_ENV Env var name containing API key
ANONLM_API_KEY API key value
ANONLM_TEMPERATURE LLM temperature
ANONLM_MAX_CHUNK_CHARS Chunk size
ANONLM_CHUNK_OVERLAP_CHARS Chunk overlap

Provider examples:

# OpenAI
export ANONLM_PROVIDER=openai
export ANONLM_API_KEY=sk-...

# OpenRouter
export ANONLM_PROVIDER=openrouter
export ANONLM_API_KEY=...
export ANONLM_MODEL_NAME=openai/gpt-4o-mini

# Groq
export ANONLM_PROVIDER=groq
export ANONLM_API_KEY=...
export ANONLM_MODEL_NAME=llama-3.3-70b-versatile

# Custom OpenAI-compatible endpoint
export ANONLM_PROVIDER=custom
export ANONLM_BASE_URL=https://your.endpoint/v1
export ANONLM_API_KEY=...

Benchmarking

Run benchmark with deterministic document-based splits (dev, val, final):

anonlm benchmark run --dataset datasets/pii_mvp_dataset.csv --split dev --verbose

Optional benchmark controls:

anonlm benchmark run \
  --dataset datasets/pii_mvp_dataset.csv \
  --split val \
  --history-dir runs/benchmarks \
  --threshold-f1 0.80

Artifacts:

  • JSON run detail: runs/benchmarks/<timestamp>__<split>.json
  • CSV summary index: runs/benchmarks/index.csv

See docs/benchmarking.md for protocol and interpretation guidelines.

Public API

  • anonlm.anonymize(text: str, config: AnonLMConfig | None = None) -> AnonymizationResult
  • anonlm.deanonymize(text: str, mapping_reverse: dict[str, str]) -> str
  • anonlm.create_engine(config: AnonLMConfig | None = None) -> AnonymizationEngine

Project status

Current status: 0.x (early API hardening). Expect minor breaking changes until 1.0.0.

License

Apache-2.0

Project details


Download files

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

Source Distribution

anonlm_pii-0.1.0.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

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

anonlm_pii-0.1.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file anonlm_pii-0.1.0.tar.gz.

File metadata

  • Download URL: anonlm_pii-0.1.0.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for anonlm_pii-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f890ed69844c4fc97b1b10d45ce3af0b3f2997a0dce9c004141ba04f86f27080
MD5 f9d95ab480c53958cf0536b6622f551b
BLAKE2b-256 9fe7a2160a984c931a2cf05ef911620761c0d6576dfcb74a911329da74b932f3

See more details on using hashes here.

File details

Details for the file anonlm_pii-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: anonlm_pii-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for anonlm_pii-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e8a527fce11dfe130633853c246f43f2e5e7dd1681a3c268709430e7f47f2fb
MD5 c568bf52a27d4ca46703ad38df29ee5d
BLAKE2b-256 6e3d6c5f31c4d41de1bcb6f62ae9793303948f17b5e7d4d37de8c2711c4dfd1f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page