unbabel-comet 0.0.2

High-quality Machine Translation Evaluation

Note: This is a Pre-Release Version. We are currently working on results for the WMT2020 shared task and will likely update the repository in the beginning of October (after the shared task results).

Quick Installation

Detailed usage examples and instructions can be found in the Full Documentation.

To install COMET as a package, simply run

pip install unbabel-comet

Scoring MT outputs:

Via Bash:

comet score -s path/to/sources.txt -h path/to/hypothesis.txt -r path/to/references.txt --model wmt-large-da-estimator-1719

You can export your results to a JSON file using the --to_json flag.

comet score -s path/to/sources.txt -h path/to/hypothesis.txt -r path/to/references.txt --model wmt-large-da-estimator-1719 --to_json output.json

Via Python:

from comet.models import download_model
model = download_model("wmt-large-da-estimator-1719", "path/where/to/save/models")
data = [
    {
        "src": "Hello world!",
        "mt": "Oi mundo!",
        "ref": "Olá mundo!"
    },
    {
        "src": "This is a sample",
        "mt": "este é um exemplo",
        "ref": "isto é um exemplo!"
    }
]
model.predict(data)

Simple Pythonic way to convert list or segments to model inputs:

source = ["Hello world!", "This is a sample"]
hypothesis = ["Oi mundo!", "este é um exemplo"]
reference = ["Olá mundo!", "isto é um exemplo!"]

data = {"src": source, "mt": hypothesis, "ref": reference}
data = [dict(zip(data, t)) for t in zip(*data.values())]

model.predict(data)

Model Zoo:

Model	Description
wmt-large-da-estimator-1719	RECOMMENDED: Estimator model build on top of XLM-R (large) trained on DA from WMT17, WMT18 and WMT19
wmt-base-da-estimator-1719	Estimator model build on top of XLM-R (base) trained on DA from WMT17, WMT18 and WMT19
wmt-large-da-estimator-1718	Estimator model build on top of XLM-R (large) trained on DA from WMT17 and WMT18
wmt-base-da-estimator-1718	Estimator model build on top of XLM-R (base) trained on DA from WMT17 and WMT18
wmt-large-hter-estimator	Estimator model build on top of XLM-R (large) trained to regress on HTER.
wmt-base-hter-estimator	Estimator model build on top of XLM-R (base) trained to regress on HTER.
emnlp-base-da-ranker	Translation ranking model that uses XLM-R to encode sentences. This model was trained with WMT17 and WMT18 Direct Assessments Relative Ranks (DARR).

QE-as-a-metric:

Model	Description
wmt-large-qe-estimator-1719	Quality Estimator model build on top of XLM-R (large) trained on DA from WMT17, WMT18 and WMT19.

Train your own Metric:

Instead of using pretrained models your can train your own model with the following command:

comet train -f {config_file_path}.yaml

Supported encoders:

• Learning Joint Multilingual Sentence Representations with Neural Machine Translation
• Massively Multilingual Sentence Embeddings for Zero-Shot Cross-Lingual Transfer and Beyond
• BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding
• XLM-R: Unsupervised Cross-lingual Representation Learning at Scale

Tensorboard:

Launch tensorboard with:

tensorboard --logdir="experiments/lightning_logs/"

Download Command:

To download public available corpora to train your new models you can use the download command. For example to download the APEQUEST HTER corpus just run the following command:

comet download -d apequest --saving_path data/

unittest:

pip install coverage

In order to run the toolkit tests you must run the following command:

coverage run --source=comet -m unittest discover
coverage report -m

Code Style:

To make sure all the code follows the same style we use Black.