Update README.md

README.md

@@ -4,27 +4,32 @@ library_name: transformers
 language:
 - en
 - pt
+pipeline_tag: translation
 ---
-# Model Description
+# Transformer-eng-por
 
-The transformer-eng-por model is used for text classification.
+## Model Overview
 
-The model was trained with a ...More information is needed.
+The transformer-eng-por model is transformer  trained to  for text classification
 
-## Details
-- Size: 23,805,216 parameters
-- Dataset: 
-- Languages: English, Portuguese
-- Number of Training 
-- Batch size: 32
-- Optimizer: rmsprop
-- Learning Rate: 0.001
-- Hardware: TeslaT4
-- This repository has the source [code used](https://github.com/Nkluge-correa/teeny-tiny_castle/blob/master/ML%20Intro%20Course/16_sequence_to_sequence.ipynb) to train this model.
+### Details
 
-## Usage
+- **Size:** 23,805,216 parameters
+- **Model type:** Transformer
+- **Optimizer**: `rmsprop` 
+- **Number of Epochs:** 30
+- **Embbedding dimensionality:** 256
+- **Dense dimensionality:** 2048
+- **Attention heads:** 8
+- **Vocabulary size:** 20000
+- **Sequence lenght:** 20
+- **Hardware:** Tesla V4
+- **Emissions:** Not measured
+- **Total Energy Consumption:** Not measured
 
-```
+### How to Use
+
+```python
 import tensorflow as tf
 import numpy as np
 import string
@@ -138,16 +143,41 @@ Portuguese translation:
 [start] não faça isso [end]
 --------------------------------------------------
 ```
+## Intended Use
+
+This model was created for research purposes only. Specifically, it was designed to translate sentences from English to Portuguese. We do not recommend any application of this model outside this scope.
+
+
+## Performance Metrics
+
+Accuracy: 76,46%
+
+
+## Training Data
+
+ [English-portuguese translation](https://www.kaggle.com/datasets/nageshsingh/englishportuguese-translation).
+
+ The dataset consists of a set of English and Portuguese sentences.
+
+## Limitations
+
+ In  `What is its name?` to `[start] o que é o seu nome [end]`, the `transformer` model makes a gender assumption,
+ even though the source sentence wasn't gendered (`[start] qual é o nome dele [end]`).
+ Errors like these are not uncommon in NLP, algorithmic bias being one of the great problems associated with using language models
+ in real applications. In conclusion, we do not recommend using this model in real-world applications.
+ It was solely developed for academic and educational purposes.
+
 # Cite as 🤗
-```
+```latex
 @misc{teenytinycastle,
     doi = {10.5281/zenodo.7112065},
-    url = {https://huggingface.co/AiresPucrs/transformer-eng-por},
+    url = {https://github.com/Nkluge-correa/teeny-tiny_castle},
     author = {Nicholas Kluge Corr{\^e}a},
     title = {Teeny-Tiny Castle},
-    year = {2023},
-    publisher = {HuggingFace},
-    journal = {HuggingFace repository},
+    year = {2024},
+    publisher = {GitHub},
+    journal = {GitHub repository},
+    note = {Last updated 12 January 2024},
 }
 ```
 ## License