zeio commited on
Commit
6ec885c
1 Parent(s): b777b2f

fix(readme): added title to the dataset instance example

Browse files
Files changed (1) hide show
  1. README.md +2 -1
README.md CHANGED
@@ -102,6 +102,7 @@ Therefore, this dataset entry can be represented in json in the following format
102
 
103
  ```sh
104
  {
 
105
  "topics": [
106
  {
107
  "posts": [
@@ -132,7 +133,7 @@ Therefore, this dataset entry can be represented in json in the following format
132
 
133
  ### Dataset fields
134
 
135
- In `written` configuration the dataset is represented as a list of `Thread` objects, each `Thread` has a single property `topics`, which contains a list of `Topic` objects. Each `Topic` object has a single property `posts`, which points to the list of `Post` objects, making up the `Topic`. Each `Post` object contains a single property `text` which contains text representation of the post (essentially `text` is `html` code without `tags` and explicit links to other posts; there may still be implicit links to other posts in a form of quotes, prefixed with `>` symbol).
136
  In `spoken` configuration the structure is basically the same, but some `Thread` objects have and additional property `speech` with a spoken representation of the thread.
137
 
138
  [archive]: https://2ch.hk/b/arch/
 
102
 
103
  ```sh
104
  {
105
+ "title": "Всем привет. Нужна помощь богов фотошопа, на картинке надо изменить дату на 09/03/2016 и значения тесто на 86.500++",
106
  "topics": [
107
  {
108
  "posts": [
 
133
 
134
  ### Dataset fields
135
 
136
+ In `written` configuration the dataset is represented as a list of `Thread` objects, each `Thread` has a single property `topics`, which contains a list of `Topic` objects. Each `Topic` object has a single property `posts`, which points to the list of `Post` objects, making up the `Topic`. Each `Post` object contains a single property `text` which contains text representation of the post (essentially `text` is `html` code without `tags` and explicit links to other posts; there may still be implicit links to other posts in a form of quotes, prefixed with `>` symbol). As an additional field, each instance has a property `title` which is equivalent to the thread's main post content.
137
  In `spoken` configuration the structure is basically the same, but some `Thread` objects have and additional property `speech` with a spoken representation of the thread.
138
 
139
  [archive]: https://2ch.hk/b/arch/