andreaskoepf commited on
Commit
c5ca5f1
1 Parent(s): 06c4be1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -7
README.md CHANGED
@@ -110,7 +110,7 @@ language:
110
  tags:
111
  - human-feedback
112
  size_categories:
113
- - 10K<n<100K
114
  pretty_name: OpenAssistant Conversations
115
  ---
116
 
@@ -249,8 +249,8 @@ all messages of a message tree or to select trees by their state.
249
  ### Ready For Export Trees
250
 
251
  ```
252
- 2023-04-12_oasst_ready.trees.jsonl.gz 10364 trees with 88838 total messages
253
- 2023-04-12_oasst_ready.messages.jsonl.gz 88838 messages
254
  ```
255
  Trees in `ready_for_export` state without spam and deleted messages including message labels.
256
  The oasst_ready-trees file is normally sufficient for supervised fine-tuning (SFT) & reward model (RM) training.
@@ -259,8 +259,8 @@ The oasst_ready-trees file is normally sufficient for supervised fine-tuning (SF
259
  ### All Trees
260
 
261
  ```
262
- 2023-04-12_oasst_all.trees.jsonl.gz 66497 trees with 161443 total messages
263
- 2023-04-12_oasst_all.messages.jsonl.gz 161443 messages
264
  ```
265
  All trees including those in states `prompt_lottery_waiting` (trees that consist of only one message, namely the inital prompt),
266
  `aborted_low_grade` (trees that stopped growing because the messages had low quality), and `halted_by_moderator`.
@@ -274,12 +274,28 @@ All trees including those in states `prompt_lottery_waiting` (trees that consist
274
  Messages which were deleted or have a negative review result (`"review_result": false`).
275
  Beside low quality a frequent reason for message deletion is a wrong language tag.
276
 
277
-
278
  ```
279
  2023-04-12_oasst_prompts.messages.jsonl.gz
280
  ```
281
  All non-deleted initial prompt messages with positile spam review result of trees in `ready_for_export` or `prompt_lottery_waiting` state.
282
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
283
 
284
  ### Languages
285
 
@@ -332,4 +348,4 @@ OpenAssistant Conversations incorporates 35 different languages with a distribut
332
 
333
  - Discord [Open Assistant Discord Server](https://ykilcher.com/open-assistant-discord)
334
  - GitHub: [LAION-AI/Open-Assistant](https://github.com/LAION-AI/Open-Assistant)
335
- - E-Mail: [open-assistent@laion.ai](mailto:open-assistent@laion.ai) (yes, with e)
 
110
  tags:
111
  - human-feedback
112
  size_categories:
113
+ - 100K<n<1M
114
  pretty_name: OpenAssistant Conversations
115
  ---
116
 
 
249
  ### Ready For Export Trees
250
 
251
  ```
252
+ 2023-04-12_oasst_ready.trees.jsonl.gz 10,364 trees with 88,838 total messages
253
+ 2023-04-12_oasst_ready.messages.jsonl.gz 88,838 messages
254
  ```
255
  Trees in `ready_for_export` state without spam and deleted messages including message labels.
256
  The oasst_ready-trees file is normally sufficient for supervised fine-tuning (SFT) & reward model (RM) training.
 
259
  ### All Trees
260
 
261
  ```
262
+ 2023-04-12_oasst_all.trees.jsonl.gz 66,497 trees with 161,443 total messages
263
+ 2023-04-12_oasst_all.messages.jsonl.gz 161,443 messages
264
  ```
265
  All trees including those in states `prompt_lottery_waiting` (trees that consist of only one message, namely the inital prompt),
266
  `aborted_low_grade` (trees that stopped growing because the messages had low quality), and `halted_by_moderator`.
 
274
  Messages which were deleted or have a negative review result (`"review_result": false`).
275
  Beside low quality a frequent reason for message deletion is a wrong language tag.
276
 
 
277
  ```
278
  2023-04-12_oasst_prompts.messages.jsonl.gz
279
  ```
280
  All non-deleted initial prompt messages with positile spam review result of trees in `ready_for_export` or `prompt_lottery_waiting` state.
281
 
282
+ ### Using the Huggingface Datasets
283
+
284
+ While HF datasets is ideal for tabular datasets it is not a natuaral fit for nested data structures like the OpenAssistant conversation trees.
285
+ Nevertheless we make all messages which can alse be found in the file `2023-04-12_oasst_ready.trees.jsonl.gz` available as parquet train/validation
286
+ split which is directly loadable by the [Huggingface Datasets](https://pypi.org/project/datasets/).
287
+
288
+ To load the oasst1 train & validation splits use:
289
+
290
+ ```python
291
+ from datasets import load_dataset
292
+ ds = load_dataset("OpenAssistant/oasst1")
293
+ train = ds['train'] # len(train)=84437 (95%)
294
+ val = ds['validation'] # len(val)=4401 (5%)
295
+ ```
296
+
297
+ The messages appear in depth-first order of the message trees.
298
+
299
 
300
  ### Languages
301
 
 
348
 
349
  - Discord [Open Assistant Discord Server](https://ykilcher.com/open-assistant-discord)
350
  - GitHub: [LAION-AI/Open-Assistant](https://github.com/LAION-AI/Open-Assistant)
351
+ - E-Mail: [open-assistent@laion.ai](mailto:open-assistent@laion.ai) (yes, with e)