Update README.md

README.md

@@ -7,41 +7,51 @@ size_categories:
 - 10M<n<100M
 ---
 
-# Dataset Card for Dataset Name
+# PolEval 2022 Task 2 Pretraining Dataset
 
 ## Dataset Description
 
-- **Homepage:** 
-- **Repository:** 
-- **Paper:** 
-- **Leaderboard:** 
-- **Point of Contact:** 
+* **Repository:** <https://github.com/Carbon225/poleval-2022-abbr>
+* **Paper:** TODO
 
 ### Dataset Summary
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+Abbreviation disambiguation is the process of expanding abbreviations, e.g. "eng." to the full form "engineer".
+In the Polish language the task is further complicated because of the many ways to create abbreviations and additional inflected forms.
+Abbreviation disambiguation was the topic of the 2022 PolEval Competition Task 2.
+This is the dataset used for pretraining in Jakub Karbowski's competition submission.
 
-### Supported Tasks and Leaderboards
+### Supported Tasks
 
-[More Information Needed]
+The dataset contains data suitable for:
+
+* corrupted text restoration
+* base/inflected form prediction
+* abbreviation disambiguation*
+
+*the abbreviations are not guaranteed to be gramatically correct
 
 ### Languages
 
-[More Information Needed]
+* Polish
 
 ## Dataset Structure
 
-### Data Instances
+### Fields
 
-[More Information Needed]
+* `text` -- a context of 140 to 200 characters where an abbreviation has been used
+* `labels` -- the inflected and base forms of the expanded abbreviation
 
-### Data Fields
+### Format
 
-[More Information Needed]
+The abbreviation in `text` is surrounded with `<mask>` `</mask>`.
+The `labels` format is `inflected form; base form`.
 
-### Data Splits
+### Example
 
-[More Information Needed]
+text              | labels
+------------------|-----------
+`jest zgodny ze światem, w którym istnieje problem zła i cierpienie, a <mask>bs.</mask> miłość jest ukryta przed wieloma osobami. Podobną argumentację` | `boska; boski`
 
 ## Dataset Creation