update README

README.md

@@ -1,29 +1,43 @@
 ---
 language:
+  - nn
   - en
-  - fi
 tags:
 - translation
 license: cc-by-4.0
 ---
 
-### Translation model for en-fi OPUS_HPLT v1.0
+### HPLT MT release v1.0
 
-This repository contains the model weights for translation models trained with Marian for HPLT project. For usage instructions, evaluation scripts, and inference scripts, please refer to the [HPLT-MT-Models v1.0](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0) GitHub repository.
+This repository contains the translation model for nn-en trained with HPLT data only. For usage instructions, evaluation scripts, and inference scripts, please refer to the [HPLT-MT-Models v1.0](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0) GitHub repository.
 
-* Source language: en
-* Target language: fi
-* Dataset: All of OPUS including HPLT
-* Model: transformer-base
+### Model Info
+
+* Source language: nn
+* Target language: en
+* Data: HPLT data only
+* Model architecture: Transformer-base
 * Tokenizer: SentencePiece (Unigram)
-* Cleaning: We use OpusCleaner for cleaning the corpus. Details about rules used can be found in the filter files in [Github](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0/data/fi-en/raw/v2) 
+* Cleaning: We used OpusCleaner with a set of basic rules. Details can be found in the filter files in [Github](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0/data/en-nn/raw/v0)
+
+You can also read our deliverable report [here](https://hplt-project.org/HPLT_D5_1___Translation_models_for_select_language_pairs.pdf) for more details.
+
+### Usage
+*Note* that for quality considerations, we recommend using `[HPLT/translate-nn-en-v1.0-hplt_opus](https://huggingface.co/HPLT/translate-nn-en-v1.0-hplt_opus)` instead of this model.
 
-To run inference with Marian, refer to the [Inference/Decoding/Translation](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0#inferencedecodingtranslation) section of our GitHub repository.
+The model has been trained with Marian. To run inference, refer to the [Inference/Decoding/Translation](https://github.com/hplt-project/HPLT-MT-Models/tree/main/v1.0#inferencedecodingtranslation) section of our GitHub repository.
 
+The model can be used with the Hugging Face framework if the weights are converted to the Hugging Face format. We might provide this in the future; contributions are also welcome.
 
 ## Benchmarks
 
-| testset                                | BLEU | chr-F | COMET-22 |
+| testset                                | BLEU | chrF++ | COMET22 |
 | -------------------------------------- | ---- | ----- | ----- |
-| flores200     | 22.5 | 52.3  | 0.8897  |
-| ntrex | 17.9   | 47.6  | 0.8402  |
+| flores200     | 1.4 | 18.0  | 0.4071  |
+| ntrex | 1.1   | 16.7  | 0.4002  |
+
+### Acknowledgements
+
+This project has received funding from the European Union's Horizon Europe research and innovation programme under grant agreement No 101070350 and from UK Research and Innovation (UKRI) under the UK government's Horizon Europe funding guarantee [grant number 10052546]
+
+Brought to you by researchers from the University of Edinburgh, Charles University in Prague, and the whole HPLT consortium.