




# Usage:
# ./gen-card-facebook-wmt19.py

import os
from pathlib import Path



def 						lowerCAmelCase		(		_lowerCAmelCase							:   Optional[int]						,							_lowerCAmelCase							:   Any						,							_lowerCAmelCase							:   List[Any]	):




 """simple docstring"""







 UpperCAmelCase__							 =						{
     "en": "Machine learning is great, isn't it?",
     "ru": "Машинное обучение - это здорово, не так ли?",
     "de": "Maschinelles Lernen ist großartig, oder?",
 }

 # BLUE scores as follows:
 # "pair": [fairseq, transformers]
 UpperCAmelCase__							 =						{
     "ru-en": ["[41.3](http://matrix.statmt.org/matrix/output/1907?run_id=6937)", "39.20"],
     "en-ru": ["[36.4](http://matrix.statmt.org/matrix/output/1914?run_id=6724)", "33.47"],
     "en-de": ["[43.1](http://matrix.statmt.org/matrix/output/1909?run_id=6862)", "42.83"],
     "de-en": ["[42.3](http://matrix.statmt.org/matrix/output/1902?run_id=6750)", "41.35"],
 }
 UpperCAmelCase__							 =						F'''{src_lang}-{tgt_lang}'''

 UpperCAmelCase__							 =						F'''
---
language: 
- {src_lang}
- {tgt_lang}
thumbnail:
tags:
- translation
- wmt19
- facebook
license: apache-2.0
datasets:
- wmt19
metrics:
- bleu
---

# FSMT

## Model description

This is a ported version of [fairseq wmt19 transformer](https://github.com/pytorch/fairseq/blob/master/examples/wmt19/README.md) for {src_lang}-{tgt_lang}.

For more details, please see, [Facebook FAIR\'s WMT19 News Translation Task Submission](https://arxiv.org/abs/1907.06616).

The abbreviation FSMT stands for FairSeqMachineTranslation

All four models are available:

* [wmt19-en-ru](https://huggingface.co/facebook/wmt19-en-ru)
* [wmt19-ru-en](https://huggingface.co/facebook/wmt19-ru-en)
* [wmt19-en-de](https://huggingface.co/facebook/wmt19-en-de)
* [wmt19-de-en](https://huggingface.co/facebook/wmt19-de-en)

## Intended uses & limitations

#### How to use

```python
from transformers import FSMTForConditionalGeneration, FSMTTokenizer
mname = "facebook/wmt19-{src_lang}-{tgt_lang}"
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

- The original (and this ported model) doesn\'t seem to handle well inputs with repeated sub-phrases, [content gets truncated](https://discuss.huggingface.co/t/issues-with-translating-inputs-containing-repeated-phrases/981)

## Training data

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

## Eval results

pair   | fairseq | transformers
-------|---------|----------
{pair}  | {scores[pair][0]} | {scores[pair][1]}

The score is slightly below the score reported by `fairseq`, since `transformers`` currently doesn\'t support:
- model ensemble, therefore the best performing checkpoint was ported (``model4.pt``).
- re-ranking

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=15
mkdir -p $DATA_DIR
sacrebleu -t wmt19 -l $PAIR --echo src > $DATA_DIR/val.source
sacrebleu -t wmt19 -l $PAIR --echo ref > $DATA_DIR/val.target
echo $PAIR
PYTHONPATH="src:examples/seq2seq" python examples/seq2seq/run_eval.py facebook/wmt19-$PAIR $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
```
note: fairseq reports using a beam of 50, so you should get a slightly higher score if re-run with `--num_beams 50`.

## Data Sources

- [training, etc.](http://www.statmt.org/wmt19/)
- [test set](http://matrix.statmt.org/test_sets/newstest2019.tgz?1556572561)


### BibTeX entry and citation info

```bibtex
@inproceedings{{...,
  year={{2020}},
  title={{Facebook FAIR\'s WMT19 News Translation Task Submission}},
  author={{Ng, Nathan and Yee, Kyra and Baevski, Alexei and Ott, Myle and Auli, Michael and Edunov, Sergey}},
  booktitle={{Proc. of WMT}},
}}
```


## TODO

- port model ensemble (fairseq uses 4 model checkpoints)

'''
 os.makedirs(_lowerCAmelCase						,							exist_ok=_lowerCAmelCase	)
 UpperCAmelCase__							 =						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
_lowerCAmelCase						:   Union[str, Any]		=   Path(__file__).resolve().parent.parent.parent
_lowerCAmelCase						:   Tuple		=   repo_dir / "model_cards"

for model_name in ["wmt19-ru-en", "wmt19-en-ru", "wmt19-en-de", "wmt19-de-en"]:
  _lowerCAmelCase,					_lowerCAmelCase,					_lowerCAmelCase						:   int		=   model_name.split("-")
  _lowerCAmelCase						:   List[str]		=   model_cards_dir / "facebook" / model_name
  write_model_card(model_card_dir, src_lang=src_lang, tgt_lang=tgt_lang)











from typing import List, Optional, Union

import numpy as np

from ...feature_extraction_sequence_utils import SequenceFeatureExtractor
from ...feature_extraction_utils import BatchFeature
from ...utils import PaddingStrategy, TensorType, logging


