Update README.md

README.md

@@ -3,39 +3,17 @@ license: apache-2.0
 language:
 - es
 - ca
+metrics:
+- bleu
+library_name: fairseq
 ---
 ## Aina Project's Spanish-Catalan machine translation model
-
-## Table of Contents
-- [Model Description](#model-description)
-- [Intended Uses and Limitations](#intended-use)
-- [How to Use](#how-to-use)
-- [Training](#training)
-  - [Training data](#training-data)
-  - [Training procedure](#training-procedure)
-    - [Data Preparation](#data-preparation)
-    - [Tokenization](#tokenization)
-    - [Hyperparameters](#hyperparameters)
-- [Evaluation](#evaluation)
-   - [Variable and Metrics](#variable-and-metrics)
-   - [Evaluation Results](#evaluation-results)
-- [Additional Information](#additional-information)
-  - [Author](#author)
-  - [Contact Information](#contact-information)
-  - [Copyright](#copyright)
-  - [Licensing Information](#licensing-information)
-  - [Funding](#funding)
-  - [Disclaimer](#disclaimer)
   
 ## Model description
 
-This model was trained from scratch using the [Fairseq toolkit](https://fairseq.readthedocs.io/en/latest/) on a combination of Catalan-Spanish datasets,
-up to 92 million sentences. Additionally, the model was evaluated on several public datasets pertaining to 5 different domains, specifically:
-general, 
-adminstrative, 
-technology, 
-biomedical, 
-and news. 
+This model was trained from scratch using the [Fairseq toolkit](https://fairseq.readthedocs.io/en/latest/) on a combination of Catalan-Spanish datasets, 
+up to 92 million sentences. Additionally, the model is evaluated on several public datasecomprising 5 different domains (general, adminstrative, technology, 
+biomedical, and news).
 
 ## Intended uses and limitations
 
@@ -55,7 +33,7 @@ Translate a sentence using python
 import ctranslate2
 import pyonmttok
 from huggingface_hub import snapshot_download
-model_dir = snapshot_download(repo_id="projecte-aina/mt-aina-es-ca", revision="main")
+model_dir = snapshot_download(repo_id="projecte-aina/aina-translator-es-ca", revision="main")
 
 tokenizer=pyonmttok.Tokenizer(mode="none", sp_model_path = model_dir + "/spm.model")
 tokenized=tokenizer.tokenize("Bienvenido al Proyecto Aina!")
@@ -65,6 +43,10 @@ translated = translator.translate_batch([tokenized[0]])
 print(tokenizer.detokenize(translated[0][0]['tokens']))
 ```
 
+## Limitations and bias
+At the time of submission, no measures have been taken to estimate the bias and toxicity embedded in the model. 
+However, we are well aware that our models may be biased. We intend to conduct research in these areas in the future, and if completed, this model card will be updated. 
+
 ## Training
 
 ### Training data
@@ -139,7 +121,7 @@ We use the BLEU score for evaluation on following test sets:
 [TaCon](https://elrc-share.eu/repository/browse/tacon-spanish-constitution-mt-test-set/84a96138b98611ec9c1a00155d02670628f3e6857b0f422abd82abc3795ec8c2/),
 [United Nations](https://zenodo.org/record/3888414#.Y33-_tLMIW0),
 [Cybersecurity](https://elrc-share.eu/repository/browse/cyber-mt-test-set/2bd93faab98c11ec9c1a00155d026706b96a490ed3e140f0a29a80a08c46e91e/),
-[wmt19 biomedical test set](),
+[wmt19 biomedical test set](http://www.statmt.org/wmt19/biomedical-translation-task.html),
 [wmt13 news test set](https://elrc-share.eu/repository/browse/catalan-wmt2013-machine-translation-shared-task-test-set/84a96139b98611ec9c1a00155d0267061a0aa1b62e2248e89aab4952f3c230fc/)
 
 ### Evaluation results
@@ -147,7 +129,7 @@ We use the BLEU score for evaluation on following test sets:
 Below are the evaluation results on the machine translation from Spanish to Catalan
 compared to [Softcatalà](https://www.softcatala.org/) and [Google Translate](https://translate.google.es/?hl=es):
 
-| Test set             | SoftCatalà | Google Translate | mt-aina-es-ca |
+| Test set             | SoftCatalà | Google Translate | aina-translator-es-ca |
 |----------------------|------------|------------------|---------------|
 | Spanish Constitution | **63,6** | 61,7     | 63,0     |
 | United Nations       | 73,8     | 74,8     | **74,9** |
@@ -162,30 +144,34 @@ compared to [Softcatalà](https://www.softcatala.org/) and [Google Translate](ht
 ## Additional information
 
 ### Author
-Language Technologies Unit (LangTech) at the Barcelona Supercomputing Center.
+The Language Technologies Unit from Barcelona Supercomputing Center.
 
-### Contact information
-For further information, please send an email to [email protected].
+### Contact
+For further information, please send an email to <[email protected]>.
 
 ### Copyright
-Language Technologies Unit at Barcelona Supercomputing Center (2023).
+Copyright(c) 2023 by Language Technologies Unit, Barcelona Supercomputing Center.
 
-
-### Licensing Information
-This work is licensed under an [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+### License
+[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 ### Funding
 This work has been promoted and financed by the Generalitat de Catalunya through the [Aina project](https://projecteaina.cat/).
 
-## Limitations and Bias
-At the time of submission, no measures have been taken to estimate the bias and toxicity embedded in the model. However, we are aware that our models may be biased since the corpora have been collected using crawling techniques on multiple web sources. We intend to conduct research in these areas in the future, and if completed, this model card will be updated.
-
-## Disclaimer
+### Disclaimer
 
 <details>
 <summary>Click to expand</summary>
 
-The models published in this repository are intended for a generalist purpose and are available to third parties. These models may have bias and/or any other undesirable distortions.
-When third parties, deploy or provide systems and/or services to other parties using any of these models (or using systems based on these models) or become users of the models, they should note that it is their responsibility to mitigate the risks arising from their use and, in any event, to comply with applicable regulations, including regulations regarding the use of Artificial Intelligence.
-In no event shall the owner and creator of the models (BSC – Barcelona Supercomputing Center) be liable for any results arising from the use made by third parties of these models.
+The model published in this repository is intended for a generalist purpose and is available to third parties under a permissive Apache License, Version 2.0. 
+
+Be aware that the model may have biases and/or any other undesirable distortions.
+
+When third parties deploy or provide systems and/or services to other parties using this model (or any system based on it) 
+or become users of the model, they should note that it is their responsibility to mitigate the risks arising from its use and, 
+in any event, to comply with applicable regulations, including regulations regarding the use of Artificial Intelligence.
+
+In no event shall the owner and creator of the model (Barcelona Supercomputing Center) 
+be liable for any results arising from the use made by third parties.
+
 </details>