EatingKing commited on
Commit
fdec77b
·
1 Parent(s): 7adcef2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -245
README.md CHANGED
@@ -1,247 +1,11 @@
1
- ---
2
- language: en
3
- tags:
4
- - exbert
5
- license: apache-2.0
6
- datasets:
7
- - bookcorpus
8
- - wikipedia
9
- ---
10
 
11
- # BERT base model (uncased)
 
 
 
 
12
 
13
- Pretrained model on English language using a masked language modeling (MLM) objective. It was introduced in
14
- [this paper](https://arxiv.org/abs/1810.04805) and first released in
15
- [this repository](https://github.com/google-research/bert). This model is uncased: it does not make a difference
16
- between english and English.
17
-
18
- Disclaimer: The team releasing BERT did not write a model card for this model so this model card has been written by
19
- the Hugging Face team.
20
-
21
- ## Model description
22
-
23
- BERT is a transformers model pretrained on a large corpus of English data in a self-supervised fashion. This means it
24
- was pretrained on the raw texts only, with no humans labeling them in any way (which is why it can use lots of
25
- publicly available data) with an automatic process to generate inputs and labels from those texts. More precisely, it
26
- was pretrained with two objectives:
27
-
28
- - Masked language modeling (MLM): taking a sentence, the model randomly masks 15% of the words in the input then run
29
- the entire masked sentence through the model and has to predict the masked words. This is different from traditional
30
- recurrent neural networks (RNNs) that usually see the words one after the other, or from autoregressive models like
31
- GPT which internally masks the future tokens. It allows the model to learn a bidirectional representation of the
32
- sentence.
33
- - Next sentence prediction (NSP): the models concatenates two masked sentences as inputs during pretraining. Sometimes
34
- they correspond to sentences that were next to each other in the original text, sometimes not. The model then has to
35
- predict if the two sentences were following each other or not.
36
-
37
- This way, the model learns an inner representation of the English language that can then be used to extract features
38
- useful for downstream tasks: if you have a dataset of labeled sentences, for instance, you can train a standard
39
- classifier using the features produced by the BERT model as inputs.
40
-
41
- ## Model variations
42
-
43
- BERT has originally been released in base and large variations, for cased and uncased input text. The uncased models also strips out an accent markers.
44
- Chinese and multilingual uncased and cased versions followed shortly after.
45
- Modified preprocessing with whole word masking has replaced subpiece masking in a following work, with the release of two models.
46
- Other 24 smaller models are released afterward.
47
-
48
- The detailed release history can be found on the [google-research/bert readme](https://github.com/google-research/bert/blob/master/README.md) on github.
49
-
50
- | Model | #params | Language |
51
- |------------------------|--------------------------------|-------|
52
- | [`bert-base-uncased`](https://huggingface.co/bert-base-uncased) | 110M | English |
53
- | [`bert-large-uncased`](https://huggingface.co/bert-large-uncased) | 340M | English | sub
54
- | [`bert-base-cased`](https://huggingface.co/bert-base-cased) | 110M | English |
55
- | [`bert-large-cased`](https://huggingface.co/bert-large-cased) | 340M | English |
56
- | [`bert-base-chinese`](https://huggingface.co/bert-base-chinese) | 110M | Chinese |
57
- | [`bert-base-multilingual-cased`](https://huggingface.co/bert-base-multilingual-cased) | 110M | Multiple |
58
- | [`bert-large-uncased-whole-word-masking`](https://huggingface.co/bert-large-uncased-whole-word-masking) | 340M | English |
59
- | [`bert-large-cased-whole-word-masking`](https://huggingface.co/bert-large-cased-whole-word-masking) | 340M | English |
60
-
61
- ## Intended uses & limitations
62
-
63
- You can use the raw model for either masked language modeling or next sentence prediction, but it's mostly intended to
64
- be fine-tuned on a downstream task. See the [model hub](https://huggingface.co/models?filter=bert) to look for
65
- fine-tuned versions of a task that interests you.
66
-
67
- Note that this model is primarily aimed at being fine-tuned on tasks that use the whole sentence (potentially masked)
68
- to make decisions, such as sequence classification, token classification or question answering. For tasks such as text
69
- generation you should look at model like GPT2.
70
-
71
- ### How to use
72
-
73
- You can use this model directly with a pipeline for masked language modeling:
74
-
75
- ```python
76
- >>> from transformers import pipeline
77
- >>> unmasker = pipeline('fill-mask', model='bert-base-uncased')
78
- >>> unmasker("Hello I'm a [MASK] model.")
79
- [{'sequence': "[CLS] hello i'm a fashion model. [SEP]",
80
- 'score': 0.1073106899857521,
81
- 'token': 4827,
82
- 'token_str': 'fashion'},
83
- {'sequence': "[CLS] hello i'm a role model. [SEP]",
84
- 'score': 0.08774490654468536,
85
- 'token': 2535,
86
- 'token_str': 'role'},
87
- {'sequence': "[CLS] hello i'm a new model. [SEP]",
88
- 'score': 0.05338378623127937,
89
- 'token': 2047,
90
- 'token_str': 'new'},
91
- {'sequence': "[CLS] hello i'm a super model. [SEP]",
92
- 'score': 0.04667217284440994,
93
- 'token': 3565,
94
- 'token_str': 'super'},
95
- {'sequence': "[CLS] hello i'm a fine model. [SEP]",
96
- 'score': 0.027095865458250046,
97
- 'token': 2986,
98
- 'token_str': 'fine'}]
99
- ```
100
-
101
- Here is how to use this model to get the features of a given text in PyTorch:
102
-
103
- ```python
104
- from transformers import BertTokenizer, BertModel
105
- tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
106
- model = BertModel.from_pretrained("bert-base-uncased")
107
- text = "Replace me by any text you'd like."
108
- encoded_input = tokenizer(text, return_tensors='pt')
109
- output = model(**encoded_input)
110
- ```
111
-
112
- and in TensorFlow:
113
-
114
- ```python
115
- from transformers import BertTokenizer, TFBertModel
116
- tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
117
- model = TFBertModel.from_pretrained("bert-base-uncased")
118
- text = "Replace me by any text you'd like."
119
- encoded_input = tokenizer(text, return_tensors='tf')
120
- output = model(encoded_input)
121
- ```
122
-
123
- ### Limitations and bias
124
-
125
- Even if the training data used for this model could be characterized as fairly neutral, this model can have biased
126
- predictions:
127
-
128
- ```python
129
- >>> from transformers import pipeline
130
- >>> unmasker = pipeline('fill-mask', model='bert-base-uncased')
131
- >>> unmasker("The man worked as a [MASK].")
132
- [{'sequence': '[CLS] the man worked as a carpenter. [SEP]',
133
- 'score': 0.09747550636529922,
134
- 'token': 10533,
135
- 'token_str': 'carpenter'},
136
- {'sequence': '[CLS] the man worked as a waiter. [SEP]',
137
- 'score': 0.0523831807076931,
138
- 'token': 15610,
139
- 'token_str': 'waiter'},
140
- {'sequence': '[CLS] the man worked as a barber. [SEP]',
141
- 'score': 0.04962705448269844,
142
- 'token': 13362,
143
- 'token_str': 'barber'},
144
- {'sequence': '[CLS] the man worked as a mechanic. [SEP]',
145
- 'score': 0.03788609802722931,
146
- 'token': 15893,
147
- 'token_str': 'mechanic'},
148
- {'sequence': '[CLS] the man worked as a salesman. [SEP]',
149
- 'score': 0.037680890411138535,
150
- 'token': 18968,
151
- 'token_str': 'salesman'}]
152
- >>> unmasker("The woman worked as a [MASK].")
153
- [{'sequence': '[CLS] the woman worked as a nurse. [SEP]',
154
- 'score': 0.21981462836265564,
155
- 'token': 6821,
156
- 'token_str': 'nurse'},
157
- {'sequence': '[CLS] the woman worked as a waitress. [SEP]',
158
- 'score': 0.1597415804862976,
159
- 'token': 13877,
160
- 'token_str': 'waitress'},
161
- {'sequence': '[CLS] the woman worked as a maid. [SEP]',
162
- 'score': 0.1154729500412941,
163
- 'token': 10850,
164
- 'token_str': 'maid'},
165
- {'sequence': '[CLS] the woman worked as a prostitute. [SEP]',
166
- 'score': 0.037968918681144714,
167
- 'token': 19215,
168
- 'token_str': 'prostitute'},
169
- {'sequence': '[CLS] the woman worked as a cook. [SEP]',
170
- 'score': 0.03042375110089779,
171
- 'token': 5660,
172
- 'token_str': 'cook'}]
173
- ```
174
-
175
- This bias will also affect all fine-tuned versions of this model.
176
-
177
- ## Training data
178
-
179
- The BERT model was pretrained on [BookCorpus](https://yknzhu.wixsite.com/mbweb), a dataset consisting of 11,038
180
- unpublished books and [English Wikipedia](https://en.wikipedia.org/wiki/English_Wikipedia) (excluding lists, tables and
181
- headers).
182
-
183
- ## Training procedure
184
-
185
- ### Preprocessing
186
-
187
- The texts are lowercased and tokenized using WordPiece and a vocabulary size of 30,000. The inputs of the model are
188
- then of the form:
189
-
190
- ```
191
- [CLS] Sentence A [SEP] Sentence B [SEP]
192
- ```
193
-
194
- With probability 0.5, sentence A and sentence B correspond to two consecutive sentences in the original corpus, and in
195
- the other cases, it's another random sentence in the corpus. Note that what is considered a sentence here is a
196
- consecutive span of text usually longer than a single sentence. The only constrain is that the result with the two
197
- "sentences" has a combined length of less than 512 tokens.
198
-
199
- The details of the masking procedure for each sentence are the following:
200
- - 15% of the tokens are masked.
201
- - In 80% of the cases, the masked tokens are replaced by `[MASK]`.
202
- - In 10% of the cases, the masked tokens are replaced by a random token (different) from the one they replace.
203
- - In the 10% remaining cases, the masked tokens are left as is.
204
-
205
- ### Pretraining
206
-
207
- The model was trained on 4 cloud TPUs in Pod configuration (16 TPU chips total) for one million steps with a batch size
208
- of 256. The sequence length was limited to 128 tokens for 90% of the steps and 512 for the remaining 10%. The optimizer
209
- used is Adam with a learning rate of 1e-4, \\(\beta_{1} = 0.9\\) and \\(\beta_{2} = 0.999\\), a weight decay of 0.01,
210
- learning rate warmup for 10,000 steps and linear decay of the learning rate after.
211
-
212
- ## Evaluation results
213
-
214
- When fine-tuned on downstream tasks, this model achieves the following results:
215
-
216
- Glue test results:
217
-
218
- | Task | MNLI-(m/mm) | QQP | QNLI | SST-2 | CoLA | STS-B | MRPC | RTE | Average |
219
- |:----:|:-----------:|:----:|:----:|:-----:|:----:|:-----:|:----:|:----:|:-------:|
220
- | | 84.6/83.4 | 71.2 | 90.5 | 93.5 | 52.1 | 85.8 | 88.9 | 66.4 | 79.6 |
221
-
222
-
223
- ### BibTeX entry and citation info
224
-
225
- ```bibtex
226
- @article{DBLP:journals/corr/abs-1810-04805,
227
- author = {Jacob Devlin and
228
- Ming{-}Wei Chang and
229
- Kenton Lee and
230
- Kristina Toutanova},
231
- title = {{BERT:} Pre-training of Deep Bidirectional Transformers for Language
232
- Understanding},
233
- journal = {CoRR},
234
- volume = {abs/1810.04805},
235
- year = {2018},
236
- url = {http://arxiv.org/abs/1810.04805},
237
- archivePrefix = {arXiv},
238
- eprint = {1810.04805},
239
- timestamp = {Tue, 30 Oct 2018 20:39:56 +0100},
240
- biburl = {https://dblp.org/rec/journals/corr/abs-1810-04805.bib},
241
- bibsource = {dblp computer science bibliography, https://dblp.org}
242
- }
243
- ```
244
-
245
- <a href="https://huggingface.co/exbert/?model=bert-base-uncased">
246
- <img width="300px" src="https://cdn-media.huggingface.co/exbert/button.png">
247
- </a>
 
 
 
 
 
 
 
 
 
 
1
 
2
+ - 👋 Hi, I’m @EatingKing001
3
+ - 👀 I’m interested in ...
4
+ - 🌱 I’m currently learning ...
5
+ - 💞️ I’m looking to collaborate on ...
6
+ - 📫 How to reach me ...
7
 
8
+ <!---
9
+ EatingKing001/EatingKing001 is a ✨ special ✨ repository because its `README.md` (this file) appears on your GitHub profile.
10
+ You can click the Preview link to take a look at your changes.
11
+ --->