_lowerCAmelCase						:   Any		=   logging.get_logger(__name__)
class 			_UpperCamelCase      (				lowerCAmelCase		):
      UpperCAmelCase_        =		["""input_values""", """padding_mask"""]
      def __init__(			self   :Dict ,      lowerCamelCase   :int = 1 ,      lowerCamelCase   :int = 2_4000 ,      lowerCamelCase   :float = 0.0 ,      lowerCamelCase   :float = None ,      lowerCamelCase   :float = None ,      **lowerCamelCase   :Optional[Any] ,      )     ->			str:
       super().__init__(feature_size=lowerCamelCase ,      sampling_rate=lowerCamelCase ,      padding_value=lowerCamelCase ,      **lowerCamelCase      )
       UpperCAmelCase__							 =						chunk_length_s
       UpperCAmelCase__							 =						overlap
      @property
      def 	UpperCAmelCase_						(			self   :Optional[Any]      )     ->			Optional[int]:
       if self.chunk_length_s is None:
        return None
       else:
        return int(self.chunk_length_s * self.sampling_rate      )
      @property
      def 	UpperCAmelCase_						(			self   :str      )     ->			Optional[int]:
       if self.chunk_length_s is None or self.overlap is None:
        return None
       else:
        return max(1 ,      int((1.0 - self.overlap) * self.chunk_length      )      )







      def __call__(			self   :List[Any] ,      lowerCamelCase   :Union[np.ndarray, List[float], List[np.ndarray], List[List[float]]] ,      lowerCamelCase   :Optional[Union[bool, str, PaddingStrategy]] = None ,      lowerCamelCase   :Optional[bool] = False ,      lowerCamelCase   :Optional[int] = None ,      lowerCamelCase   :Optional[Union[str, TensorType]] = None ,      lowerCamelCase   :Optional[int] = None ,      )     ->			BatchFeature:
       if sampling_rate is not None:
        if sampling_rate != self.sampling_rate:
         raise ValueError(
             f'''The model corresponding to this feature extractor: {self} was trained using a sampling rate of'''
             f''' {self.sampling_rate}. Please make sure that the provided audio input was sampled with'''
             f''' {self.sampling_rate} and not {sampling_rate}.'''      )
       else:
        logger.warning(
            "It is strongly recommended to pass the `sampling_rate` argument to this function. "
            "Failing to do so can result in silent errors that might be hard to debug."      )

       if padding and truncation:
        raise ValueError("Both padding and truncation were set. Make sure you only set one."      )
       elif padding is None:
        # by default let's pad the inputs
        UpperCAmelCase__							 =						True

       UpperCAmelCase__							 =						bool(
           isinstance(lowerCamelCase ,      (list, tuple)      ) and (isinstance(raw_audio[0] ,      (np.ndarray, tuple, list)      ))      )

       if is_batched:
        UpperCAmelCase__							 =						[np.asarray(lowerCamelCase ,      dtype=np.floataa      ).T for audio in raw_audio]
       elif not is_batched and not isinstance(lowerCamelCase ,      np.ndarray      ):
        UpperCAmelCase__							 =						np.asarray(lowerCamelCase ,      dtype=np.floataa      )
       elif isinstance(lowerCamelCase ,      np.ndarray      ) and raw_audio.dtype is np.dtype(np.floataa      ):
        UpperCAmelCase__							 =						raw_audio.astype(np.floataa      )

       # always return batch
       if not is_batched:
        UpperCAmelCase__							 =						[np.asarray(lowerCamelCase      ).T]

       # verify inputs are valid
       for idx, example in enumerate(lowerCamelCase      ):
        if example.ndim > 2:
         raise ValueError(f'''Expected input shape (channels, length) but got shape {example.shape}'''      )
        if self.feature_size == 1 and example.ndim != 1:
         raise ValueError(f'''Expected mono audio but example has {example.shape[-1]} channels'''      )
        if self.feature_size == 2 and example.shape[-1] != 2:
         raise ValueError(f'''Expected stereo audio but example has {example.shape[-1]} channels'''      )

       UpperCAmelCase__							 =						None
       UpperCAmelCase__							 =						BatchFeature({"input_values": raw_audio}      )
       if self.chunk_stride is not None and self.chunk_length is not None and max_length is None:
        if truncation:
         UpperCAmelCase__							 =						min(array.shape[0] for array in raw_audio      )
         UpperCAmelCase__							 =						int(np.floor(max_length / self.chunk_stride      )      )
         UpperCAmelCase__							 =						(nb_step - 1) * self.chunk_stride + self.chunk_length
        elif padding:
         UpperCAmelCase__							 =						max(array.shape[0] for array in raw_audio      )
         UpperCAmelCase__							 =						int(np.ceil(max_length / self.chunk_stride      )      )
         UpperCAmelCase__							 =						(nb_step - 1) * self.chunk_stride + self.chunk_length
         UpperCAmelCase__							 =						"max_length"
        else:
         UpperCAmelCase__							 =						input_values

        # normal padding on batch
       if padded_inputs is None:
        UpperCAmelCase__							 =						self.pad(
            lowerCamelCase ,      max_length=lowerCamelCase ,      truncation=lowerCamelCase ,      padding=lowerCamelCase ,      return_attention_mask=lowerCamelCase ,      )
        if padding:
         UpperCAmelCase__							 =						padded_inputs.pop("attention_mask"      )

       UpperCAmelCase__							 =						[]
       for example in padded_inputs.pop("input_values"      ):
        if self.feature_size == 1:
         UpperCAmelCase__							 =						example[..., None]
        input_values.append(example.T      )

       UpperCAmelCase__							 =						input_values
       if return_tensors is not None:
        UpperCAmelCase__							 =						padded_inputs.convert_to_tensors(lowerCamelCase      )

       return padded_inputs





