Add description

README.md

@@ -1,3 +1,58 @@
----
-license: mit
----
+---
+language: 
+- ca
+- fr
+
+tags:
+- translation
+
+library_name: opennmt
+license: mit
+metrics:
+- bleu
+
+inference: false
+---
+
+### Introduction
+
+Catalan - French translation model for OpenNMT. These are the same models that we have in production at https://www.softcatala.org/traductor/.
+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)   	| 41.4	|
+| Flores200 dataset                     | 35.4	|
+
+## Additional information
+* https://github.com/Softcatala/nmt-models
+* https://github.com/Softcatala/parallel-catalan-corpus

config.json

@@ -0,0 +1,2 @@
+{
+}

model_description.txt

@@ -0,0 +1,9 @@
+Model description: cat-fra
+Date: 2022-11-14
+TF version 2.10.0, OpenNMT version 2.29.1, CTranslate2 version 2.24.0
+Test data set
+  BLEU|nrefs:1|case:mixed|eff:no|tok:13a|smooth:exp|version:2.1.0 = 41.4 67.8/47.5/35.9/27.7 (BP = 0.978 ratio = 0.979 hyp_len = 155890 ref_len = 159288)
+chrF2|nrefs:1|case:mixed|eff:yes|nc:6|nw:0|space:no|version:2.1.0 = 65.1
+Flores data set
+  BLEU|nrefs:1|case:mixed|eff:no|tok:13a|smooth:exp|version:2.1.0 = 35.4 65.0/42.4/29.8/21.5 (BP = 0.970 ratio = 0.971 hyp_len = 27511 ref_len = 28343)
+chrF2|nrefs:1|case:mixed|eff:yes|nc:6|nw:0|space:no|version:2.1.0 = 61.3