Update README.md

README.md

@@ -45,7 +45,6 @@ configs:
   - split: train
     path: livejupiter/train-*
 ---
-
 # おーぷん2ちゃんねる対話コーパス
 
 ## Dataset Details
@@ -64,44 +63,67 @@ configs:
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-TODO
-
-[More Information Needed]
+- `all-corpus`: `livejupiter`, `news4vip`, `newsplus` サブセットを連結したもの
+  - `dialogue`: 対話データ (`list[dict]`)
+    - `speaker`: 話者番号。`1` または `2`。
+    - `content`: 発言内容
+  - `board`: 連結元のサブセット名
+
+- `livejupiter`: オリジナルのデータセットでの `livejupiter.tsv` から変換されたデータ。
+  - `dialogue`: 対話データ (`list[dict]`)
+    - `speaker`: 話者番号。`1` または `2`。
+    - `content`: 発言内容
+- `news4vip`: オリジナルのデータセットでの `news4vip.tsv` から変換されたデータ。
+  - 構造は同上
+- `newsplus`: オリジナルのデータセットでの `newsplus.tsv` から変換されたデータ。
+  - 構造は同上
+ 
+- `ranking`: 応答順位付けタスク用データ (オリジナルデータセットでの `ranking.zip`)
+  - `train` と `test` split があり、それぞれはオリジナルデータセットの `dev.tsv` と `test.tsv` に対応します。
+  - `dialogue`: 対話データ (`list[dict]`)
+    - `speaker`: 話者番号。`1` または `2`。
+    - `content`: 発言内容
+  - `next`: 対話の次に続く正解の応答 (`dict`)
+    - `speaker`: 話者番号。`1` または `2`
+    - `content`: 発言内容
+  - `random`: ランダムに選ばれた応答 9 個 (`list[str]`)
+
+また、`all-corpus`, `livejupiter`, `news4vip`, `newsplus` にはそれぞれ名前に `-cleaned` が付与されたバージョンがあり、これらのサブセットではオリジナルのデータセットで配布されていた NG ワードリストを利用してフィルタリングされたものです。
+
+オリジナルのデータセットでは各発言内の改行は `__BR__` に置換されていますが、このデータセットではすべて `\n` に置き換えられています。
 
 ## Dataset Creation
 
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
 ### Source Data
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+(オリジナルのデータセットの説明より)
+> おーぷん2ちゃんねるの「なんでも実況(ジュピター)」「ニュー速VIP」「ニュース速報+」の3つの掲示板をクロールして作成した対話コーパスです． おーぷん2ちゃんねる開設時から2019年7月20日までのデータを使用して作成しました．
 
 #### Data Collection and Processing
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
+[オリジナルのデータセット](https://github.com/1never/open2ch-dialogue-corpus) を参照。
 
 #### Personal and Sensitive Information
 
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+`-cleaned` ではないサブセットでは、非常に不適切な表現が多いため注意が必要です。
 
-[More Information Needed]
+## Usage
 
-### Recommendations
+```py
+from datasets import load_dataset
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+ds = load_dataset(
+    "p1atdev/open2ch",
+    name="all-corpus",
+)
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+print(ds)
+print(ds["train"][0])
+# DatasetDict({
+#     train: Dataset({
+#         features: ['dialogue', 'board'],
+#         num_rows: 8134707
+#     })
+# })
+# {'dialogue': {'speaker': [1, 2], 'content': ['実況スレをたてる', 'おんｊ民の鑑']}, 'board': 'livejupiter'}
+```