Update README.md

README.md

@@ -1,11 +1,162 @@
 ---
 license: apache-2.0
+datasets:
+- nicholasKluge/portuguese-corpus-v3
 language:
 - pt
+metrics:
+- perplexity
 library_name: transformers
+pipeline_tag: text-generation
+tags:
+- text-generation-inference
+widget:
+- text: "A PUCRS é uma universidade "
+  example_title: Exemplo
+- text: "A muitos anos atrás, em uma galáxia muito distante, vivia uma raça de"
+  example_title: Exemplo
+- text: "Em meio a um escândalo, a frente parlamentar pediu ao Senador Silva para"
+  example_title: Exemplo
+inference:
+  parameters:
+    repetition_penalty: 1.2
+    temperature: 0.2
+    top_k: 20
+    top_p: 0.2
+    max_new_tokens: 150
+co2_eq_emissions:
+  emissions: 41.1
+  source: CodeCarbon
+  training_type: pre-training
+  geographical_location: Germany
+  hardware_used: NVIDIA A100-SXM4-40GB
 ---
+# TeenyTinyLlama-460m
 
-size: 468,239,360
+<img src="./logo.png" alt="A little llama wearing a mushroom hat and a monocle." height="200">
+
+## Model Summary
+
+Given the lack of available monolingual foundational models in non-English languages and the fact that some of the most used and downloaded models by the community are those small enough to allow individual researchers and hobbyists to use them in low-resource environments, we developed the TeenyTinyLlama: _a pair of small foundational models trained in Brazilian Portuguese._
+
+TeenyTinyLlama is a pair of compact language models based on the Llama 2 architecture. These models are designed to deliver efficient natural language processing capabilities while being resource-conscious.
+
+Also, TeenyTinyLlama models were trained by leveraging [scaling laws](https://arxiv.org/abs/2203.15556) to determine the optimal number of tokens per parameter while incorporating [preference pre-training](https://arxiv.org/abs/2112.00861).
+
+## Details
+
+- **Architecture:** a Transformer-based model pre-trained via causal language modeling
+- **Size:** 468,239,360 parameters
+- **Context length:** 2048 tokens
+- **Dataset:** [Portuguese-Corpus-v3](https://huggingface.co/datasets/nicholasKluge/portuguese-corpus-v3) (6.2B tokens)
+- **Language:** Portuguese
+- **Number of steps:** 1,200,000
+- **GPU:** 1 NVIDIA A100-SXM4-40GB
+- **Training time**: ~ 280 hours
+- **Emissions:** 41.1 KgCO2 (Germany)
+- **Total energy consumption:** 115.69 kWh
+
+This repository has the [source code](https://github.com/Nkluge-correa/Aira) used to train this model. The main libraries used are:
+
+- [Transformers](https://github.com/huggingface/transformers)
+- [PyTorch](https://github.com/pytorch/pytorch)
+- [Datasets](https://github.com/huggingface/datasets)
+- [Tokenizers](https://github.com/huggingface/tokenizers)
+- [Sentencepiece](https://github.com/google/sentencepiece)
+- [Accelerate](https://github.com/huggingface/accelerate)
+- [Codecarbon](https://github.com/mlco2/codecarbon)
+
+## Training Set-up
+
+These are the main arguments used in the training of this model:
+
+| Arguments                     | Value                                |
+|-------------------------------|--------------------------------------|
+| vocabulary size               | 32000                                |
+| hidden dimension size         | 1024                                 |
+| intermediate dimension size   | 4096                                 |
+| context length                | 2048                                 |
+| nº attention heads            | 16                                   |
+| nº hidden layers              | 24                                   |
+| nº key value heads            | 16                                   |
+| nº training samples           | 3033690                              |
+| nº validation samples         | 30000                                |
+| nº epochs                     | 1.5                                  |
+| evaluation steps				| 100000							   |
+| train batch size              | 2                                    |
+| eval batch size               | 4                                    |
+| gradient accumulation steps   | 2                                    |
+| optimizer                     | torch.optim.AdamW                    |
+| learning rate                 | 0.0003                               |
+| adam epsilon                  | 0.00000001                           |
+| weight decay                  | 0.01                                 |
+| scheduler type                | "cosine"                             |
+| warmup steps                  | 10000                                | 
+| gradient checkpointing        | false                                |
+| seed                          | 42                                   |
+| mixed precision               | 'no'                                 |
+| torch dtype                   | "float32"                            |
+| tf32                          | true                                 |
+
+## Intended Uses
+
+The primary intended use of TeenyTinyLlama is to research the behavior, functionality, and limitations of large language models. Checkpoints saved during training are intended to provide a controlled setting for performing scientific experiments. You may also further fine-tune and adapt TeenyTinyLlama-160m for deployment, as long as your use is in accordance with the Apache 2.0 license. If you decide to use pre-trained TeenyTinyLlama-160m as a basis for your fine-tuned model, please conduct your own risk and bias assessment. 
+
+## Basic usage
+
+Using the `pipeline`:
+
+```python
+from transformers import pipeline
+
+generator = pipeline("text-generation", model="nicholasKluge/TeenyTinyLlama-460m")
+
+completions  = generator("Astronomia é a ciência", num_return_sequences=2, max_new_tokens=100)
+
+for comp in completions:
+  print(f"🤖 {comp['generated_text']}")
+```
+
+Using the `AutoTokenizer` and `AutoModelForCausalLM`:
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+import torch
+
+# Load model and the tokenizer
+tokenizer = AutoTokenizer.from_pretrained("nicholasKluge/TeenyTinyLlama-460m", revision='main')
+model = AutoModelForCausalLM.from_pretrained("nicholasKluge/TeenyTinyLlama-460m", revision='main')
+
+# Pass the model to your device
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+
+model.eval()
+model.to(device)
+
+# Tokenize the inputs and pass them to the device
+inputs = tokenizer("Astronomia é a ciência", return_tensors="pt").to(device)
+
+# Generate some text
+completions = model.generate(**inputs, num_return_sequences=2, max_new_tokens=100)
+
+# Print the generated text
+for i, completion in enumerate(completions):
+    print(f'🤖 {tokenizer.decode(completion)}')
+```
+
+## Limitations
+
+- **Hallucinations:** This model can produce content that can be mistaken for truth but is, in fact, misleading or entirely false, i.e., hallucination.
+
+- **Biases and Toxicity:** This model inherits the social and historical stereotypes from the data used to train it. Given these biases, the model can produce toxic content, i.e., harmful, offensive, or detrimental to individuals, groups, or communities.
+
+- **Unreliable Code:** The model may produce incorrect code snippets and statements. These code generations should not be treated as suggestions or accurate solutions.
+
+- **Language Limitations:** The model is primarily designed to understand standard Portuguese (BR). Other languages might challenge its comprehension, leading to potential misinterpretations or errors in response.
+
+- **Repetition and Verbosity:** The model may get stuck on repetition loops (especially if the repetition penalty during generations is set to a meager value) or produce verbose responses unrelated to the prompt it was given.
+
+## Evaluations
 
 | Steps     | Evaluation Loss | Perplexity | Total Energy Consumption | Emissions     |
 |-----------|-----------------|------------|--------------------------|---------------|
@@ -25,3 +176,51 @@ size: 468,239,360
 - Note: Each evaluation consumed around 0.26 kWh of energy (~ 0.09 KgCO2eq), totaling 3.12 kWh (~ 1,11
 KgCO2eq).
 
+## Benchmarks
+
+| Models                                                                              | Average | [ARC](https://arxiv.org/abs/1803.05457) | [Hellaswag](https://arxiv.org/abs/1905.07830) | [MMLU](https://arxiv.org/abs/2009.03300) | [TruthfulQA](https://arxiv.org/abs/2109.07958) |
+|-------------------------------------------------------------------------------------|---------|-----------------------------------------|-----------------------------------------------|------------------------------------------|------------------------------------------------|
+| [TeenyTinyLlama-460m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-460m)     | 31.16   | 29.40                                   | 33.00                                         | 28.55                                    | 41.10                                          |
+| [TeenyTinyLlama-160m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-160m)     | 31.16   | 26.15                                   | 29.29                                         | 28.11                                    | 41.12                                          |
+| [Pythia-160m](https://huggingface.co/EleutherAI/pythia-160m-deduped)*               | 31.16   | 24.06                                   | 31.39                                         | 24.86                                    | 44.34                                          |
+| [OPT-125m](https://huggingface.co/facebook/opt-125m)*                               | 30.80   | 22.87                                   | 31.47                                         | 26.02                                    | 42.87                                          |
+| [Gpt2-portuguese-small](https://huggingface.co/pierreguillou/gpt2-small-portuguese) | 30.22   | 22.48                                   | 29.62                                         | 27.36                                    | 41.44                                          |
+| [Gpt2-small](https://huggingface.co/gpt2)*                                          | 29.97   | 21.48                                   | 31.60                                         | 25.79                                    | 40.65                                          | 
+| [Xglm-564M](https://huggingface.co/facebook/xglm-564M)*                             | 31.20   | 24.57                                   | 34.64                                         | 25.18                                    | 40.43                                          |
+| [Bloom-560m](https://huggingface.co/bigscience/bloom-560m)*                         | 32.13   | 24.74                                   | 37.15                                         | 24.22                                    | 42.44                                          |
+| [Multilingual GPT](https://huggingface.co/ai-forever/mGPT)*                         | 28.73   | 23.81                                   | 26.37                                         | 25.17                                    | 39.62                                          |
+
+- Evaluations on benchmarks were performed using the [Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness) (by [EleutherAI](https://www.eleuther.ai/)). Thanks to [Laiviet](https://github.com/laiviet/lm-evaluation-harness) for translating some of the tasks in the LM-Evaluation-Harness. The results of models marked with an "*" were retirved from the [Open LLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard).
+
+## Fine-Tuning Comparisons
+
+| Models                                                                                     | [IMDB](https://huggingface.co/datasets/christykoh/imdb_pt) | [FaQuAD-NLI](https://huggingface.co/datasets/ruanchaves/faquad-nli) | [HateBr](https://huggingface.co/datasets/ruanchaves/hatebr) | [Assin2](https://huggingface.co/datasets/assin2)| [AgNews](https://huggingface.co/datasets/maritaca-ai/ag_news_pt) |
+|--------------------------------------------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------|------------------------------------------------------------------|
+| [Bert-large-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased)| 93.58                                                      | 92.26                                                               | 91.57                                                       | 88.97                                           | 94.11                                                            |
+| [Bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) | 92.22                                                      | 93.07                                                               | 91.28                                                       | 87.45                                           | 94.19                                                            |
+| [TeenyTinyLlama-160m](https://huggingface.co/nicholasKluge/TeenyTinyLlama-160m)            | 91.14                                                      | 90.00                                                               | 90.71                                                       | 85.78                                           | 94.05                                                            | 
+| [Gpt2-small-portuguese](https://huggingface.co/pierreguillou/gpt2-small-portuguese)        | 91.60                                                      | 86.46                                                               | 87.42                                                       | 86.11                                           | 94.07                                                            |
+
+## Cite as 🤗
+
+```latex
+
+@misc{nicholas22llama,
+  doi = {10.5281/zenodo.6989727},
+  url = {https://huggingface.co/nicholasKluge/TeenyTinyLlama-460m},
+  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
+
+TeenyTinyLlama-460m is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.