Update README.md

README.md

@@ -8,4 +8,37 @@ tags:
 - privacy
 - intent
 - privacy policies
----
+---
+
+# privacy_intent for privacy policy intent classification
+
+This model fine-tuned version of [mukund/privbert](https://huggingface.co/mukund/privbert) model on [PolicyIE dataset ](https://github.com/wasiahmad/PolicyIE/blob/main/data/sanitized_split.zip).
+
+- Reference Paper: [Intent Classification and Slot Filling for Privacy Policies](https://aclanthology.org/2021.acl-long.340/). 
+  
+<b>5 Intents (Labels)</b>: 
+
+*(1) Data Collection/Usage: What, why and how user information is collected;*
+
+*(2) Data Sharing/Disclosure: What, why and how user information is shared with or collected by third parties;*
+
+*(3) Data Storage/Retention: How long and where user information will be stored;*
+
+*(4) Data Security/Protection: Protection measures for user information;*
+
+*(5) Other: Other privacy practices that do not fall into the above four categories.*
+
+```python
+from transformers import pipeline
+
+pipe = pipeline("text-classification", "remzicam/privacy_intent")
+text="At any time during your use of the Services, you may decide to share some information or content publicly or privately."
+pipe(text)
+```
+
+Output
+
+```
+[{'label': 'data-sharing-disclosure', 'score': 0.8373807072639465}]
+
+```