ShojiMoriya commited on
Commit
611d353
·
verified ·
1 Parent(s): 5f0ff18

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -15
README.md CHANGED
@@ -4,6 +4,12 @@ language:
4
  size_categories:
5
  - 1K<n<10K
6
  ---
 
 
 
 
 
 
7
 
8
  ## 概要
9
  月に1万句以上の投稿がある国内最大級の川柳投稿サイト『川柳投稿まるせん』のクロールデータです。
@@ -12,22 +18,37 @@ https://marusenryu.com/
12
 
13
  YANSのハッカソン内での利用目的で公開しており、その他の用途への使用はお控えください。
14
 
15
- ## 使い方
16
- [datasets](https://github.com/huggingface/datasets)ライブラリをインストールした環境で、以下のようにデータを読み出すことができます。
17
- ```python
18
- import datasets
19
-
20
- dataset = datasets.load_dataset("YANS-official/senryu-marusen", split="train")
21
- print(dataset[0])
22
- ```
23
 
24
  ## データセットの各カラム説明
25
  | カラム名 | 型 | 例 | 概要 |
26
  | --- | --- | --- | --- |
27
- | odai_id | int | 1 | お題の通し番号 |
28
- | image | int | 1 | お題画像のid。本データのお題はテキストのため、全て"none"となっている |
29
- | type | str | text_to_text | 入出力の形式。本データでは全て"text_to_text"となっている |
30
- | odai | str | ギリギリ川柳 | お題の内容。お題は単語あるいは短いフレーズで与えられる |
31
- | text | str | 書初めの最後の一字がSサイズ | 回答の内容 |
32
- | award | str | 優秀賞 | 受賞ランク。"優秀賞"や"入選"の他、お題ごとに特別な賞が設けられている場合がある |
33
- | response_id | int | 1 | 同じお題に対する回答の通し番号 |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  size_categories:
5
  - 1K<n<10K
6
  ---
7
+ ## 読み込み方
8
+ ```python
9
+ from datasets import load_dataset
10
+
11
+ dataset = load_dataset("YANS-official/senryu-marusen", split="train")
12
+ ```
13
 
14
  ## 概要
15
  月に1万句以上の投稿がある国内最大級の川柳投稿サイト『川柳投稿まるせん』のクロールデータです。
 
18
 
19
  YANSのハッカソン内での利用目的で公開しており、その他の用途への使用はお控えください。
20
 
 
 
 
 
 
 
 
 
21
 
22
  ## データセットの各カラム説明
23
  | カラム名 | 型 | 例 | 概要 |
24
  | --- | --- | --- | --- |
25
+ | odai_id | int | 27 | お題のID |
26
+ | image | int | null | 画像のID。本データでは全てnullとなっている |
27
+ | type | str | text_to_text | 入出力の形式。本データでは全て"text_to_text"という文字列が格納されている |
28
+ | odai | str | ギリギリ川柳 | お題の内容。本データでは全て"**川柳"という形式で文字列が格納されている |
29
+ | responses | list | [{}] | お題に対する回答集 |
30
+ | responses.text | str | 書初めの最後の一字がSサイズ | お題に対する回答 |
31
+ | responses.award | str | 優秀賞 | 回答に付けられた賞。"優秀賞"、"入選"の他、各お題特有の賞が付与されていることがある |
32
+ | responses.response_id | int | 1 | お題に対する回答の番号 |
33
+
34
+
35
+ ```json
36
+ {
37
+ "odai_id": 27,
38
+ "image": null,
39
+ "type": "text_to_text",
40
+ "odai": "ギリギリ川柳",
41
+ "responses":[
42
+ {
43
+ "text": "書初めの最後の一字がSサイズ",
44
+ "award": "優秀賞",
45
+ "response_id": 1
46
+ },
47
+ {
48
+ "text": "まだ入る 昔のジーパン 息吸って",
49
+ "award": "入選",
50
+ "response_id": 2
51
+ }
52
+ ]
53
+ }
54
+ ```