Create README.md

README.md

@@ -0,0 +1,261 @@
+---
+language: en
+tags:
+- Clsssification
+license: apache-2.0
+datasets:
+- bookcorpus
+- wikipedia
+---
+
+# DRAFT MCTI Text Classification Task (case/uncased)
+
+#< Model Name >
+DISCLAIMER: 
+
+
+
+## According to the abstract,
+• .................................... 
+
+
+## Model description
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam sed nibh non enim finibus malesuada. In vitae 
+metus orci. Vestibulum sodales volutpat lorem, eget consectetur nisi viverra vitae. Sed tincidunt accumsan 
+pellentesque. Curabitur urna massa, dapibus sit amet augue quis, aliquam tristique ipsum. In hac habitasse 
+platea dictumst. Fusce aliquet est id mi porttitor tincidunt. Ut imperdiet rutrum eros, ac mollis ipsum 
+auctor ut. Donec lacinia, orci et dignissim molestie, sem ex mollis urna, et blandit nisi leo sit amet mauris. 
+
+Nullam pretium condimentum imperdiet.
+
+Disclaimer: The team releasing BERT did not write a model card for this model so this model card has been written by
+the Hugging Face team.
+
+## Model description
+
+Nullam congue hendrerit turpis et facilisis. Cras accumsan ante mi, eu hendrerit nulla finibus at. Donec imperdiet, 
+nisi nec pulvinar suscipit, dolor nulla sagittis massa, et vehicula ante felis quis nibh. Lorem ipsum dolor sit amet,
+consectetur adipiscing elit. Maecenas viverra tempus risus non ornare. Donec in vehicula est. Pellentesque vulputate 
+bibendum cursus. Nunc volutpat vitae neque ut bibendum:
+
+- Nullam congue hendrerit turpis et facilisis. Cras accumsan ante mi, eu hendrerit nulla finibus at. Donec imperdiet, 
+ nisi nec pulvinar suscipit, dolor nulla sagittis massa, et vehicula ante felis quis nibh. Lorem ipsum dolor sit amet,
+ consectetur adipiscing elit.
+- Nullam congue hendrerit turpis et facilisis. Cras accumsan ante mi, eu hendrerit nulla finibus at. Donec imperdiet, 
+ nisi nec pulvinar suscipit, dolor nulla sagittis massa, et vehicula ante felis quis nibh. Lorem ipsum dolor sit amet,
+ consectetur adipiscing elit.
+
+Nullam congue hendrerit turpis et facilisis. Cras accumsan ante mi, eu hendrerit nulla finibus at. Donec imperdiet, 
+nisi nec pulvinar suscipit, dolor nulla sagittis massa, et vehicula ante felis quis nibh. Lorem ipsum dolor sit amet,
+consectetur adipiscing elit. Maecenas viverra tempus risus non ornare. Donec in vehicula est. Pellentesque vulputate 
+bibendum cursus. Nunc volutpat vitae neque ut bibendum.
+
+## Model variations
+
+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. 
+Chinese and multilingual uncased and cased versions followed shortly after. 
+Modified preprocessing with whole word masking has replaced subpiece masking in a following work, with the release of two models. 
+Other 24 smaller models are released afterward. 
+
+The detailed release history can be found on the [google-research/bert readme](https://www.google.com) on github.
+
+| Model | #params | Language |
+|------------------------|--------------------------------|-------|
+| [`mcti-base-uncased`]| 110M | English |
+| [`mcti-large-uncased`]| 340M | English | sub 
+| [`mcti-base-cased`]| | 110M | English |
+| [`mcti-large-cased`] | 110M | Chinese |
+| [`-base-multilingual-cased`] | 110M | Multiple |
+
+## Intended uses
+
+You can use the raw model for either masked language modeling or next sentence prediction, but it's mostly intended to
+be fine-tuned on a downstream task. See the [model hub](https://www.google.com) to look for
+fine-tuned versions of a task that interests you.
+
+Note that this model is primarily aimed at being fine-tuned on tasks that use the whole sentence (potentially masked)
+to make decisions, such as sequence classification, token classification or question answering. For tasks such as text
+generation you should look at model like XXX.
+
+### How to use
+
+You can use this model directly with a pipeline for masked language modeling:
+
+```python
+>>> from transformers import pipeline
+>>> unmasker = pipeline('fill-mask', model='bert-base-uncased')
+>>> unmasker("Hello I'm a [MASK] model.")
+
+[{'sequence': "[CLS] hello i'm a fashion model. [SEP]",
+ 'score': 0.1073106899857521,
+ 'token': 4827,
+ 'token_str': 'fashion'},
+ {'sequence': "[CLS] hello i'm a role model. [SEP]",
+ 'score': 0.08774490654468536,
+ 'token': 2535,
+ 'token_str': 'role'},
+ {'sequence': "[CLS] hello i'm a new model. [SEP]",
+ 'score': 0.05338378623127937,
+ 'token': 2047,
+ 'token_str': 'new'},
+ {'sequence': "[CLS] hello i'm a super model. [SEP]",
+ 'score': 0.04667217284440994,
+ 'token': 3565,
+ 'token_str': 'super'},
+ {'sequence': "[CLS] hello i'm a fine model. [SEP]",
+ 'score': 0.027095865458250046,
+ 'token': 2986,
+ 'token_str': 'fine'}]
+```
+
+Here is how to use this model to get the features of a given text in PyTorch:
+
+```python
+from transformers import BertTokenizer, BertModel
+tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
+model = BertModel.from_pretrained("bert-base-uncased")
+text = "Replace me by any text you'd like."
+encoded_input = tokenizer(text, return_tensors='pt')
+output = model(**encoded_input)
+```
+
+and in TensorFlow:
+
+```python
+from transformers import BertTokenizer, TFBertModel
+tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
+model = TFBertModel.from_pretrained("bert-base-uncased")
+text = "Replace me by any text you'd like."
+encoded_input = tokenizer(text, return_tensors='tf')
+output = model(encoded_input)
+```
+
+### Limitations and bias
+
+Even if the training data used for this model could be characterized as fairly neutral, this model can have biased
+predictions:
+
+```python
+>>> from transformers import pipeline
+>>> unmasker = pipeline('fill-mask', model='bert-base-uncased')
+>>> unmasker("The man worked as a [MASK].")
+
+[{'sequence': '[CLS] the man worked as a carpenter. [SEP]',
+ 'score': 0.09747550636529922,
+ 'token': 10533,
+ 'token_str': 'carpenter'},
+ {'sequence': '[CLS] the man worked as a waiter. [SEP]',
+ 'score': 0.0523831807076931,
+ 'token': 15610,
+ 'token_str': 'waiter'},
+ {'sequence': '[CLS] the man worked as a barber. [SEP]',
+ 'score': 0.04962705448269844,
+ 'token': 13362,
+ 'token_str': 'barber'},
+ {'sequence': '[CLS] the man worked as a mechanic. [SEP]',
+ 'score': 0.03788609802722931,
+ 'token': 15893,
+ 'token_str': 'mechanic'},
+ {'sequence': '[CLS] the man worked as a salesman. [SEP]',
+ 'score': 0.037680890411138535,
+ 'token': 18968,
+ 'token_str': 'salesman'}]
+
+>>> unmasker("The woman worked as a [MASK].")
+
+[{'sequence': '[CLS] the woman worked as a nurse. [SEP]',
+ 'score': 0.21981462836265564,
+ 'token': 6821,
+ 'token_str': 'nurse'},
+ {'sequence': '[CLS] the woman worked as a waitress. [SEP]',
+ 'score': 0.1597415804862976,
+ 'token': 13877,
+ 'token_str': 'waitress'},
+ {'sequence': '[CLS] the woman worked as a maid. [SEP]',
+ 'score': 0.1154729500412941,
+ 'token': 10850,
+ 'token_str': 'maid'},
+ {'sequence': '[CLS] the woman worked as a prostitute. [SEP]',
+ 'score': 0.037968918681144714,
+ 'token': 19215,
+ 'token_str': 'prostitute'},
+ {'sequence': '[CLS] the woman worked as a cook. [SEP]',
+ 'score': 0.03042375110089779,
+ 'token': 5660,
+ 'token_str': 'cook'}]
+```
+
+This bias will also affect all fine-tuned versions of this model.
+
+## Training data
+
+The BERT model was pretrained on [BookCorpus](https://yknzhu.wixsite.com/mbweb), a dataset consisting of 11,038
+unpublished books and [English Wikipedia](https://en.wikipedia.org/wiki/English_Wikipedia) (excluding lists, tables and
+headers).
+
+
+## Training procedure
+
+### Preprocessing
+
+The texts are lowercased and tokenized using WordPiece and a vocabulary size of 30,000. The inputs of the model are
+then of the form:
+
+```
+[CLS] Sentence A [SEP] Sentence B [SEP]
+```
+
+With probability 0.5, sentence A and sentence B correspond to two consecutive sentences in the original corpus, and in
+the other cases, it's another random sentence in the corpus. Note that what is considered a sentence here is a
+consecutive span of text usually longer than a single sentence. The only constrain is that the result with the two
+"sentences" has a combined length of less than 512 tokens.
+
+The details of the masking procedure for each sentence are the following:
+- 15% of the tokens are masked.
+- In 80% of the cases, the masked tokens are replaced by `[MASK]`.
+- In 10% of the cases, the masked tokens are replaced by a random token (different) from the one they replace.
+- In the 10% remaining cases, the masked tokens are left as is.
+
+### Pretraining
+
+The model was trained on 4 cloud TPUs in Pod configuration (16 TPU chips total) for one million steps with a batch size
+of 256. The sequence length was limited to 128 tokens for 90% of the steps and 512 for the remaining 10%. The optimizer
+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,
+learning rate warmup for 10,000 steps and linear decay of the learning rate after.
+
+## Evaluation results
+
+When fine-tuned on downstream tasks, this model achieves the following results:
+
+Glue test results:
+
+| Task | MNLI-(m/mm) | QQP | QNLI | SST-2 | CoLA | STS-B | MRPC | RTE | Average |
+|:----:|:-----------:|:----:|:----:|:-----:|:----:|:-----:|:----:|:----:|:-------:|
+| | 84.6/83.4 | 71.2 | 90.5 | 93.5 | 52.1 | 85.8 | 88.9 | 66.4 | 79.6 |
+
+#< Checkpoints >
+#Examples
+#Implementation Notes
+#Usage Example
+#>>> 
+#...
+
+#< Config >
+<# Tokenizer >
+#< Training data >
+#< Training procedure >
+#< Preprocessing >
+#< Pretraining >
+#< Evaluation results >
+#< BibTeX entry and citation info >
+#< Benchmarks >
+### BibTeX entry and citation info
+
+```bibtex
+
+```
+
+<a href="https://huggingface.co/exbert/?model=bert-base-uncased">
+ <img width="300px" src="https://cdn-media.huggingface.co/exbert/button.png">
+</a>