language: ko license: other license_name: schift-2.0 license_link: LICENSE library_name: transformers pipeline_tag: token-classification tags:
- pii
- korean
- ner
- privacy
- token-classification datasets:
- custom model-index:
- name: schift-ko-pii-v4
results:
- task:
type: token-classification
name: Korean PII Detection
metrics:
- type: f1 value: 0.863 name: F1 (raw, no postprocess)
- type: f1 value: 0.968 name: F1 (with postprocess)
- task:
type: token-classification
name: Korean PII Detection
metrics:
schift-ko-pii-v4
111M parameter Korean PII detector built on klue/roberta-base.
Fine-tuned with LoRA on Korean legal, financial, and administrative texts. The active service artifact is the v4 ONNX package.
Benchmark status
The active release remains v4. The dated report records the v5 candidate
comparison and decision: docs/2026-08-18-pii-v5-latency-cost.md.
Release decision (2026-08-19)
HOLD — v4 remains active; v5 is a measured candidate, not the active release. The v5 candidate scored F1 0.629 raw and 0.929 with postprocessing on the local 93-case suite, and F1 0.8906 on the 100-case hard holdout. Its measured CPU normal-call latency was 13.74x v4 on average, so the quality result does not yet justify the latency/cold-start cost. The active Cloud Run service and the checked-in dist package still reference v4. No v5 release pointer or deployment is implied by this README.
The complete evidence, exact commands, artifact commit, package metadata, and
service revision are recorded in
../docs/2026-08-18-pii-v5-latency-cost.md.
Quick start
pip install schift-ko-pii
from schift_ko_pii import detect
# Raw model output
spans = detect("피고 김민수의 전화번호는 010-1234-5678이다.")
# [
# {"start": 3, "end": 6, "label": "private_person", "score": 0.99, "text": "김민수"},
# {"start": 14, "end": 27, "label": "private_phone", "score": 0.98, "text": "010-1234-5678"},
# ]
# With postprocessing (regex validation + structured-ID rules, higher precision)
spans = detect("주민번호 850205-1234567을 확인.", postprocess=True)
Postprocessing
The postprocess=True flag applies Korean-specific rules:
- Regex validation for structured IDs (resident numbers, passports, vehicle plates, bank accounts)
- Luhn/checksum verification where applicable
- Context-aware span merging
- False-positive suppression for legal case numbers and statute references
This raises strong-category F1 from 0.893 to 0.968.
API (free)
For production use without managing model files:
from schift import Schift
client = Schift(api_key="...") # free at schift.io
result = client.pii.redact("김민수의 전화번호는 010-1234-5678입니다.")
# Postprocessing is always enabled on the API.
Labels
| Label | Description | Examples |
|---|---|---|
private_person |
Person names (Korean, Hanja, foreign) | 김민수, 황보영희, Lee Jenny |
private_phone |
Phone numbers | 010-1234-5678, 02-1234-5678 |
private_email |
Email addresses | user@example.com |
private_address |
Street/postal addresses | 서울특별시 강남구 테헤란로 521 |
private_date |
Dates | 2024년 3월 15일, 2024-03-15 |
private_url |
URLs, SNS links, IP addresses | instagram.com/user, 192.168.1.1 |
account_number |
Structured IDs: resident/business/bank/passport/vehicle | 850205-1234567, M12345678 |
secret |
Secrets, API keys, passwords |
Benchmark
The benchmark suite is included in this repository under benchmark/.
# Benchmark this model
python benchmark/run_benchmark.py
# With postprocess
python benchmark/run_benchmark.py --postprocess
# Compare any HuggingFace model
python benchmark/run_benchmark.py --hf-model LiquidAI/LFM2.5-Encoder-350M-PII-Detector
93 hand-crafted cases covering Korean legal, investigative, and administrative text. Categories: person (standard/rare/short/foreign/hanja), phone, email, address (urban/rural), dates, URLs, resident IDs, business IDs, bank accounts, passports, vehicle plates, IP addresses, plus negative cases (legal case numbers, statute references, Hanja legal terms).
Model details
- Base model:
klue/roberta-base(111M params) - Training: LoRA adapter on Korean legal/financial/admin examples
- Format: v4 ONNX service artifact / safetensors release source
- Inference:
transformerspipeline, CPU or GPU - Max length: 512 tokens
- Tagging scheme: BIES (Begin/Inside/End/Single)
License
Schift License v2.0 — Apache 2.0 base with a revenue threshold. Free for everyone under $10M annual revenue. Research, education, and non-profit use always permitted. Companies above the threshold: contact hello@schift.io.
Citation
@software{schift_ko_pii_2026,
author = {Schift Inc.},
title = {schift-ko-pii: Korean PII Detection Model},
year = {2026},
url = {https://huggingface.co/schift-io/schift-ko-pii-v4},
}
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file schift_ko_pii-0.3.2.tar.gz.
File metadata
- Download URL: schift_ko_pii-0.3.2.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c7fdd654c84ee9df4eb1a4fbec1d7661df629852dc3c28722ebaf338d41fc1c
|
|
| MD5 |
a230eeda5ab8672d48a59ba7e455253a
|
|
| BLAKE2b-256 |
d27ba4e3b50fe8a9355f2e0076bfe9fbec3d7231be1767ab58ceb2e5da708e03
|
File details
Details for the file schift_ko_pii-0.3.2-py3-none-any.whl.
File metadata
- Download URL: schift_ko_pii-0.3.2-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f755253ac9b7c47f859a21c56dc3afc2d2584b1e5bb4f84d53eadcb70f3b742c
|
|
| MD5 |
e4ea7244042c7ceeefe07255734bbf96
|
|
| BLAKE2b-256 |
770de81000b0c111bb0a62105117b5d5edfca2b0edd6881b7112c09f3c108d59
|