Update README.md

README.md

@@ -1,3 +1,108 @@
----
-license: cc-by-nc-sa-4.0
----
+---
+annotations_creators:
+- expert-generated
+language_creators: []
+language:
+- pl
+license:
+- cc-by-sa-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- text-retrieval
+task_ids:
+- document-retrieval
+pretty_name: 'PUGG: IR dataset for Polish'
+tags:
+- wikipedia
+---
+# PUGG: KBQA, MRC, IR Dataset for Polish
+
+## Description
+
+This repository contains the PUGG dataset designed for three NLP tasks in the Polish language:
+
+- KBQA (Knowledge Base Question Answering)
+- MRC (Machine Reading Comprehension)
+- IR (Information Retrieval)
+
+## Paper
+
+For more detailed information, please refer to our research paper titled:
+
+**"Developing PUGG for Polish: A Modern Approach to KBQA, MRC, and IR Dataset Construction"** 
+
+Authored by:
+* Albert Sawczyn
+* Katsiaryna Viarenich
+* Konrad Wojtasik
+* Aleksandra Domogała
+* Marcin Oleksy
+* Maciej Piasecki
+* Tomasz Kajdanowicz
+  
+**The paper was accepted for ACL 2024 (findings).**
+
+## Repositories
+
+The dataset is available in the following repositories:
+
+* [General](https://huggingface.co/datasets/clarin-pl/PUGG)  - contains all tasks (KBQA, MRC, IR*)
+
+For more straightforward usage, the tasks are also available in separate repositories:
+
+* [KBQA](https://huggingface.co/datasets/clarin-pl/PUGG_KBQA) 
+* [MRC](https://huggingface.co/datasets/clarin-pl/PUGG_MRC) 
+* [IR](https://huggingface.co/datasets/clarin-pl/PUGG_IR) **(this repository)**
+
+The knowledge graph for KBQA task is available in the following repository:
+
+* [Knowledge Graph](https://huggingface.co/datasets/clarin-pl/PUGG_KG) 
+
+Note: If you want to utilize the IR task in the BEIR format (`qrels` in `.tsv` format), please 
+download the [IR](https://huggingface.co/datasets/clarin-pl/PUGG_IR) repository.
+
+## Links
+
+* Code:
+  * [Github](https://github.com/CLARIN-PL/PUGG)
+* Paper:
+  * ACL - TBA
+  * [Arxiv](https://arxiv.org/abs/2408.02337)
+
+## Citation
+
+```bibtex
+@misc{sawczyn2024developingpuggpolishmodern,
+      title={Developing PUGG for Polish: A Modern Approach to KBQA, MRC, and IR Dataset Construction}, 
+      author={Albert Sawczyn and Katsiaryna Viarenich and Konrad Wojtasik and Aleksandra Domogała and Marcin Oleksy and Maciej Piasecki and Tomasz Kajdanowicz},
+      year={2024},
+      eprint={2408.02337},
+      archivePrefix={arXiv},
+      primaryClass={cs.AI},
+      url={https://arxiv.org/abs/2408.02337}, 
+}
+```
+
+## Contact
+
+[email protected]
+
+## Usage 
+
+```python
+from datasets import load_dataset
+
+dataset_corpus = load_dataset("clarin-pl/PUGG_IR", "corpus")
+print(dataset)
+
+dataset_queries = load_dataset("clarin-pl/PUGG_IR", "queries")
+print(dataset)
+
+dataset_qrels = load_dataset("clarin-pl/PUGG_IR", "qrels")
+print(dataset)
+```