andreaskoepf commited on
Commit
670f5bc
1 Parent(s): 12c7304

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -3
README.md CHANGED
@@ -134,7 +134,7 @@ of a worldwide crowd-sourcing effort involving over 13,500 volunteers.
134
  This dataset contains demonstrations of human-assistant conversations which were collected
135
  on the [open-assistant.io](https://www.open-assistant.io/) website until April, 12 2023.
136
 
137
- Conversations are exported as conversation trees which contain conversation messages as nodes.
138
  The root node of a conversation tree is called the initial prompt. Each message can have
139
  multiple replies. Nodes with more than one reply can have a `rank` field indicating the
140
  user preference (the most preferred message has rank 0).
@@ -143,6 +143,11 @@ All messages have a role which can either be "assistant" or "prompter". The role
143
  conversation threads from prompt to leaf node in a conversation tree are stricly alternating
144
  between "assistant" and "prompter".
145
 
 
 
 
 
 
146
  ## Main Dataset Files
147
 
148
  Data is provided either as nested messages in conversation trees or as flat list of messages.
@@ -151,15 +156,22 @@ The type of file can be inferred from the file name extension:
151
  - `.trees.jsonl.gz`: Conversation trees with nested messages
152
  - `.messages.jsonl.gz`: Flat list of messages
153
 
 
 
 
 
154
 
155
- ### Ready for export trees
 
 
 
156
 
157
  ```
158
  2023-04-12_oasst_ready.trees.jsonl.gz 10364 trees with 88838 total messages
159
  2023-04-12_oasst_ready.messages.jsonl.gz 88838 messages
160
  ```
161
 
162
- ### All trees
163
 
164
 
165
  ```
@@ -167,6 +179,12 @@ The type of file can be inferred from the file name extension:
167
  2023-04-12_oasst_all.messages.jsonl.gz 161443 messages
168
  ```
169
 
 
 
 
 
 
 
170
 
171
  ### Languages
172
 
 
134
  This dataset contains demonstrations of human-assistant conversations which were collected
135
  on the [open-assistant.io](https://www.open-assistant.io/) website until April, 12 2023.
136
 
137
+ Conversations are exported as conversation trees with messages as nodes.
138
  The root node of a conversation tree is called the initial prompt. Each message can have
139
  multiple replies. Nodes with more than one reply can have a `rank` field indicating the
140
  user preference (the most preferred message has rank 0).
 
143
  conversation threads from prompt to leaf node in a conversation tree are stricly alternating
144
  between "assistant" and "prompter".
145
 
146
+ Please refer to [oasst-data](https://github.com/LAION-AI/Open-Assistant/tree/main/oasst-data) for
147
+ details about the data structure and python code to load and write conversation tree and message
148
+ jsonl files.
149
+
150
+
151
  ## Main Dataset Files
152
 
153
  Data is provided either as nested messages in conversation trees or as flat list of messages.
 
156
  - `.trees.jsonl.gz`: Conversation trees with nested messages
157
  - `.messages.jsonl.gz`: Flat list of messages
158
 
159
+ Full conversation trees can be reconstructed from a flat messages using the `parent_id`
160
+ and `message_id` properties to identify the parent-child relationship of messages. To
161
+ select all messages of a single conversation tree `message_tree_id` can be used (only present
162
+ in flat messages files).
163
 
164
+ ### Ready For Export Trees
165
+
166
+ This set of exported trees contains all trees in `ready_for_export` state without spam
167
+ and deleted messages. For supervised fine-tuning & reward model training this file is ideal.
168
 
169
  ```
170
  2023-04-12_oasst_ready.trees.jsonl.gz 10364 trees with 88838 total messages
171
  2023-04-12_oasst_ready.messages.jsonl.gz 88838 messages
172
  ```
173
 
174
+ ### All Trees
175
 
176
 
177
  ```
 
179
  2023-04-12_oasst_all.messages.jsonl.gz 161443 messages
180
  ```
181
 
182
+ ### Supplemental Exports: Spam & Prompts
183
+
184
+ ```
185
+
186
+ ```
187
+
188
 
189
  ### Languages
190