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

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -10
README.md CHANGED
@@ -132,29 +132,35 @@ of a worldwide crowd-sourcing effort involving over 13,500 volunteers.
132
  ### Dataset Structure
133
 
134
  This dataset contains demonstrations of human-assistant conversations which were collected
135
- on the open-assistant.io website until April, 12 2023.
136
 
137
- Conversations are exported as message trees which contain conversation messages as nodes.
138
- The root node of a message tree is called the initial prompt. Each message node can have
139
  multiple replies. Nodes with more than one reply can have a `rank` field indicating the
140
- order among the siblings sorted by user preference (the most preferred message has rank 0).
 
141
  All messages have a role which can either be "assistant" or "prompter". The roles in
142
- conversation threads from prompt to leaf node in a message tree are stricly alternating
143
  between "assistant" and "prompter".
144
 
145
  ## Main Dataset Files
146
 
147
- Data is provided either as nested as a message tree or as flat list (table) of messages.
148
- Names of files containing message trees end in `.trees.jsonl.gz` while files containing
149
- a list of messages with a file name ending in `.messages.jsonl.gz`.
 
 
 
150
 
151
- Mesages
152
 
153
  ```
154
  2023-04-12_oasst_ready.trees.jsonl.gz 10364 trees with 88838 total messages
155
  2023-04-12_oasst_ready.messages.jsonl.gz 88838 messages
156
  ```
157
 
 
 
158
 
159
  ```
160
  2023-04-12_oasst_all.trees.jsonl.gz 66497 trees with 161443 total messages
@@ -162,7 +168,6 @@ Mesages
162
  ```
163
 
164
 
165
-
166
  ### Languages
167
 
168
  OpenAssistant Conversations incorporates 35 different languages with a distribution of messages as follows:
 
132
  ### Dataset Structure
133
 
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).
141
+
142
  All messages have a role which can either be "assistant" or "prompter". The roles in
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.
149
+
150
+ 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
  ```
166
  2023-04-12_oasst_all.trees.jsonl.gz 66497 trees with 161443 total messages
 
168
  ```
169
 
170
 
 
171
  ### Languages
172
 
173
  OpenAssistant Conversations incorporates 35 different languages with a distribution of messages as follows: