Readme

README.md

@@ -1,3 +1,57 @@
----
-license: mit
----
+---
+language: 
+- ca
+- es
+
+tags:
+- translation
+
+library_name: opennmt
+license: mit
+metrics:
+- bleu
+
+inference: false
+---
+
+### Introduction
+
+Catalan - Spanish translation model for OpenNMT. The models are quantified for low latency.
+
+### Usage
+
+Install the necessary dependencies:
+
+
+```bash
+pip3 install ctranslate2 pyonmttok
+```
+
+
+Simple tokenization & translation using Python:
+
+
+```python
+import ctranslate2
+import pyonmttok
+from huggingface_hub import snapshot_download
+model_dir = snapshot_download(repo_id="softcatala/translate-cat-fra", revision="main")
+
+tokenizer=pyonmttok.Tokenizer(mode="none", sp_model_path = model_dir + "/sp_m.model")
+tokenized=tokenizer.tokenize("Hola amics")
+
+translator = ctranslate2.Translator(model_dir)
+translated = translator.translate_batch([tokenized[0]])
+print(tokenizer.detokenize(translated[0][0]['tokens']))
+```
+
+## Benchmarks
+
+| testset                               | BLEU  |
+|---------------------------------------|-------|
+| test dataset (from train/dev/test)   	| 87.5	|
+| Flores200 dataset                     | 24.2	|
+
+## Additional information
+* https://github.com/Softcatala/nmt-models
+* https://github.com/Softcatala/parallel-catalan-corpus