Create README.md

README.md

@@ -0,0 +1,37 @@
+---
+
+language: pl
+
+license: cc-by-sa-4.0
+
+datasets:
+
+- 18th and 19th century articles mentioning Japan
+
+---
+
+# Model for Detection of Japan-related topics 
+
+This model was based on the original [HerBERT](https://huggingface.co/allegro/herbert-base-cased) Base. 
+
+It was trained on a set of 18th and 19th century articles mentioning Japan to discriminate whether a new input text mentions Japan (or similar oriental topics).
+
+## Licenses
+
+The finetuned model with all attached files is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/), or Creative Commons Attribution-ShareAlike 4.0 International License. 
+
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a>
+
+## Citations
+
+Please, cite this model using the following citation.
+
+```
+@inproceedings{ptaszynski2022herbert-japan,
+  title={Finetuned HerBERT model for detecting Japan and related oriebntal topics}, 
+  author={Michal Ptaszynski and Pawel Dybala and Third Author}, 
+  booktitle={HuggingFace}, 
+  url={https://huggingface.co/ptaszynski/japan-topic-detection}
+  year={2022}
+}
+```