Update README.md

README.md

@@ -18,9 +18,31 @@ widget:
 ---
 # TeenyTinyLlama-162m-IMDB
 
-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 a translated version of the [IMDB dataset](https://huggingface.co/datasets/christykoh/imdb_pt).
+This repository contains a version of [TeenyTinyLlama-162m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-162m) (`TeenyTinyLlama-162m-IMDB`) fine-tuned on the the [IMDB dataset](https://huggingface.co/datasets/christykoh/imdb_pt).
+
+## 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 = "Esqueceram de mim 2 é um dos melhores filmes de natal de todos os tempos."
+
+classifier = pipeline("text-classification", model="nicholasKluge/TeenyTinyLlama-162m-IMDB")
+classifier(text)
+
+# >>> [{'label': 'POSITIVE', 'score': 0.9971244931221008}]
+```
 
 ## Reproducing
   
@@ -96,10 +118,34 @@ trainer = Trainer(
 trainer.train()
 ```
 
-## Results
+## Fine-Tuning Comparisons
 
 | Models                                                                                     | [IMDB](https://huggingface.co/datasets/christykoh/imdb_pt) | 
 |--------------------------------------------------------------------------------------------|------------------------------------------------------------|
 | [Teeny Tiny Llama 162m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-162m)          | 91.14                                                      |
 | [Bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) | 92.22                                                      |
 | [Gpt2-small-portuguese](https://huggingface.co/pierreguillou/gpt2-small-portuguese)        | 91.60                                                      |
+
+## 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-IMDB is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.