UniTE MUP checkpoint

README.md

@@ -1,3 +1,166 @@
 ---
+pipeline_tag: translation
+language:
+  - multilingual
+  - af
+  - am
+  - ar
+  - as
+  - az
+  - be
+  - bg
+  - bn
+  - br
+  - bs
+  - ca
+  - cs
+  - cy
+  - da
+  - de
+  - el
+  - en
+  - eo
+  - es
+  - et
+  - eu
+  - fa
+  - fi
+  - fr
+  - fy
+  - ga
+  - gd
+  - gl
+  - gu
+  - ha
+  - he
+  - hi
+  - hr
+  - hu
+  - hy
+  - id
+  - is
+  - it
+  - ja
+  - jv
+  - ka
+  - kk
+  - km
+  - kn
+  - ko
+  - ku
+  - ky
+  - la
+  - lo
+  - lt
+  - lv
+  - mg
+  - mk
+  - ml
+  - mn
+  - mr
+  - ms
+  - my
+  - ne
+  - nl
+  - 'no'
+  - om
+  - or
+  - pa
+  - pl
+  - ps
+  - pt
+  - ro
+  - ru
+  - sa
+  - sd
+  - si
+  - sk
+  - sl
+  - so
+  - sq
+  - sr
+  - su
+  - sv
+  - sw
+  - ta
+  - te
+  - th
+  - tl
+  - tr
+  - ug
+  - uk
+  - ur
+  - uz
+  - vi
+  - xh
+  - yi
+  - zh
+
 license: apache-2.0
 ---
+
+This model was developed by the NLP2CT Lab at the University of Macau and Alibaba Group, and all credits should be attributed to these groups. Since it was developed using the COMET codebase, we adapted the code to run these models within COMET."
+
+# Paper
+
+- [UniTE: Unified Translation Evaluation](https://aclanthology.org/2022.acl-long.558/) (Wan et al., ACL 2022)
+
+# Original Code
+
+- [UniTE](https://github.com/NLP2CT/UniTE)
+
+# License
+
+Apache 2.0
+
+# Usage (unbabel-comet)
+
+Using this model requires unbabel-comet to be installed:
+
+```bash
+pip install --upgrade pip  # ensures that pip is current 
+pip install unbabel-comet
+```
+
+Then you can use it through comet CLI:
+
+```bash
+comet-score -s {source-inputs}.txt -t {translation-outputs}.txt -r {references}.txt --model Unbabel/unite-mup
+```
+
+Or using Python:
+
+```python
+from comet import download_model, load_from_checkpoint
+
+model_path = download_model("Unbabel/unite-mup")
+model = load_from_checkpoint(model_path)
+data = [
+    {
+        "src": "Dem Feuer konnte Einhalt geboten werden",
+        "mt": "The fire could be stopped",
+        "ref": "They were able to control the fire."
+    },
+    {
+        "src": "Schulen und Kindergärten wurden eröffnet.",
+        "mt": "Schools and kindergartens were open",
+        "ref": "Schools and kindergartens opened"
+    }
+]
+model_output = model.predict(data, batch_size=8, gpus=1)
+print (model_output)
+```
+
+# Intended uses
+
+Our model is intented to be used for **MT evaluation**. 
+
+Given a a triplet with (source sentence, translation, reference translation) outputs a single score between 0 and 1 where 1 represents a perfect translation. 
+
+# Languages Covered:
+
+This model builds on top of XLM-R which cover the following languages:
+
+Afrikaans, Albanian, Amharic, Arabic, Armenian, Assamese, Azerbaijani, Basque, Belarusian, Bengali, Bengali Romanized, Bosnian, Breton, Bulgarian, Burmese, Burmese, Catalan, Chinese (Simplified), Chinese (Traditional), Croatian, Czech, Danish, Dutch, English, Esperanto, Estonian, Filipino, Finnish, French, Galician, Georgian, German, Greek, Gujarati, Hausa, Hebrew, Hindi, Hindi Romanized, Hungarian, Icelandic, Indonesian, Irish, Italian, Japanese, Javanese, Kannada, Kazakh, Khmer, Korean, Kurdish (Kurmanji), Kyrgyz, Lao, Latin, Latvian, Lithuanian, Macedonian, Malagasy, Malay, Malayalam, Marathi, Mongolian, Nepali, Norwegian, Oriya, Oromo, Pashto, Persian, Polish, Portuguese, Punjabi, Romanian, Russian, Sanskri, Scottish, Gaelic, Serbian, Sindhi, Sinhala, Slovak, Slovenian, Somali, Spanish, Sundanese, Swahili, Swedish, Tamil, Tamil Romanized, Telugu, Telugu Romanized, Thai, Turkish, Ukrainian, Urdu, Urdu Romanized, Uyghur, Uzbek, Vietnamese, Welsh, Western, Frisian, Xhosa, Yiddish.
+
+Thus, results for language pairs containing uncovered languages are unreliable!

checkpoints/model.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:009d25e6e8b3317bef1bbab5185881d2eb84ba9e98abf8f8f0509bc3f3b2aae5
+size 2260734321

hparams.yaml

@@ -0,0 +1,30 @@
+activations: Tanh
+batch_size: 4
+class_identifier: unified_metric
+dropout: 0.1
+encoder_learning_rate: 5.0e-06
+encoder_model: XLM-RoBERTa
+final_activation: null
+hidden_sizes:
+- 3072
+- 1024
+input_segments:
+- src
+- mt
+- ref
+keep_embeddings_frozen: true
+layer: mix
+layerwise_decay: 0.95
+learning_rate: 1.5e-05
+load_weights_from_checkpoint: null
+nr_frozen_epochs: 0.3
+optimizer: AdamW
+pool: cls
+pretrained_model: xlm-roberta-large
+train_data: data/1719-da.csv
+validation_data:
+- data/qad-ende-newstest2020.csv
+- data/qad-enru-newstest2020.csv
+- data/wmt-ende-newstest2021.csv
+- data/wmt-zhen-newstest2021.csv
+- data/wmt-enru-newstest2021.csv