README.md

---
annotations_creators: []
language_creators: []
language:
- pl
- en
license:
- cc-by-sa-4.0
multilinguality:
- monolingual
- multilingual
size_categories: []
source_datasets:
- found
task_categories: []
task_ids: []
pretty_name: 'PUGG: KG for KBQA task in Polish'
tags:
- knowledge graph
- KBQA
- wikipedia
- wikidata
configs:
- config_name: 1H_triples
  data_files:
  - split: train
    path: 1/triples.jsonl
- config_name: 1H_attributes
  data_files:
  - split: train
    path: 1/attributes.jsonl
- config_name: 1H_labels_en
  data_files:
  - split: train
    path: 1/labels_en.jsonl
- config_name: 1H_descriptions
  data_files:
  - split: train
    path: 1/descriptions.jsonl
- config_name: 1H_aliases
  data_files:
  - split: train
    path: 1/aliases.jsonl
- config_name: 1H_labels_pl
  data_files:
  - split: train
    path: 1/labels_pl.jsonl
- config_name: 1H_times
  data_files:
  - split: train
    path: 1/times.jsonl
- config_name: 2H_triples
  data_files:
  - split: train
    path: 2/triples.jsonl
- config_name: 2H_attributes
  data_files:
  - split: train
    path: 2/attributes.jsonl
- config_name: 2H_labels_en
  data_files:
  - split: train
    path: 2/labels_en.jsonl
- config_name: 2H_descriptions
  data_files:
  - split: train
    path: 2/descriptions.jsonl
- config_name: 2H_aliases
  data_files:
  - split: train
    path: 2/aliases.jsonl
- config_name: 2H_labels_pl
  data_files:
  - split: train
    path: 2/labels_pl.jsonl
- config_name: 2H_times
  data_files:
  - split: train
    path: 2/times.jsonl
---
# PUGG: KBQA, MRC, IR Dataset for Polish

## Description

This repository contains the **knowledge graph** dedicated for 
the KBQA (Knowledge Base Question Answering) task within the PUGG dataset. This repository does not 
contain directly any task, but it provides the knowledge graph that can be used to solve the KBQA 
task from the PUGG dataset.


### Graphs

We provide sampled versions of the knowledge graph based on Wikidata:

- **Wikidata1H**: A subgraph created by traversing 1 relation from each answer and topic entity.
- **Wikidata2H**: A subgraph created by traversing 2 relations from each answer and topic entity.

### How We Created the Graphs

1. We used the Wikidata dump from 2023-10-16. The dump is available on S3 via the DVC tool (see [code repository](https://github.com/CLARIN-PL/PUGG)).
2. We collected all answer and topic entities from the PUGG dataset.
3. We traversed the graph from each answer and topic entity for *n* hops.
4. We filtered out entities that do not have labels in Polish.
5. We saved the subgraphs in various structures:
    * triples
    * labels_pl
    * labels_en
    * aliases (Polish) 
    * descriptions (Polish)
    * attributes
    * times

See [Usage](#usage) for more information on how to load the graphs.

## 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 PUGG 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) 

The knowledge graph for KBQA task is available in the following repository:

* [Knowledge Graph](https://huggingface.co/datasets/clarin-pl/PUGG_KG) **(this repository)**

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

albert.sawczyn@pwr.edu.pl

## Usage 

```python
from datasets import load_dataset

dataset_1H_triples = load_dataset("clarin-pl/PUGG_KG", '1H_triples')
print(dataset_1H_triples)

dataset_1H_labels_pl = load_dataset("clarin-pl/PUGG_KG", '1H_labels_pl')
print(dataset_1H_labels_pl)

dataset_1H_labels_en = load_dataset("clarin-pl/PUGG_KG", '1H_labels_en')
print(dataset_1H_labels_en)

dataset_1H_aliases = load_dataset("clarin-pl/PUGG_KG", '1H_aliases')
print(dataset_1H_aliases)

dataset_1H_descriptions = load_dataset("clarin-pl/PUGG_KG", '1H_descriptions')
print(dataset_1H_descriptions)

dataset_1H_attributes = load_dataset("clarin-pl/PUGG_KG", '1H_attributes')
print(dataset_1H_attributes)

dataset_1H_times = load_dataset("clarin-pl/PUGG_KG", '1H_times')
print(dataset_1H_times)

dataset_2H_triples = load_dataset("clarin-pl/PUGG_KG", '2H_triples')
print(dataset_2H_triples)

dataset_2H_labels_pl = load_dataset("clarin-pl/PUGG_KG", '2H_labels_pl')
print(dataset_2H_labels_pl)

dataset_2H_labels_en = load_dataset("clarin-pl/PUGG_KG", '2H_labels_en')
print(dataset_2H_labels_en)

dataset_2H_aliases = load_dataset("clarin-pl/PUGG_KG", '2H_aliases')
print(dataset_2H_aliases)

dataset_2H_descriptions = load_dataset("clarin-pl/PUGG_KG", '2H_descriptions')
print(dataset_2H_descriptions)

dataset_2H_attributes = load_dataset("clarin-pl/PUGG_KG", '2H_attributes')
print(dataset_2H_attributes)

dataset_2H_times = load_dataset("clarin-pl/PUGG_KG", '2H_times')
print(dataset_2H_times)
```