Update README.md

README.md

@@ -1,3 +1,175 @@
 ---
+language: pt
+tags: 
+  - deberta
+  - deberta-v3
+  - pt
+  - pt-br
+datasets:
+  - allenai/c4
+library_name: transformers
 license: mit
 ---
+
+# DeBERTina
+
+<p align="center">
+  <img src="https://huggingface.co/tgsc/debertina-base/resolve/main/DeBERTina.png" alt="DeBERTina"/>
+</p>
+
+DeBERTina é um modelo [DeBERTa-v3](https://arxiv.org/abs/2111.09543) em português treinado no estilo [ELECTRA](https://arxiv.org/abs/2003.10555), com RTD (Replaced Token Detection) e *gradient-disentangled embedding sharing* (GDES).
+
+*DeBERTina is a portuguese [DeBERTa-v3](https://arxiv.org/abs/2111.09543) model trained electra-style [ELECTRA](https://arxiv.org/abs/2003.10555) (with Replaced Token Detection - RTD) and gradient-disentangled embedding sharing (GDES).*
+
+| Model                                    | type | Vocabulary | Backbone + Embeddings = Total Parameters   |
+|                 :-:                      | :-: | :-: |   :-:   |
+| [ult5-pt-small](https://huggingface.co/tgsc/ult5-pt-small) | encoder-decoder | 65k | 56.6M + 25.8M = 82.4M |
+| [sentence-transformer-ult5-pt-small](https://huggingface.co/tgsc/sentence-transformer-ult5-pt-small)  | sentence-transformer | 65k | 25.2 + 25.8M = 51M |
+| [DeBERTina-base](https://huggingface.co/tgsc/debertina-base) | encoder | 32k | 85.5M + 24.6M = 110.0M |
+| [DeBERTina-base-128k-vocab](https://huggingface.co/tgsc/debertina-base-128k-vocab) | encoder | 128k | 85.5M + 98.3M = 183.8M |
+| [DeBERTina-xsmall](https://huggingface.co/tgsc/debertina-xsmall) | encoder | 128k | 21.5M + 49.2M = 70.6M |
+
+- **Developed by:** Thacio Garcia Scandaroli
+- **Model type:** DeBERTa-v3
+- **Language(s) (NLP):** Português
+- **License:** MIT
+
+
+Benchmarks e tutorial de fine-tune: [https://github.com/thacio/LLM-Notebooks](https://github.com/thacio/LLM-Notebooks)
+
+*Benchmarks e fine-tune notebook*: [https://github.com/thacio/LLM-Notebooks](https://github.com/thacio/LLM-Notebooks)
+
+Special tokens:
+'[PAD]', '[CLS]', '[SEP]', '[UNK]'
+
+## Treino
+
+O modelo foi treinado com o corpus C4 em português, utilizando um tokenizer sentencepiece com vocabulário de tamanho 128k.
+
+O treino consiste em um gerador e um discriminador. O gerador é treinado com *masked language modeling* em 15% dos tokens. Em seguida, tokens são substituídos pelas 
+predições do gerador, e o discriminador é treinado de forma a identificar quais tokens são originais e quais foram substítudos.
+
+*The model was trained with the C4 corpus in portuguese with a sentencepiece tokenizer with a vocabulary of 128.*
+
+*The training is done with a generator and a discriminator. The generator is trained with maskeed language modeling as BERT, but without next sentence prediction, by masking 15% of the tokens.*
+
+*The masked tokens are then replaced by the generators prediction, and the discriminator is trained with the objective of identifying the which are the original and replaced tokens.*
+
+
+## Fine-tunning
+
+O fine-tunning é feito com o discriminador.
+
+Para carregar o modelo para classificações:
+
+*Fine-tunning should be done with the discrimnator.*
+
+*Loading the model for classification:*
+
+```python
+from transformers import AutoModelForSequenceClassification
+
+num_labels = 2 # number of labels in classes
+model = AutoModelForSequenceClassification.from_pretrained("tgsc/debertina-base",num_labels=num_labels)
+```
+
+## Citation
+
+``` latex
+@inproceedings{
+2023debertina,
+title={DeBERTina: A portuguese DeBERTa-v3 model.},
+author = {Thacio Garcia Scandaroli},
+year={2023},
+url={https://huggingface.co/tgsc/debertina-base}
+}
+```
+
+---
+
+## DeBERTaV3: Improving DeBERTa using ELECTRA-Style Pre-Training with Gradient-Disentangled Embedding Sharing
+
+[DeBERTa](https://arxiv.org/abs/2006.03654) improves the BERT and RoBERTa models using disentangled attention and enhanced mask decoder. With those two improvements, DeBERTa out perform RoBERTa on a majority of NLU tasks with 80GB training data. 
+
+In [DeBERTa V3](https://arxiv.org/abs/2111.09543), we further improved the efficiency of DeBERTa using ELECTRA-Style pre-training with Gradient Disentangled Embedding Sharing. Compared to DeBERTa,  our V3 version significantly improves the model performance on downstream tasks.  You can find more technique details about the new model from our [paper](https://arxiv.org/abs/2111.09543).
+
+Please check the [official repository](https://github.com/microsoft/DeBERTa) for more implementation details and updates.
+
+The DeBERTa V3 base model comes with 12 layers and a hidden size of 768. It has only 86M backbone parameters  with a vocabulary containing 128K tokens which introduces 98M parameters in the Embedding layer.  This model was trained using the 160GB data as DeBERTa V2.
+
+
+#### Fine-tuning on NLU tasks
+
+We present the dev results on SQuAD 2.0 and MNLI tasks.
+
+| Model             |Vocabulary(K)|Backbone #Params(M)| SQuAD 2.0(F1/EM) | MNLI-m/mm(ACC)|
+|-------------------|----------|-------------------|-----------|----------|
+| RoBERTa-base      |50     |86                 | 83.7/80.5 | 87.6/-   |
+| XLNet-base        |32     |92                 | -/80.2    | 86.8/-   |
+| ELECTRA-base      |30    |86                  | -/80.5    | 88.8/    |
+| DeBERTa-base      |50     |100                |  86.2/83.1| 88.8/88.5|
+| DeBERTa-v3-base   |128|86                       | **88.4/85.4** | **90.6/90.7**|
+| DeBERTa-v3-base + SiFT |128|86                | -/- | 91.0/-|
+
+We present the dev results on SQuAD 1.1/2.0 and MNLI tasks.
+
+#### Fine-tuning with HF transformers
+
+```bash
+#!/bin/bash
+
+cd transformers/examples/pytorch/text-classification/
+
+pip install datasets
+export TASK_NAME=mnli
+
+output_dir="ds_results"
+
+num_gpus=8
+
+batch_size=8
+
+python -m torch.distributed.launch --nproc_per_node=${num_gpus} \
+  run_glue.py \
+  --model_name_or_path microsoft/deberta-v3-base \
+  --task_name $TASK_NAME \
+  --do_train \
+  --do_eval \
+  --evaluation_strategy steps \
+  --max_seq_length 256 \
+  --warmup_steps 500 \
+  --per_device_train_batch_size ${batch_size} \
+  --learning_rate 2e-5 \
+  --num_train_epochs 3 \
+  --output_dir $output_dir \
+  --overwrite_output_dir \
+  --logging_steps 1000 \
+  --logging_dir $output_dir
+
+```
+
+### Citation
+
+If you find DeBERTa useful for your work, please cite the following papers:
+
+``` latex
+@misc{he2021debertav3,
+      title={DeBERTaV3: Improving DeBERTa using ELECTRA-Style Pre-Training with Gradient-Disentangled Embedding Sharing}, 
+      author={Pengcheng He and Jianfeng Gao and Weizhu Chen},
+      year={2021},
+      eprint={2111.09543},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+
+``` latex
+@inproceedings{
+he2021deberta,
+title={DEBERTA: DECODING-ENHANCED BERT WITH DISENTANGLED ATTENTION},
+author={Pengcheng He and Xiaodong Liu and Jianfeng Gao and Weizhu Chen},
+booktitle={International Conference on Learning Representations},
+year={2021},
+url={https://openreview.net/forum?id=XPZIaotutsD}
+}
+```