update README & prompt/spam file names

README.md

@@ -71,47 +71,157 @@ dataset_info:
     num_examples: 6599
   download_size: 66674129
   dataset_size: 166813577
+language:
+- en
+- es
+- ru
+- de
+- pl
+- th
+- vi
+- sv
+- bn
+- da
+- he
+- it
+- fa
+- sk
+- id
+- nb
+- el
+- nl
+- hu
+- eu
+- zh
+- eo
+- ja
+- ca
+- cs
+- bg
+- fi
+- pt
+- tr
+- ro
+- ar
+- uk
+- gl
+- fr
+- ko
+tags:
+- human-feedback
+size_categories:
+- 100K<n<1M
+pretty_name: OpenAssistant Conversations Release 2
 ---
 
+# Open Assistant Conversations Dataset Release 2  (OASST2)
 
-### 2023-11-05_oasst2_all.trees.jsonl.gz
+## Dataset Description
 
+- **Homepage:** https://www.open-assistant.io/
+- **Repository:** https://github.com/LAION-AI/Open-Assistant
+- **Paper:** https://arxiv.org/abs/2304.07327
+
+
+
+### Ready For Export Trees
+
+```
+2023-11-05_oasst2_ready.trees.jsonl.gz      13,854 trees with 135,174 total messages
+2023-11-05_oasst2_ready.messages.jsonl.gz   135,174 messages
+```
+
+#### 2023-11-05_oasst2_ready.trees.jsonl.gz Stats
+```
+Trees            : 13,854
+Messages         : 135,174
+Oldest message   : 2023-01-16 20:24:26.211711+00:00
+Youngest message : 2023-11-04 15:23:03.239343+00:00
+Detoxify ratings : 111,448
+Accepted messages: 129,517
+Deleted messages : 4,376
+Tree counts by state:
+  - ready_for_export: 13,854
+Message counts by language:
+  - en: 64,513
+  - es: 28,199
+  - ru: 13,935
+  - zh: 8,615
+  - de: 6,145
+  - fr: 3,880
+  - pt-BR: 2,699
+  - th: 1,560
+  - ca: 1,283
+  - it: 943
+  - uk-UA: 845
+  - ja: 788
+  - pl: 435
+  - eo: 295
+  - eu: 274
+  - vi: 207
+  - fi: 138
+  - hu: 113
+  - ar: 80
+  - nl: 72
+  - da: 44
+  - tr: 37
+  - ko: 24
+  - he: 24
+  - id: 12
+  - cs: 12
+  - bn: 1
+  - sv: 1
+```
+
+Trees in ready_for_export state without spam and deleted messages including message labels. The oasst_ready-trees file usually is sufficient for supervised fine-tuning (SFT) & reward model (RM) training.
+
+### All Trees
+
+```
+2023-11-05_oasst2_all.trees.jsonl.gz        70,642 trees with 208,584 total messages
+2023-11-05_oasst2_all.messages.jsonl.gz     208,584 messages
 ```
-Trees            : 70642
-Messages         : 208584
+
+All trees, including those in states prompt_lottery_waiting (trees that consist of only one message, namely the initial prompt), aborted_low_grade (trees that stopped growing because the messages had low quality), and halted_by_moderator.
+
+#### 2023-11-05_oasst2_all.trees.jsonl.gz Stats
+
+```
+Trees            : 70,642
+Messages         : 208,584
 Oldest message   : 2023-01-16 20:24:26.211711+00:00
 Youngest message : 2023-11-05 10:24:44.484910+00:00
-Detoxify ratings : 156570
-Accepted messages: 189288
-Deleted messages : 5414
+Detoxify ratings : 156,570
+Accepted messages: 189,288
+Deleted messages : 5,414
 Tree counts by state:
-  - ready_for_export: 13854
-  - prompt_lottery_waiting: 44550
-  - halted_by_moderator: 3089
-  - initial_prompt_review: 4319
-  - growing: 3102
-  - aborted_low_grade: 1708
+  - ready_for_export: 13,854
+  - prompt_lottery_waiting: 44,550
+  - halted_by_moderator: 3,089
+  - initial_prompt_review: 4,319
+  - growing: 3,102
+  - aborted_low_grade: 1,708
   - ranking: 20
 Message counts by language:
-  - en: 85115
-  - es: 47513
-  - ru: 15990
-  - zh: 11205
-  - de: 8398
-  - fr: 5841
-  - pt-BR: 4540
-  - th: 3236
-  - ca: 2586
-  - it: 2144
-  - ja: 1904
-  - uk-UA: 1889
-  - ko: 1635
-  - pl: 1510
-  - eo: 1405
-  - nl: 1354
-  - ar: 1274
-  - vi: 1137
-  - fi: 1098
+  - en: 85,115
+  - es: 47,513
+  - ru: 15,990
+  - zh: 11,205
+  - de: 8,398
+  - fr: 5,841
+  - pt-BR: 4,540
+  - th: 3,236
+  - ca: 2,586
+  - it: 2,144
+  - ja: 1,904
+  - uk-UA: 1,889
+  - ko: 1,635
+  - pl: 1,510
+  - eo: 1,405
+  - nl: 1,354
+  - ar: 1,274
+  - vi: 1,137
+  - fi: 1,098
   - eu: 995
   - hu: 961
   - tr: 803
@@ -136,33 +246,43 @@ Message counts by language:
   - lt: 7
 ```
 
