Update README.md

README.md

@@ -1,3 +1,50 @@
----
-license: apache-2.0
----
+---
+language: pl
+tags:
+- BANonymizer-PL
+license: apache-2.0
+---
+
+# BANonymizer-PL
+
+This model is a fine-tuned version of [HerBERT-large-cased](https://huggingface.co/allegro/herbert-large-cased), a Polish language model developed by Allegro, specialized in anonymizing sensitive and personal information in Polish texts.
+
+## Training and Purpose
+The model has been fine-tuned on the [BAN-PL dataset](https://github.com/ZILiAT-NASK/BAN-PL/tree/main), which contains over 20,000 manually labeled examples and a test set of more than 2,000 examples. It is designed to detect and anonymize entities such as surnames and pseudonyms.
+
+## Applications
+This model is particularly useful for privacy-preserving tasks, such as anonymizing datasets for research purposes. Unlike other publicly available tools that primarily focus on surnames, this model uniquely handles both surnames and pseudonyms, enhancing its utility in various anonymization workflows.
+
+## Usage
+Example code:
+```python
+from transformers import AutoModelForTokenClassification, AutoTokenizer, pipeline
+
+model_name = "NASK-PIB/BANonymizer-PL"
+ner = pipeline(
+        "token-classification",
+        model=model_name,
+        aggregation_strategy="simple",
+    )
+
+text = "Pan Kowalski, znany jako 'Cichy', mieszka w Warszawie"
+result = nlp(text)
+
+print(result)
+```
+
+## License
+Apache-2.0
+
+## Citation
+If you use this model, please cite the following paper:
+```
+@misc{kołos2024banpl,
+      title={BAN-PL: a Novel Polish Dataset of Banned Harmful and Offensive Content from Wykop.pl web service}, 
+      author={Anna Kołos and Inez Okulska and Kinga Głąbińska and Agnieszka Karlińska and Emilia Wiśnios and Paweł Ellerik and Andrzej Prałat},
+      year={2024},
+      eprint={2308.10592},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```