Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,29 @@
+---
+language:
+  - ca
+  - en
+tags:
+- translation
+license: cc-by-4.0
+---
+
+### Translation model for ca-en HPLT 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.
+
+* Source language: ca
+* Target language: en
+* Dataset: HPLT only
+* Model: 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/ca-en/raw/v0) 
+
+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.
+
+
+## Benchmarks
+
+| testset                                | BLEU | chr-F | comet |
+| -------------------------------------- | ---- | ----- | ----- |
+| flores200     | 41.0 | 64.4  | 0.8955  |
+| ntrex | 31.3   | 57.7  | 0.8757  |