Update README.md

README.md

@@ -89,6 +89,114 @@ task_categories:
 - text-generation
 language:
 - ru
+- en
 ---
 
-# Habrahabr dataset
+# Habr dataset
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Description](#description)
+- [Usage](#usage)
+- [Data Instances](#data-instances)
+- [Source Data](#source-data)
+- [Personal and Sensitive Information](#personal-and-sensitive-information)
+
+## Description
+
+**Summary:** Dataset of posts and comments from [habr.com](https://habr.com/ru/all/).
+
+**Script:** [save_habr.py](https://github.com/IlyaGusev/rulm/blob/master/data_processing/save_habr.py)
+
+**Point of Contact:** [Ilya Gusev](ilya.gusev@phystech.edu)
+
+**Languages:** Russian, English, some programming code.
+
+
+## Usage
+
+```python
+from datasets import load_dataset
+dataset = load_dataset('IlyaGusev/habr', split="train")
+```
+
+## Data Instances
+
+```
+{
+  "id": 12730,
+  "language": "ru",
+  "url": "https://habr.com/ru/post/12730/",
+  "text_markdown": "...",
+  "text_html": "...",
+  "lead_markdown": "...",
+  "lead_html": "...",
+  "type": "article",
+  "labels": [],
+  "original_author": null,
+  "original_url": null,
+  "time_published": 1185962380,
+  "author": "...",
+  "title": "Хочешь в университет — сделай презентацию",
+  "statistics": {
+    "commentsCount": 23,
+    "favoritesCount": 1,
+    "readingCount": 1542,
+    "score": 7,
+    "votesCount": 15,
+    "votesCountPlus": 11,
+    "votesCountMinus": 4
+  },
+  "hubs": [
+    "itcompanies"
+  ],
+  "flows": [
+    "popsci"
+  ],
+  "tags": [
+    "PowerPoint",
+    "презентация",
+    "абитуриенты",
+  ],
+  "reading_time": 1,
+  "format": null,
+  "complexity": null,
+  "comments": [
+    {
+      "id": 11653537,
+      "parent_id": null,
+      "level": 0,
+      "time_published": 1185963192,
+      "score": -1,
+      "votes": 1,
+      "message_html": "...",
+      "author": "...",
+      "children": [
+        11653541
+      ]
+    },
+    {
+      "id": 11653541,
+      "parent_id": 11653537,
+      "level": 1,
+      "time_published": 1185967886,
+      "score": 0,
+      "votes": 0,
+      "message_html": "...",
+      "message_markdown": "...",
+      "author": "..."
+    }
+  ]
+}
+```
+
+
+## Source Data
+
+* The data source is the [Habr](https://habr.com/) website.
+* API call example: [post 709430](https://habr.com/kek/v2/articles/709430).
+* Processing script is [here](https://github.com/IlyaGusev/rulm/blob/master/data_processing/save_habr.py). 
+
+## Personal and Sensitive Information
+
+The dataset is not anonymized, so individuals' names can be found in the dataset. Information about the original authors is included in the dataset where possible.