Update README.md

README.md

@@ -6,28 +6,11 @@ language:
 - pt
 pipeline_tag: translation
 ---
-# Transformer-eng-por
+# Transformer En-PT (Teeny-Tiny Castle)
 
-## Model Overview
+This model is part of a tutorial tied to the [Teeny-Tiny Castle](https://github.com/Nkluge-correa/TeenyTinyCastle), an open-source repository containing educational tools for AI Ethics and Safety research. 
 
-The transformer-eng-por model is a transformer trained for text classification.
-
-### Details
-
-- **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
+## How to Use
 
 ```python
 import tensorflow as tf
@@ -53,7 +36,7 @@ portuguese_vocabulary_path = hf_hub_download(
 
 from keras_transformer_blocks import TransformerEncoder, PositionalEmbedding, TransformerDecoder
 
-transformer = keras.models.load_model("/content/transformer-eng-por/transformer-eng-por.h5",
+transformer = keras.models.load_model("./transformer-eng-por/transformer-eng-por.h5",
     custom_objects={"TransformerEncoder": TransformerEncoder,
         "PositionalEmbedding": PositionalEmbedding,
         "TransformerDecoder": TransformerDecoder})
@@ -109,75 +92,3 @@ for sentence in eng_sentences:
     print(f'Portuguese translation:\n{decode_sequence(sentence)}')
     print('-' * 50)
 ```
-This will output the following:
-
-```
-English sentence:
-What is its name?
-Portuguese translation:
-[start] qual é o nome dele [end]
---------------------------------------------------
-English sentence:
-How old are you?
-Portuguese translation:
-[start] quantos anos você tem [end]
---------------------------------------------------
-English sentence:
-I know you know where Mary is.
-Portuguese translation:
-[start] eu sei que você sabe onde mary está [end]
---------------------------------------------------
-English sentence:
-We will show Tom.
-Portuguese translation:
-[start] vamos ligar para o tom [end]
---------------------------------------------------
-English sentence:
-What do you all do?
-Portuguese translation:
-[start] o que vocês todos nós têm feito [end]
---------------------------------------------------
-English sentence:
-Don't do it!
-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 common 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://github.com/Nkluge-correa/teeny-tiny_castle},
-    author = {Nicholas Kluge Corr{\^e}a},
-    title = {Teeny-Tiny Castle},
-    year = {2024},
-    publisher = {GitHub},
-    journal = {GitHub repository},
-}
-```
-## License
-The transformer-eng-por is licensed under the Apache License, Version 2.0. See the LICENSE file for more details.