Update README.md

README.md

@@ -11,16 +11,38 @@ pipeline_tag: text-classification
 tags:
 - textual-entailment
 widget:
-- text: "Qual a capital do Brasil?<s>A capital do Brasil é Brasília!</s>"
+- text: "<s>Qual a capital do Brasil?<s>A capital do Brasil é Brasília!</s>"
   example_title: Exemplo
-- text: "Qual a capital do Brasil?<s>Anões são muito mais legais do que elfos!</s>"
+- text: "<s>Qual a capital do Brasil?<s>Anões são muito mais legais do que elfos!</s>"
   example_title: Exemplo
 ---
-# TeenyTinyLlama-162m-FAQUAD
+# TeenyTinyLlama-162m-FaQuAD-NLI
 
-TeenyTinyLlama is a series of small foundational models trained in Portuguese.
+TeenyTinyLlama is a series of small foundational models trained in Brazilian Portuguese.
 
-This repository contains a version of [TeenyTinyLlama-162m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-162m) fine-tuned on the [FaQuAD-NLI dataset](https://huggingface.co/datasets/ruanchaves/faquad-nli).
+This repository contains a version of [TeenyTinyLlama-162m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-162m) (`TeenyTinyLlama-162m-HateBR`) fine-tuned on the [FaQuAD-NLI dataset](https://huggingface.co/datasets/ruanchaves/faquad-nli).
+
+## Details
+
+- **Number of Epochs:** 3
+- **Batch size:** 16
+- **Optimizer:** `torch.optim.AdamW` (learning_rate = 4e-5, epsilon = 1e-8)
+- **GPU:** 1 NVIDIA A100-SXM4-40GB
+
+## Usage
+
+Using `transformers.pipeline`:
+
+```python
+from transformers import pipeline
+
+text = "<s>Qual a capital do Brasil?<s>A capital do Brasil é Brasília!</s>"
+
+classifier = pipeline("text-classification", model="nicholasKluge/TeenyTinyLlama-162m-FaQuAD-NLI")
+classifier(text)
+
+# >>> [{'label': 'SUITABLE', 'score': 0.9774010181427002}]
+```
 
 ## Reproducing
 
@@ -115,7 +137,7 @@ trainer.train()
 
 ```
 
-## Results
+## Fine-Tuning Comparisons
 
 | Models                                                                                     | [FaQuAD-NLI](https://huggingface.co/datasets/ruanchaves/faquad-nli) |
 |--------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
@@ -123,3 +145,26 @@ trainer.train()
 | [Bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) | 93.07                                                               |
 | [Gpt2-small-portuguese](https://huggingface.co/pierreguillou/gpt2-small-portuguese)        | 86.46                                                               |
 
+## Cite as 🤗
+
+```latex
+
+@misc{nicholas22llama,
+  doi = {10.5281/zenodo.6989727},
+  url = {https://huggingface.co/nicholasKluge/TeenyTinyLlama-162m},
+  author = {Nicholas Kluge Corrêa},
+  title = {TeenyTinyLlama},
+  year = {2023},
+  publisher = {HuggingFace},
+  journal = {HuggingFace repository},
+}
+
+```
+
+## Funding
+
+This repository was built as part of the RAIES ([Rede de Inteligência Artificial Ética e Segura](https://www.raies.org/)) initiative, a project supported by FAPERGS - ([Fundação de Amparo à Pesquisa do Estado do Rio Grande do Sul](https://fapergs.rs.gov.br/inicial)), Brazil.
+
+## License
+
+The TeenyTinyLlama-162m-FaQuAD-NLI is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.