From 6110d1102af996f2623678eb4502d3f1cfd9ddef Mon Sep 17 00:00:00 2001
From: Ali Safaya <alisafaya@gmail.com>
Date: Wed, 11 Aug 2021 17:27:26 +0300
Subject: [PATCH] =?UTF-8?q?add=20documentation=20#Ac=C4=B1khack2021?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 63 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index cffd8f9..3f3f734 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,63 @@
-# trnews-64
-trnews-64 character language modeling dataset that contain 64 million words of news articles and columns.
+# trnews-64 dataset
+
+__trnews-64__ is a character language modeling dataset that contain 64 million words of news articles and columns.
+It can be utilized as a benchmark for different modeling long range dependencies in Turkish language.
+
+This dataset contains a mix of news articles from different topics and journals from different domains retrieved from [TS Timeline Corpus](https://tscorpus.com/corpora/ts-timeline-corpus/).
+
+## Preprocessing
+
+This dataset was preprocessed and clean from infrequent characters. The main character set is shared in the file `tr.charset.json`, which contains 124 characters in total. This includes Turkish upper/lower case characters along with punctuations and some other common characters. 
+
+## Details
+
+Dataset splits are shared in raw text format and the articles are seperated by empty lines.
+
+**Example**:
+
+```
+Dolar dün 2.5075 liraya kadar çıkarak rekor kırmasının ordından bugün 2.49 - 2.50 lira aralığında hareket etti. Cari işlemler açığının beklentilere paralel gelmesinin de etkisiyle 2.4820 liraya kadar çekilen dolar, daha sonra gelens alımlarla 2.5085'e çıkarak rekorunu tazeledi. ABD para birimi daha sonra 2.5050 - 2.5070 düzeylerinde hareket ederken, euro da 2.8380 lira düzeylerine çıktı ve yarı yarıya euro ve dolardan oluşan döviz sepeti de 2.63 düzeyinin üstüne çıktı.
+
+DW Türkçe Servisi’nin aktardığına göre, ‘Aghet’ (Ağıt) konserinin Almanya’nın İstanbul Başkonsolosluğu’ndaki temsiline Cumhurbaşkanı Recep Tayyip Erdoğan da davet edildi. Alman haber ajansı dpa’nın haberinde, Erdoğan’ın yanı sıra Başbakan Binali Yıldırım, Dışişleri Bakanı Mevlüt Çavuşoğlu ile Kültür ve Turizm Bakanı Nabi Avcı’nın da davetliler arasında olduğu belirtildi. Habere göre, gönderilen davetiyelerde etkinlikte ‘Türk ve Ermeni geçmişlerindeki yaralar’ ile ifade ve sanat özgürlüğünün ele alınacağı ifade edildi. Dresden Senfoni Orkestrası tarafından hazırlanan ‘Aghet’ konseri, İstanbul Başkonsolosluğu’nda 13 Kasım’da gerçekleştirilecek. Etkinlikte ayrıca Türk-Ermeni-Alman Dostluk Derneği’nin kurulması planlanıyor.
+```
+
+This dataset is split based on the number of articles for each split. In the table below you can find some statistics:
+
+|                                 | train  |  val  | test  | total  |
+|---------------------------------|--------|-------|-------|--------|
+| # of Articles                   | 140000 | 5000  | 5000  | 150000 |
+| Raw text size                   | 402MBs | 15MBs | 15MBs | 431MBs |
+| Total # of words                | 59.7M  | 2.1M  | 2.1M  |  64M   |
+| Avg. # of words per article     |  426   |  424  | 420   |  426   |
+| Avg. # of sentences per article |  23    |  22.8 | 22.9  |  23    |
+
+## Splitting articles
+
+To seperate articles with their titles you can use this snippet: 
+
+```python
+import re
+
+with open("trnews-64.test.raw") as fi:
+    articles = re.split("\n\n", fi.read()) 
+```
+
+## Citation
+
+```
+@dataset{ali_safaya_2021_5180654,
+  author       = {Ali Safaya and
+                  Taner Sezer},
+  title        = {trnews-64},
+  month        = aug,
+  year         = 2021,
+  publisher    = {Zenodo},
+  version      = {1.0},
+  doi          = {10.5281/zenodo.5180654},
+  url          = {https://doi.org/10.5281/zenodo.5180654}
+}
+```
+
+## Contact
+
+Ali Safaya (alisafaya at gmail dot com).