Docs: symmetric variable names image_redactor / text_redactor

README.md

@@ -61,25 +61,25 @@ first, once, and every transform consumes its output.
 ```python
 from document_pii_redactor import ImagePIIRedactor
 
-redactor = ImagePIIRedactor(
+image_redactor = ImagePIIRedactor(
     "ekacare/document-pii-redactor",
     detect_visual=True,  # set False to skip visual entities (QR codes,
                           # face photos, signatures, etc.) — text PII only
 )
 
-entities = redactor.detect("page.jpg")   # list[PIIEntity] — the core call
+entities = image_redactor.detect("page.jpg")   # list[PIIEntity] — the core call
 for e in entities:
     print(e.kind, e.category, e.bbox, e.text, e.score)
 
 # Bring your own OCR (skips the built-in Tesseract step; your pixel-space
 # word boxes pass through to the emitted entities):
-entities = redactor.detect("page.jpg", words=["John", "Doe"],
-                           boxes=[[100, 20, 140, 40], [145, 20, 180, 40]])
+entities = image_redactor.detect("page.jpg", words=["John", "Doe"],
+                                 boxes=[[100, 20, 140, 40], [145, 20, 180, 40]])
 
 # One detection, three possible outputs:
-redactor.redact("page.jpg", entities).save("redacted.png")
-redactor.anonymize("page.jpg", entities).save("anonymized.png")
-deid = redactor.deidentify("page.jpg", entities)
+image_redactor.redact("page.jpg", entities).save("redacted.png")
+image_redactor.anonymize("page.jpg", entities).save("anonymized.png")
+deid = image_redactor.deidentify("page.jpg", entities)
 deid.image.save("deidentified.png"); deid.mapping.to_dict()
 ```
 
@@ -88,16 +88,16 @@ deid.image.save("deidentified.png"); deid.mapping.to_dict()
 ```python
 from document_pii_redactor import TextPIIRedactor
 
-r = TextPIIRedactor("ekacare/document-pii-redactor")
+text_redactor = 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
+spans = text_redactor.detect(text)                   # char-offset spans — the core call
 for s in spans:
     print(s.category, s.start, s.end, s.text, s.score)
 
-r.redact(text, spans, mask="[REDACTED]")
-r.anonymize(text, spans)
-r.deidentify(text, spans)                # .text + .mapping
+text_redactor.redact(text, spans, mask="[REDACTED]")
+text_redactor.anonymize(text, spans)
+text_redactor.deidentify(text, spans)                # .text + .mapping
 ```
 
 ### De-identify and anonymize (v0.2.0+, both modalities)
@@ -119,13 +119,13 @@ Beyond redaction, both redactors support:
 
 ```python
 text = "Mr. John Doe, 45 yrs, DOB 12-03-1979, Indiranagar, Karnataka."
-spans = r.detect(text)
+spans = text_redactor.detect(text)
 
-result = r.deidentify(text, spans)
+result = text_redactor.deidentify(text, spans)
 result.text     # "Person_1, Age_1 yrs, DOB Date_1, City_1, State_1."
 result.mapping  # yours to store securely; never persisted by the library
 
-r.anonymize(text, spans)
+text_redactor.anonymize(text, spans)
 # -> "[PERSON], 40–49 yrs, DOB 1979, [LOCATION], Karnataka."
 ```