Update README.md

README.md

@@ -1,5 +1,11 @@
 ---
 license: other
+task_categories:
+- text-generation
+language:
+- ru
+size_categories:
+- 100K<n<1M
 dataset_info:
   features:
   - name: question_id
@@ -71,3 +77,113 @@ dataset_info:
   download_size: 670468664
   dataset_size: 3013377174
 ---
+
+# Dataset Card for Russian StackOverflow
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Languages](#languages)
+  - [Usage](#usage)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Licensing Information](#licensing-information)
+
+## Dataset Description
+
+**Summary**: Dataset of questions, answers, and comments from [ru.stackoverflow.com](https://ru.stackoverflow.com/).
+
+**Script:** [create_stackoverflow.py](https://github.com/IlyaGusev/rulm/blob/hf/data_processing/create_stackoverflow.py)
+
+**Point of Contact:** [Ilya Gusev]([email protected])
+
+### Languages
+
+The dataset is in Russian with some programming code.
+
+### Usage
+
+```python
+from datasets import load_dataset
+dataset = load_dataset('IlyaGusev/ru_stackoverflow', split="train")
+```
+
+## Dataset Structure
+
+### Data Instances
+For each instance, there is a string for the article, a string for the summary, and a string for the url. Additionally, a string for the title and a date are provided.
+
+```
+{
+  "question_id": 11235,
+  "answer_count": 1,
+  "url": "https://ru.stackoverflow.com/questions/11235",
+  "score": 2,
+  "tags": ["c++", "сериализация"],
+  "title": "Извлечение из файла, запись в файл",
+  "views": 1309,
+  "author": "...",
+  "timestamp": 1303205289,
+  "text_html": "...",
+  "text_markdown": "...",
+  "comments": [
+    {
+      "text": "...",
+      "author": "...",
+      "comment_id": 11236,
+      "score": 0,
+      "timestamp": 1303205411
+    }
+  ],
+  "answers": [
+    {
+      "answer_id": 11243,
+      "timestamp": 1303207791,
+      "is_accepted": 1,
+      "text_html": "...",
+      "text_markdown": "...",
+      "score": 3,
+      "author": "...",
+      "comments": [
+        {
+          "text": "...",
+          "author": "...",
+          "comment_id": 11246,
+          "score": 0,
+          "timestamp": 1303207961
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Dataset Creation
+
+### Curation Rationale
+
+[TBW]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+* The data source is the [Russian StackOverflow](https://ru.stackoverflow.com/) website.
+* Original XMLs: [ru.stackoverflow.com.7z](https://ia600107.us.archive.org/27/items/stackexchange/ru.stackoverflow.com.7z).
+* Processing script is [here](https://github.com/IlyaGusev/rulm/blob/hf/data_processing/create_stackoverflow.py). 
+
+#### Who are the source language producers?
+
+Texts and summaries were written by website users.
+
+### 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.
+
+## Licensing Information
+
+According to the license of original data, this dataset is distributed under [CC BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).