WMT 22 DA model card

README.md

@@ -1,3 +1,55 @@
 ---
 license: apache-2.0
 ---
+
+This is a [COMET](https://github.com/Unbabel/COMET) evaluation model: It receives a triplet with (source sentence, translation, reference translation) and returns a score that reflects the quality of the translation compared to both source and reference.
+
+# Paper
+
+[COMET-22: Unbabel-IST 2022 Submission for the Metrics Shared Task](https://aclanthology.org/2022.wmt-1.52) (Rei et al., WMT 2022)
+
+## 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 the model like this:
+
+```python
+from comet import download_model, load_from_checkpoint
+
+model_path = download_model("Unbabel/wmt22-comet-da")
+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!