


# Usage:
# ./gen-card-allenai-wmt16.py

import os
from pathlib import Path



def        UpperCamelCase_(   lowerCamelCase_							,				lowerCamelCase_							,				lowerCamelCase_							,				lowerCamelCase_				)					->		Dict:
    _lowercase :							List[str]   	=	{
        'en': 'Machine learning is great, isn\'t it?',
        'ru': 'Машинное обучение - это здорово, не так ли?',
        'de': 'Maschinelles Lernen ist großartig, nicht wahr?',
    }

    # BLUE scores as follows:
    # "pair": [fairseq, transformers]
    _lowercase :							List[str]   	=	{
        'wmt16-en-de-dist-12-1': [28.3, 27.52],
        'wmt16-en-de-dist-6-1': [27.4, 27.11],
        'wmt16-en-de-12-1': [26.9, 25.75],
    }
    _lowercase :							Dict   	=	F'''{src_lang}-{tgt_lang}'''

    _lowercase :							Optional[Any]   	=	F'''
---
language:
- {src_lang}
- {tgt_lang}
thumbnail:
tags:
- translation
- wmt16
- allenai
license: apache-2.0
datasets:
- wmt16
metrics:
- bleu
---

# FSMT

## Model description

This is a ported version of fairseq-based [wmt16 transformer](https://github.com/jungokasai/deep-shallow/) for {src_lang}-{tgt_lang}.

For more details, please, see [Deep Encoder, Shallow Decoder: Reevaluating the Speed-Quality Tradeoff in Machine Translation](https://arxiv.org/abs/2006.10369).

All 3 models are available:

* [wmt16-en-de-dist-12-1](https://huggingface.co/allenai/wmt16-en-de-dist-12-1)
* [wmt16-en-de-dist-6-1](https://huggingface.co/allenai/wmt16-en-de-dist-6-1)
* [wmt16-en-de-12-1](https://huggingface.co/allenai/wmt16-en-de-12-1)


## Intended uses & limitations

#### How to use

```python
from transformers import FSMTForConditionalGeneration, FSMTTokenizer
mname = "allenai/{model_name}"
tokenizer = FSMTTokenizer.from_pretrained(mname)
model = FSMTForConditionalGeneration.from_pretrained(mname)

input = "{texts[src_lang]}"
input_ids = tokenizer.encode(input, return_tensors="pt")
outputs = model.generate(input_ids)
decoded = tokenizer.decode(outputs[0], skip_special_tokens=True)
print(decoded) # {texts[tgt_lang]}

```

#### Limitations and bias


## Training data

Pretrained weights were left identical to the original model released by allenai. For more details, please, see the [paper](https://arxiv.org/abs/2006.10369).

## Eval results

Here are the BLEU scores:

model   | fairseq | transformers
-------|---------|----------
{model_name}  | {scores[model_name][0]} | {scores[model_name][1]}

The score is slightly below the score reported in the paper, as the researchers don\'t use `sacrebleu` and measure the score on tokenized outputs. `transformers` score was measured using `sacrebleu` on detokenized outputs.

The score was calculated using this code:

```bash
git clone https://github.com/huggingface/transformers
cd transformers
export PAIR={pair}
export DATA_DIR=data/$PAIR
export SAVE_DIR=data/$PAIR
export BS=8
export NUM_BEAMS=5
mkdir -p $DATA_DIR
sacrebleu -t wmt16 -l $PAIR --echo src > $DATA_DIR/val.source
sacrebleu -t wmt16 -l $PAIR --echo ref > $DATA_DIR/val.target
echo $PAIR
PYTHONPATH="src:examples/seq2seq" python examples/seq2seq/run_eval.py allenai/{model_name} $DATA_DIR/val.source $SAVE_DIR/test_translations.txt --reference_path $DATA_DIR/val.target --score_path $SAVE_DIR/test_bleu.json --bs $BS --task translation --num_beams $NUM_BEAMS
```

## Data Sources

- [training, etc.](http://www.statmt.org/wmt16/)
- [test set](http://matrix.statmt.org/test_sets/newstest2016.tgz?1504722372)


### BibTeX entry and citation info

```
@misc{{kasai2020deep,
    title={{Deep Encoder, Shallow Decoder: Reevaluating the Speed-Quality Tradeoff in Machine Translation}},
    author={{Jungo Kasai and Nikolaos Pappas and Hao Peng and James Cross and Noah A. Smith}},
    year={{2020}},
    eprint={{2006.10369}},
    archivePrefix={{arXiv}},
    primaryClass={{cs.CL}}
}}
```

'''
    model_card_dir.mkdir(parents=lowerCamelCase_							,				exist_ok=lowerCamelCase_				)
    _lowercase :							int   	=	os.path.join(lowerCamelCase_							,				'README.md'				)
    print(F'''Generating {path}'''				)
    with open(lowerCamelCase_							,				'w'							,				encoding='utf-8'				) as f:
        f.write(lowerCamelCase_				)


# make sure we are under the root of the project
SCREAMING_SNAKE_CASE :   List[str]							      =				Path(__file__).resolve().parent.parent.parent
SCREAMING_SNAKE_CASE :   List[str]							      =				repo_dir / "model_cards"

for model_name in ["wmt16-en-de-dist-12-1", "wmt16-en-de-dist-6-1", "wmt16-en-de-12-1"]:
      SCREAMING_SNAKE_CASE :   int							      =				model_cards_dir / "allenai" / model_name
      write_model_card(model_card_dir, src_lang="en", tgt_lang="de", model_name=model_name)






