Datasets:
merge changes
Browse files
README.md
CHANGED
@@ -134,18 +134,18 @@ Please refer to our [paper](https://www.ykilcher.com/OA_Paper_2023_04_15.pdf) fo
|
|
134 |
|
135 |
### Dataset Structure
|
136 |
|
137 |
-
This dataset contains message trees
|
138 |
-
multiple child messages as replies
|
139 |
|
140 |
-
All messages have a role property
|
141 |
-
conversation threads from prompt to leaf node
|
142 |
|
143 |
-
This version of the dataset contains data collected on the [open-assistant.io](https://www.open-assistant.io/) website until April
|
144 |
|
145 |
### JSON Example: Message
|
146 |
|
147 |
-
For readability the following JSON examples are shown formatted with indentation on multiple lines.
|
148 |
-
Objects are stored without indentation on
|
149 |
|
150 |
```json
|
151 |
{
|
@@ -179,7 +179,7 @@ Objects are stored without indentation on a single lines in the actual jsonl fil
|
|
179 |
|
180 |
### JSON Example: Conversation Tree
|
181 |
|
182 |
-
For readability only a subset of the message properties is shown here.
|
183 |
|
184 |
```json
|
185 |
{
|
@@ -236,7 +236,7 @@ details about the data structure and Python code to read and write jsonl files c
|
|
236 |
## Main Dataset Files
|
237 |
|
238 |
Conversation data is provided either as nested messages in trees (extension `.trees.jsonl.gz`)
|
239 |
-
or as flat list (table) of messages (extension `.messages.jsonl.gz`).
|
240 |
|
241 |
### Ready For Export Trees
|
242 |
|
@@ -245,7 +245,7 @@ or as flat list (table) of messages (extension `.messages.jsonl.gz`).
|
|
245 |
2023-04-12_oasst_ready.messages.jsonl.gz 88,838 messages
|
246 |
```
|
247 |
Trees in `ready_for_export` state without spam and deleted messages including message labels.
|
248 |
-
The oasst_ready-trees file is
|
249 |
|
250 |
|
251 |
### All Trees
|
@@ -254,7 +254,7 @@ The oasst_ready-trees file is normally sufficient for supervised fine-tuning (SF
|
|
254 |
2023-04-12_oasst_all.trees.jsonl.gz 66,497 trees with 161,443 total messages
|
255 |
2023-04-12_oasst_all.messages.jsonl.gz 161,443 messages
|
256 |
```
|
257 |
-
All trees including those in states `prompt_lottery_waiting` (trees that consist of only one message, namely the
|
258 |
`aborted_low_grade` (trees that stopped growing because the messages had low quality), and `halted_by_moderator`.
|
259 |
|
260 |
|
@@ -263,19 +263,19 @@ All trees including those in states `prompt_lottery_waiting` (trees that consist
|
|
263 |
```
|
264 |
2023-04-12_oasst_spam.messages.jsonl.gz
|
265 |
```
|
266 |
-
|
267 |
-
|
268 |
|
269 |
```
|
270 |
2023-04-12_oasst_prompts.messages.jsonl.gz
|
271 |
```
|
272 |
-
|
273 |
|
274 |
### Using the Huggingface Datasets
|
275 |
|
276 |
-
While HF datasets is ideal for tabular datasets it is not a
|
277 |
-
Nevertheless we make all messages which can
|
278 |
-
|
279 |
|
280 |
To load the oasst1 train & validation splits use:
|
281 |
|
@@ -290,8 +290,7 @@ The messages appear in depth-first order of the message trees.
|
|
290 |
|
291 |
Full conversation trees can be reconstructed from the flat messages table by using the `parent_id`
|
292 |
and `message_id` properties to identify the parent-child relationship of messages. The `message_tree_id`
|
293 |
-
and `tree_state` properties (only present in flat messages files) can be used to find all
|
294 |
-
all messages of a message tree or to select trees by their state.
|
295 |
|
296 |
### Languages
|
297 |
|
|
|
134 |
|
135 |
### Dataset Structure
|
136 |
|
137 |
+
This dataset contains message trees. Each message tree has an initial prompt message as the root node,
|
138 |
+
which can have multiple child messages as replies, and these child messages can have multiple replies.
|
139 |
|
140 |
+
All messages have a role property: this can either be "assistant" or "prompter". The roles in
|
141 |
+
conversation threads from prompt to leaf node strictly alternate between "prompter" and "assistant".
|
142 |
|
143 |
+
This version of the dataset contains data collected on the [open-assistant.io](https://www.open-assistant.io/) website until April 12 2023.
|
144 |
|
145 |
### JSON Example: Message
|
146 |
|
147 |
+
For readability, the following JSON examples are shown formatted with indentation on multiple lines.
|
148 |
+
Objects are stored without indentation (on single lines) in the actual jsonl files.
|
149 |
|
150 |
```json
|
151 |
{
|
|
|
179 |
|
180 |
### JSON Example: Conversation Tree
|
181 |
|
182 |
+
For readability, only a subset of the message properties is shown here.
|
183 |
|
184 |
```json
|
185 |
{
|
|
|
236 |
## Main Dataset Files
|
237 |
|
238 |
Conversation data is provided either as nested messages in trees (extension `.trees.jsonl.gz`)
|
239 |
+
or as a flat list (table) of messages (extension `.messages.jsonl.gz`).
|
240 |
|
241 |
### Ready For Export Trees
|
242 |
|
|
|
245 |
2023-04-12_oasst_ready.messages.jsonl.gz 88,838 messages
|
246 |
```
|
247 |
Trees in `ready_for_export` state without spam and deleted messages including message labels.
|
248 |
+
The oasst_ready-trees file usually is sufficient for supervised fine-tuning (SFT) & reward model (RM) training.
|
249 |
|
250 |
|
251 |
### All Trees
|
|
|
254 |
2023-04-12_oasst_all.trees.jsonl.gz 66,497 trees with 161,443 total messages
|
255 |
2023-04-12_oasst_all.messages.jsonl.gz 161,443 messages
|
256 |
```
|
257 |
+
All trees, including those in states `prompt_lottery_waiting` (trees that consist of only one message, namely the initial prompt),
|
258 |
`aborted_low_grade` (trees that stopped growing because the messages had low quality), and `halted_by_moderator`.
|
259 |
|
260 |
|
|
|
263 |
```
|
264 |
2023-04-12_oasst_spam.messages.jsonl.gz
|
265 |
```
|
266 |
+
These are messages which were deleted or have a negative review result (`"review_result": false`).
|
267 |
+
Besides low quality, a frequent reason for message deletion is a wrong language tag.
|
268 |
|
269 |
```
|
270 |
2023-04-12_oasst_prompts.messages.jsonl.gz
|
271 |
```
|
272 |
+
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.
|
273 |
|
274 |
### Using the Huggingface Datasets
|
275 |
|
276 |
+
While HF datasets is ideal for tabular datasets, it is not a natural fit for nested data structures like the OpenAssistant conversation trees.
|
277 |
+
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.
|
278 |
+
These are directly loadable by [Huggingface Datasets](https://pypi.org/project/datasets/).
|
279 |
|
280 |
To load the oasst1 train & validation splits use:
|
281 |
|
|
|
290 |
|
291 |
Full conversation trees can be reconstructed from the flat messages table by using the `parent_id`
|
292 |
and `message_id` properties to identify the parent-child relationship of messages. The `message_tree_id`
|
293 |
+
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.
|
|
|
294 |
|
295 |
### Languages
|
296 |
|