Rename project to document-pii-redactor; update all links

README.md

@@ -1,15 +1,15 @@
 ---
 license: other
 license_name: per-model-licenses
-license_link: https://huggingface.co/ekacare/pii-redactors#license-and-attribution
+license_link: https://huggingface.co/ekacare/document-pii-redactor#license-and-attribution
 tags: [pii, redaction, document-ai]
 ---
 
-# eka-pii-redaction model weights
+# document-pii-redactor model weights
 
-Single repo holding the models used by the Eka-PII-redactors GitHub repo
-(https://github.com/eka-care/Eka-PII-redactors), organized by modality. You
-can use the Eka-PII-redactors repo directly to use these models — it has
+Single repo holding the models used by the document-pii-redactor GitHub repo
+(https://github.com/eka-care/document-pii-redactor), organized by modality. You
+can use the document-pii-redactor repo directly to use these models — it has
 the library, a Docker image, and a FastAPI server.
 
 - `image/layoutlmv3/` — a text-in-image classifier for **text PII in
@@ -19,14 +19,14 @@ the library, a Docker image, and a FastAPI server.
 - `text/minilm/` — a lightweight multilingual classifier for **PII in
   plain text** (no image, no OCR).
 
-**Try it live:** [ekacare/pii-redactor-demo](https://huggingface.co/spaces/ekacare/pii-redactor-demo)
+**Try it live:** [ekacare/document-pii-redactor](https://huggingface.co/spaces/ekacare/document-pii-redactor)
 — upload a document image or paste text and see detection + redaction run
 in your browser.
 
 ## Install
 
 ```bash
-pip install eka-pii-redaction
+pip install document-pii-redactor
 ```
 
 System dependency: **Tesseract OCR** — used by the **image** modality's
@@ -50,10 +50,10 @@ first, once, and every transform consumes its output.
 ### Image — text + visual PII in document images
 
 ```python
-from eka_pii_redaction import ImagePIIRedactor
+from document_pii_redactor import ImagePIIRedactor
 
 redactor = ImagePIIRedactor(
-    "ekacare/pii-redactors",
+    "ekacare/document-pii-redactor",
     detect_visual=True,  # set False to skip visual entities (QR codes,
                           # face photos, signatures, etc.) — text PII only
 )
@@ -77,9 +77,9 @@ deid.image.save("deidentified.png"); deid.mapping.to_dict()
 ### Text — PII in plain strings (no image, no OCR)
 
 ```python
-from eka_pii_redaction import TextPIIRedactor
+from document_pii_redactor import TextPIIRedactor
 
-r = TextPIIRedactor("ekacare/pii-redactors")
+r = TextPIIRedactor("ekacare/document-pii-redactor")
 
 text = "John Doe, DOB 1990-01-01, john@x.com"
 spans = r.detect(text)                   # char-offset spans — the core call
@@ -119,7 +119,7 @@ r.anonymize(text, spans)
 Anonymization is best-effort removal/generalization of detected
 identifiers — not a k-anonymity guarantee or a compliance determination.
 
-See the Eka-PII-redactors repo (https://github.com/eka-care/Eka-PII-redactors)
+See the document-pii-redactor repo (https://github.com/eka-care/document-pii-redactor)
 for the full API reference, the category taxonomy, and the Docker/FastAPI
 deployment setup (the same setup behind the demo Space above).
 
@@ -143,17 +143,17 @@ visual detector (the `ultralytics` runtime it needs is also AGPL-3.0 and
 is an optional `[visual]` extra of the pip package).
 
 The library code is Apache-2.0 at
-https://github.com/eka-care/Eka-PII-redactors.
+https://github.com/eka-care/document-pii-redactor.
 
 If you use the models or the library, please cite:
 
 ```bibtex
-@software{eka_pii_redaction,
+@software{document_pii_redactor,
   author = {{Eka Care}},
   title  = {Eka-PII-redaction: detect, redact, de-identify, or anonymize
             PII in document images and plain text},
   year   = {2026},
-  url    = {https://github.com/eka-care/Eka-PII-redactors},
-  note   = {Model weights: https://huggingface.co/ekacare/pii-redactors}
+  url    = {https://github.com/eka-care/document-pii-redactor},
+  note   = {Model weights: https://huggingface.co/ekacare/document-pii-redactor}
 }
 ```