kkuramitsu commited on
Commit
1de64b9
1 Parent(s): 14f0f69

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +222 -0
README.md CHANGED
@@ -1,3 +1,225 @@
1
  ---
2
  license: cc-by-sa-4.0
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: cc-by-sa-4.0
3
+ datasets:
4
+ - mc4
5
+ language:
6
+ - ja
7
+ - en
8
+ tags:
9
+ - t5
10
+ - text2text-generation
11
+ - seq2seq
12
  ---
13
+
14
+ # Model Card for Model ID
15
+
16
+ <!-- Provide a quick summary of what the model is/does. -->
17
+
18
+ This is a small T5 (Text-to-Text Transfer Transformer) model pretrained on Japanese and English corpus.
19
+
20
+ This modelcard aims to be a base template for new models.
21
+ It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
22
+
23
+ ## Model Details
24
+
25
+
26
+
27
+
28
+
29
+
30
+ ### Model Description
31
+
32
+ <!-- Provide a longer summary of what this model is. -->
33
+
34
+ - **Developed by:** [More Information Needed]
35
+ - **Shared by [optional]:** [More Information Needed]
36
+ - **Model type:** [More Information Needed]
37
+ - **Language(s) (NLP):** [More Information Needed]
38
+ - **License:** [More Information Needed]
39
+ - **Finetuned from model [optional]:** [More Information Needed]
40
+
41
+ ### Model Sources [optional]
42
+
43
+ <!-- Provide the basic links for the model. -->
44
+
45
+ - **Repository:** [More Information Needed]
46
+ - **Paper [optional]:** [More Information Needed]
47
+ - **Demo [optional]:** [More Information Needed]
48
+
49
+ ## Uses
50
+
51
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
52
+
53
+ ### Direct Use
54
+
55
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
56
+
57
+ [More Information Needed]
58
+
59
+ ### Downstream Use [optional]
60
+
61
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
62
+
63
+ [More Information Needed]
64
+
65
+ ### Out-of-Scope Use
66
+
67
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
68
+
69
+ [More Information Needed]
70
+
71
+ ## Bias, Risks, and Limitations
72
+
73
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
74
+
75
+ [More Information Needed]
76
+
77
+ ### Recommendations
78
+
79
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
80
+
81
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
82
+
83
+ ## How to Get Started with the Model
84
+
85
+ Use the code below to get started with the model.
86
+
87
+ [More Information Needed]
88
+
89
+ ## Training Details
90
+
91
+ * [Wikipedia](https://ja.wikipedia.org)の日本語ダンプデータ (2020年7月6日時点のもの)
92
+ * [OSCAR](https://oscar-corpus.com)の日本語コーパス
93
+ * [CC-100](http://data.statmt.org/cc-100/)の日本語コーパス
94
+
95
+ このモデルは事前学習のみを行なったものであり、特定のタスクに利用するにはファインチューニングする必要があります。
96
+ 本モデルにも、大規模コーパスを用いた言語モデルにつきまとう、学習データの内容の偏りに由来する偏った(倫理的ではなかったり、有害だったり、バイアスがあったりする)出力結果になる問題が潜在的にあります。
97
+ この問題が発生しうることを想定した上で、被害が発生しない用途にのみ利用するよう気をつけてください。
98
+
99
+ SentencePieceトークナイザーの学習には上記Wikipediaの全データを用いました。
100
+
101
+
102
+ ### Training Data
103
+
104
+ <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
105
+
106
+ [More Information Needed]
107
+
108
+ ### Training Procedure
109
+
110
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
111
+
112
+ #### Preprocessing [optional]
113
+
114
+ [More Information Needed]
115
+
116
+
117
+ #### Training Hyperparameters
118
+
119
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
120
+
121
+ #### Speeds, Sizes, Times [optional]
122
+
123
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
124
+
125
+ [More Information Needed]
126
+
127
+ ## Evaluation
128
+
129
+ <!-- This section describes the evaluation protocols and provides the results. -->
130
+
131
+ ### Testing Data, Factors & Metrics
132
+
133
+ #### Testing Data
134
+
135
+ <!-- This should link to a Data Card if possible. -->
136
+
137
+ [More Information Needed]
138
+
139
+ #### Factors
140
+
141
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
142
+
143
+ [More Information Needed]
144
+
145
+ #### Metrics
146
+
147
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
148
+
149
+ [More Information Needed]
150
+
151
+ ### Results
152
+
153
+ [More Information Needed]
154
+
155
+ #### Summary
156
+
157
+
158
+
159
+ ## Model Examination [optional]
160
+
161
+ <!-- Relevant interpretability work for the model goes here -->
162
+
163
+ [More Information Needed]
164
+
165
+ ## Environmental Impact
166
+
167
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
168
+
169
+ Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
170
+
171
+ - **Hardware Type:** [More Information Needed]
172
+ - **Hours used:** [More Information Needed]
173
+ - **Cloud Provider:** [More Information Needed]
174
+ - **Compute Region:** [More Information Needed]
175
+ - **Carbon Emitted:** [More Information Needed]
176
+
177
+ ## Technical Specifications [optional]
178
+
179
+ ### Model Architecture and Objective
180
+
181
+ [More Information Needed]
182
+
183
+ ### Compute Infrastructure
184
+
185
+ [More Information Needed]
186
+
187
+ #### Hardware
188
+
189
+ [More Information Needed]
190
+
191
+ #### Software
192
+
193
+ [More Information Needed]
194
+
195
+ ## Citation [optional]
196
+
197
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
198
+
199
+ **BibTeX:**
200
+
201
+ [More Information Needed]
202
+
203
+ **APA:**
204
+
205
+ [More Information Needed]
206
+
207
+ ## Glossary [optional]
208
+
209
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
210
+
211
+ [More Information Needed]
212
+
213
+ ## More Information [optional]
214
+
215
+ [More Information Needed]
216
+
217
+ ## Model Card Authors [optional]
218
+
219
+ [More Information Needed]
220
+
221
+ ## Model Card Contact
222
+
223
+ [More Information Needed]
224
+
225
+