import os

import pytest
import yaml

from datasets.features.features import Features, Value
from datasets.info import DatasetInfo, DatasetInfosDict



@pytest.mark.parametrize(
    'files'							,				[
        ['full:README.md', 'dataset_infos.json'],
        ['empty:README.md', 'dataset_infos.json'],
        ['dataset_infos.json'],
        ['full:README.md'],
    ]							,				)
def        UpperCamelCase_(   lowerCamelCase_							,				lowerCamelCase_				)					->		List[str]:
    _lowercase :							Any   	=	tmp_path_factory.mktemp('dset_infos_dir'				)
    if "full:README.md" in files:
        with open(dataset_infos_dir / 'README.md'							,				'w'				) as f:
            f.write('---\ndataset_info:\n  dataset_size: 42\n---'				)
    if "empty:README.md" in files:
        with open(dataset_infos_dir / 'README.md'							,				'w'				) as f:
            f.write(''				)
    # we want to support dataset_infos.json for backward compatibility
    if "dataset_infos.json" in files:
        with open(dataset_infos_dir / 'dataset_infos.json'							,				'w'				) as f:
            f.write('{"default": {"dataset_size": 42}}'				)
    _lowercase :							Any   	=	DatasetInfosDict.from_directory(lowerCamelCase_				)
    assert dataset_infos
    assert dataset_infos["default"].dataset_size == 42



@pytest.mark.parametrize(
    'dataset_info'							,				[
        DatasetInfo(),
        DatasetInfo(
            description='foo'							,				features=Features({'a': Value('int32'				)}				)							,				builder_name='builder'							,				config_name='config'							,				version='1.0.0'							,				splits=[{'name': 'train'}]							,				download_size=42							,				),
    ]							,				)
def        UpperCamelCase_(   lowerCamelCase_							,				lowerCamelCase_				)					->		Optional[int]:
    _lowercase :							Union[str, Any]   	=	str(lowerCamelCase_				)
    dataset_info.write_to_directory(lowerCamelCase_				)
    _lowercase :							List[str]   	=	DatasetInfo.from_directory(lowerCamelCase_				)
    assert dataset_info == reloaded
    assert os.path.exists(os.path.join(lowerCamelCase_							,				'dataset_info.json'				)				)



def        UpperCamelCase_(   )					->		int:
    _lowercase :							Tuple   	=	DatasetInfo(
        description='foo'							,				citation='bar'							,				homepage='https://foo.bar'							,				license='CC0'							,				features=Features({'a': Value('int32'				)}				)							,				post_processed={}							,				supervised_keys=()							,				task_templates=[]							,				builder_name='builder'							,				config_name='config'							,				version='1.0.0'							,				splits=[{'name': 'train', 'num_examples': 42}]							,				download_checksums={}							,				download_size=1337							,				post_processing_size=442							,				dataset_size=1234							,				size_in_bytes=1337 + 442 + 1234							,				)
    _lowercase :							Optional[int]   	=	dataset_info._to_yaml_dict()
    assert sorted(lowerCamelCase_				) == sorted(DatasetInfo._INCLUDED_INFO_IN_YAML				)
    for key in DatasetInfo._INCLUDED_INFO_IN_YAML:
        assert key in dataset_info_yaml_dict
        assert isinstance(dataset_info_yaml_dict[key]							,				(list, dict, int, str)				)
    _lowercase :							str   	=	yaml.safe_dump(lowerCamelCase_				)
    _lowercase :							str   	=	yaml.safe_load(lowerCamelCase_				)
    assert dataset_info_yaml_dict == reloaded



def        UpperCamelCase_(   )					->		int:
    _lowercase :							Tuple   	=	DatasetInfo()
    _lowercase :							Tuple   	=	dataset_info._to_yaml_dict()
    assert dataset_info_yaml_dict == {}



@pytest.mark.parametrize(
    'dataset_infos_dict'							,				[
        DatasetInfosDict(),
        DatasetInfosDict({'default': DatasetInfo()}				),
        DatasetInfosDict({'my_config_name': DatasetInfo()}				),
        DatasetInfosDict(
            {
                'default': DatasetInfo(
                    description='foo'							,				features=Features({'a': Value('int32'				)}				)							,				builder_name='builder'							,				config_name='config'							,				version='1.0.0'							,				splits=[{'name': 'train'}]							,				download_size=42							,				)
            }				),
        DatasetInfosDict(
            {
                'v1': DatasetInfo(dataset_size=42				),
                'v2': DatasetInfo(dataset_size=1337				),
            }				),
    ]							,				)
def        UpperCamelCase_(   lowerCamelCase_							,				lowerCamelCase_				)					->		Dict:
    _lowercase :							Tuple   	=	str(lowerCamelCase_				)
    dataset_infos_dict.write_to_directory(lowerCamelCase_				)
    _lowercase :							Tuple   	=	DatasetInfosDict.from_directory(lowerCamelCase_				)

    # the config_name of the dataset_infos_dict take over the attribute
    for config_name, dataset_info in dataset_infos_dict.items():
        _lowercase :							Any   	=	config_name
        # the yaml representation doesn't include fields like description or citation
        # so we just test that we can recover what we can from the yaml
        _lowercase :							str   	=	DatasetInfo._from_yaml_dict(dataset_info._to_yaml_dict()				)
    assert dataset_infos_dict == reloaded

    if dataset_infos_dict:
        assert os.path.exists(os.path.join(lowerCamelCase_							,				'README.md'				)				)


