p1atdev commited on
Commit
95fba86
1 Parent(s): e80201f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +192 -0
README.md CHANGED
@@ -1,3 +1,195 @@
1
  ---
2
  license: mit
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ language:
4
+ - ja
5
+ size_categories:
6
+ - 10K<n<100K
7
  ---
8
+
9
+ # Dataset Card for Modern Haiku Dataset
10
+
11
+ ### Dataset Summary
12
+
13
+ Modern Haiku Dataset is a haiku (俳句) dataset that collected from [modern haiku association](https://gendaihaiku.gr.jp/)'s databse ([link](https://haiku-data.jp/index.php)).
14
+
15
+ ## Dataset Structure
16
+
17
+ ### Data Instances
18
+
19
+ #### all
20
+
21
+ ```py
22
+ from datasets import load_dataset, DatasetDict
23
+
24
+ dataset = load_dataset(
25
+ "p1atdev/modern_haiku",
26
+ )
27
+
28
+ if not isinstance(dataset, DatasetDict):
29
+ raise TypeError("dataset is not DatasetDict")
30
+
31
+ print(dataset)
32
+ # DatasetDict({
33
+ # train: Dataset({
34
+ # features: ['id', 'haiku', 'author', 'foreword', 'source', 'comment', 'reviewer', 'note', 'season', 'kigo'],
35
+ # num_rows: 37158
36
+ # })
37
+ # })
38
+ ```
39
+
40
+ An example of the dataset looks as follows:
41
+
42
+ ```json
43
+ {
44
+ "id":1,
45
+ "haiku":"朝霧の中に九段のともし哉",
46
+ "author":"正岡子規",
47
+ "foreword":null,
48
+ "source":"寒山落木",
49
+ "comment":null,
50
+ "reviewer":null,
51
+ "note":null,
52
+ "season":"autumn",
53
+ "kigo":{
54
+ "id":1418,
55
+ "word":"霧",
56
+ "kana":"きり",
57
+ "old_kana":null,
58
+ "season":"autumn",
59
+ "subtitle":[
60
+ "朝霧",
61
+ "夕霧",
62
+ ...
63
+ ]
64
+ }
65
+ }
66
+ ```
67
+
68
+ #### spring, summer, autumn, winter
69
+
70
+ These subsets are narrowed down to those that contain the seasonal words for each season.
71
+
72
+ The "none" subset contains haiku that do not contain seasonal words.
73
+
74
+ An example of "winter" subset looks as follows:
75
+
76
+ ```json
77
+ {
78
+ "id":528,
79
+ "haiku":"磯鷲はかならず巌にとまりけり",
80
+ "author":"原石鼎",
81
+ "foreword":null,
82
+ "source":"花影",
83
+ "comment":null,
84
+ "reviewer":null,
85
+ "note":null,
86
+ "kigo":{
87
+ "id":2265,
88
+ "word":"鷲",
89
+ "kana":"わし",
90
+ "old_kana":null,
91
+ "season":"winter",
92
+ "subtitle":[]
93
+ }
94
+ }
95
+ ```
96
+
97
+ #### kigo
98
+
99
+ This subset is a dataset of seasonal words that are used in at least one haiku.
100
+
101
+ An example of the subset looks as follows:
102
+
103
+ ```json
104
+ {
105
+ "id":1628,
106
+ "word":"法師蟬",
107
+ "kana":"ほうしぜみ",
108
+ "old_kana":"ほふしぜみ",
109
+ "season":"autumn",
110
+ "subtitle":[
111
+ "つくつく法師",
112
+ "つくつくし",
113
+ "寒蟬"
114
+ ]
115
+ }
116
+ ```
117
+
118
+ ### Data Fields
119
+
120
+ - `id`: ID number of the haiku.
121
+ - `haiku`: Text of the haiku.
122
+ - `author`: Name of the author of the haiku.
123
+ - `foreword`: Unknown. Nullable.
124
+ - `source`: Name of the source document of the haiku. Nullable.
125
+ - `comment`: Comment about the haiku by `reviewer`. Nullable.
126
+ - `reviewer`: Name of the reviewer who made the comment. Nullable.
127
+ - `note`: Note about the haiku. Nullable.
128
+ - `season`: The season of the haiku. If the haiku has no seasonal word, this will be `none'.
129
+ - `kigo`: The seasonal word, when the haiku has.
130
+ - `id`: ID number of the word.
131
+ - `word`: The seasonal word.
132
+ - `kana`: Pronunciation of the word.
133
+ - `old_kana`: Pronunciation of the word in old hiragana version. Nullable.
134
+ - `season`: The season of the word.
135
+ - `subtitle`: Other name of the word.
136
+
137
+ ## Dataset Creation
138
+
139
+ ### Source Data
140
+
141
+ #### Initial Data Collection and Normalization
142
+
143
+ By [Modern Haiku Association](https://gendaihaiku.gr.jp/).
144
+
145
+ #### Who are the source language producers?
146
+
147
+ [More Information Needed]
148
+
149
+ ### Annotations
150
+
151
+ #### Annotation process
152
+
153
+ [More Information Needed]
154
+
155
+ #### Who are the annotators?
156
+
157
+ [More Information Needed]
158
+
159
+ ### Personal and Sensitive Information
160
+
161
+ [More Information Needed]
162
+
163
+ ## Considerations for Using the Data
164
+
165
+ ### Social Impact of Dataset
166
+
167
+ [More Information Needed]
168
+
169
+ ### Discussion of Biases
170
+
171
+ [More Information Needed]
172
+
173
+ ### Other Known Limitations
174
+
175
+ [More Information Needed]
176
+
177
+ ## Additional Information
178
+
179
+ [俳句データベース解説](https://haiku-data.jp/data.php)
180
+
181
+ ### Dataset Curators
182
+
183
+ [More Information Needed]
184
+
185
+ ### Licensing Information
186
+
187
+ [More Information Needed]
188
+
189
+ ### Citation Information
190
+
191
+ [More Information Needed]
192
+
193
+ ### Contributions
194
+
195
+ [More Information Needed]