Add README.md

README.md

@@ -0,0 +1,81 @@
+---
+license: apache-2.0
+language:
+- en
+library_name: transformers
+pipeline_tag: token-classification
+base_model: distilroberta-base
+datasets:
+- aitrainingdatabroker/synthetic-invoice-pii-spans
+tags:
+- pii
+- pii-detection
+- invoices
+- ner
+- de-identification
+- redaction
+- synthetic
+---
+
+# Invoice PII Detector
+
+Finds personal and account details in invoice and payment text: PERSON, ORG, EMAIL, PHONE, ADDRESS, DATE, MONEY, INVOICE_ID, BANK_ACCOUNT and TAX_ID.
+
+Every name, number and sentence it was trained on is made up. Nothing comes from a real person, customer or business.
+
+Related tool: [pii-pattern-scanner](https://huggingface.co/spaces/aitrainingdatabroker/pii-pattern-scanner) (a Space that runs in your browser).
+
+## Why it exists
+
+Accounting and ERP records hold names, addresses and account numbers next to the figures an AI lab might value. This model flags the candidates so a person can review them before the records are shared.
+
+## Use it
+
+```python
+from transformers import pipeline
+
+tagger = pipeline("token-classification", model="aitrainingdatabroker/invoice-pii-detector", aggregation_strategy="simple")
+for hit in tagger("Please remit $4,310.00 to account 0048215937 by March 4, 2026 quoting INV-204517."):
+    print(hit["entity_group"], hit["word"], round(hit["score"], 3))
+```
+
+## How it was trained
+
+Fine-tuned from `distilroberta-base` for 8 epochs on one RTX 3070. Training data: 280 rows from [synthetic-invoice-pii-spans](https://huggingface.co/datasets/aitrainingdatabroker/synthetic-invoice-pii-spans), all invented, with test rows built from templates the model never saw in training. The scripts that built the data and trained the model are in `source/`; the full scores are in `scores.json`.
+
+## Test scores
+
+Exact entity match on 120 held-out rows: precision 0.943, recall 0.962, F1 0.953.
+
+| Type | Precision | Recall | F1 | Count |
+|---|---|---|---|---|
+| `ADDRESS` | 1.0 | 1.0 | 1.0 | 30 |
+| `BANK_ACCOUNT` | 0.591 | 0.433 | 0.5 | 30 |
+| `DATE` | 1.0 | 1.0 | 1.0 | 60 |
+| `EMAIL` | 1.0 | 1.0 | 1.0 | 30 |
+| `INVOICE_ID` | 1.0 | 1.0 | 1.0 | 60 |
+| `MONEY` | 1.0 | 1.0 | 1.0 | 60 |
+| `ORG` | 1.0 | 1.0 | 1.0 | 60 |
+| `PERSON` | 1.0 | 1.0 | 1.0 | 60 |
+| `PHONE` | 1.0 | 1.0 | 1.0 | 30 |
+| `TAX_ID` | 0.638 | 1.0 | 0.779 | 30 |
+
+## Limits
+
+- Trained only on invented text from templates, with test sentences built from templates it never saw. Real text varies far more.
+- Single lines, not tables or scanned PDFs. Account and tax numbers in the training data are not real numbers, and real formats vary by country.
+- This model is not legal advice and not a certification. A person should review its output before anything is shared or decided, and your counsel decides what a rule requires.
+
+## Read more
+
+- [Can you license accounting and ERP records?](https://aitrainingdatabroker.com/data/accounting-and-erp-records/?utm_source=huggingface&utm_medium=model&utm_campaign=invoice-pii-detector)
+- [QuickBooks data export for AI licensing](https://aitrainingdatabroker.com/data/quickbooks-data-export/?utm_source=huggingface&utm_medium=model&utm_campaign=invoice-pii-detector)
+- [Can an accounting firm license data to AI?](https://aitrainingdatabroker.com/sell/accounting-firms/?utm_source=huggingface&utm_medium=model&utm_campaign=invoice-pii-detector)
+
+## License and credit
+
+Apache 2.0. Please credit **AI Training Data Broker** and link to https://aitrainingdatabroker.com/ when you share or build on it.
+
+## About
+
+AI Training Data Broker is a broker and technical advisor for companies that sell or license their data to AI labs. It guides the technical side, including export, format, de-identification and compliance, and publishes free guides, checklists and tools.