-### Ready For Export Trees
+### Supplemental Exports: Spam & Prompts 
 
 ```
-2023-11-05_oasst2_ready.trees.jsonl.gz      13,854 trees with 135,174 total messages
-2023-11-05_oasst2_ready.messages.jsonl.gz   135,174 messages
+2023-11-05_oasst2_spam.messages.jsonl.gz    19,296 matching messages
 ```
 
-Trees in ready_for_export state without spam and deleted messages including message labels. The oasst_ready-trees file usually is sufficient for supervised fine-tuning (SFT) & reward model (RM) training.
-
-### All Trees
+These are messages which were deleted or have a negative review result ("review_result": false). Besides low quality, a frequent reason for message deletion is a wrong language tag.
 
 ```
-2023-11-05_oasst2_all.trees.jsonl.gz        70,642 trees with 208,584 total messages
-2023-11-05_oasst2_all.messages.jsonl.gz     208,584 messages
+2023-11-05_oasst2_prompts.messages.jsonl.gz 64,592 matching messages
 ```
 
-All trees, including those in states prompt_lottery_waiting (trees that consist of only one message, namely the initial prompt), aborted_low_grade (trees that stopped growing because the messages had low quality), and halted_by_moderator.
+These are all the kept initial prompt messages with positive review result (no spam) of trees in `ready_for_export` or `prompt_lottery_waiting` state.
 
+### Using the Huggingface Datasets
 
-### Supplemental Exports: Spam & Prompts 
+While HF datasets is ideal for tabular datasets, it is not a natural fit for nested data structures like the OpenAssistant conversation trees.
+Nevertheless, we make all messages which can also be found in the file `2023-04-12_oasst_ready.trees.jsonl.gz` available in parquet as train/validation splits. 
+These are directly loadable by [Huggingface Datasets](https://pypi.org/project/datasets/).
 
-```
-2023-11-05_oasst2_spam.jsonl.gz             19,296 matching messages
+To load the oasst1 train & validation splits use:
+
+```python
+from datasets import load_dataset
+ds = load_dataset("OpenAssistant/oasst2")
+train = ds['train']      # len(train)=128575 (95%)
+val = ds['validation']   # len(val)=6599 (5%)
 ```
 
-These are messages which were deleted or have a negative review result ("review_result": false). Besides low quality, a frequent reason for message deletion is a wrong language tag.
+The messages appear in depth-first order of the message trees.
 
-```
-2023-11-05_oasst2_prompts.jsonl.gz          64,592 matching messages
-```
+Full conversation trees can be reconstructed from the flat messages table by using the `parent_id` 
+and `message_id` properties to identify the parent-child relationship of messages. The `message_tree_id` 
+and `tree_state` properties (only present in flat messages files) can be used to find all messages of a message tree or to select trees by their state.
+
+## Contact
+
+- Discord [Open Assistant Discord Server](https://ykilcher.com/open-assistant-discord)
+- GitHub: [LAION-AI/Open-Assistant](https://github.com/LAION-AI/Open-Assistant)
+- E-Mail: [[email protected]](mailto:[email protected])