Create README.md

README.md

@@ -0,0 +1,44 @@
+### Overview
+
+`pii-phi` is a fine-tuned version of `Phi-3.5-mini-instruct` designed to extract Personally Identifiable Information (PII) from unstructured text. The model outputs PII entities in a structured JSON format according to strict schema guidelines.
+
+### Training Prompt Format
+
+```text
+# GUIDELINES
+- Extract all instances of the following Personally Identifiable Information (PII) entities from the provided text and return them in JSON format.
+- Each item in the JSON list should include an 'entity' key specifying the type of PII and a 'value' key containing the extracted information.
+- The supported entities are: PERSON_NAME, BUSINESS_NAME, API_KEY, USERNAME, API_ENDPOINT, WEBSITE_ADDRESS, PHONE_NUMBER, EMAIL_ADDRESS, ID, PASSWORD, ADDRESS.
+
+# EXPECTED OUTPUT
+- The json output must be in the format below:
+{
+    "result": [
+        {"entity": "ENTITY_TYPE", "value": "EXTRACTED_VALUE"},
+        ...
+    ]
+}
+```
+
+### Supported Entities
+
+* PERSON\_NAME
+* BUSINESS\_NAME
+* API\_KEY
+* USERNAME
+* API\_ENDPOINT
+* WEBSITE\_ADDRESS
+* PHONE\_NUMBER
+* EMAIL\_ADDRESS
+* ID
+* PASSWORD
+* ADDRESS
+
+### Intended Use
+
+The model is intended for PII detection in text documents to support tasks such as data anonymization, compliance, and security auditing.
+
+### Limitations
+
+* Not guaranteed to detect all forms of PII in every context.
+* May return false positives or omit contextually relevant information.