





"""simple docstring"""
# Usage:
# ./gen-card-facebook-wmt19.py

import os
from pathlib import Path



def 					__lowerCamelCase       (							a_					:		str			,       a_					:		Tuple			,       a_					:		Optional[int]							)      ->				int:
      __SCREAMING_SNAKE_CASE       :Optional[int]		    =  {
          '''en''': '''Machine learning is great, isn\'t it?''',
          '''ru''': '''Машинное обучение - это здорово, не так ли?''',
          '''de''': '''Maschinelles Lernen ist großartig, oder?''',
      }

      # BLUE scores as follows:
      # "pair": [fairseq, transformers]
      __SCREAMING_SNAKE_CASE       :Dict		    =  {
          '''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'''],
      }
      __SCREAMING_SNAKE_CASE       :str		    =  f'''{src_lang}-{tgt_lang}'''

      __SCREAMING_SNAKE_CASE       :str		    =  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(a_			,       exist_ok=a_							)
      __SCREAMING_SNAKE_CASE       :Optional[int]		    =  os.path.join(a_			,       '''README.md'''							)
      print(f'''Generating {path}'''							)
      with open(a_			,       '''w'''			,       encoding='''utf-8'''							) as f:
            f.write(a_							)


# make sure we are under the root of the project
lowerCamelCase_       =		Path(__file__).resolve().parent.parent.parent
lowerCamelCase_       =		repo_dir / "model_cards"

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






"""simple docstring"""
from typing import Callable, Optional, Union

from ...configuration_utils import PretrainedConfig
from ...utils import logging


lowerCamelCase_       =		logging.get_logger(__name__)

lowerCamelCase_       =		{
    "microsoft/xprophetnet-large-wiki100-cased": (
        "https://huggingface.co/microsoft/xprophetnet-large-wiki100-cased/resolve/main/config.json"
    ),
}






class  _SCREAMING_SNAKE_CASE(       A  ):
       SCREAMING_SNAKE_CASE_       :				Optional[Any]     						=  '''xlm-prophetnet'''
       SCREAMING_SNAKE_CASE_       :				Any     						=  ['''past_key_values''']
       SCREAMING_SNAKE_CASE_       :				Optional[Any]     						=  {
           '''num_attention_heads''': '''num_encoder_attention_heads''',
       }




       def __init__(						self		,SCREAMING_SNAKE_CASE__ = 0.1		,SCREAMING_SNAKE_CASE__ = "gelu"		,SCREAMING_SNAKE_CASE__ = 3_05_22		,SCREAMING_SNAKE_CASE__ = 10_24		,SCREAMING_SNAKE_CASE__ = 40_96		,SCREAMING_SNAKE_CASE__ = 12		,SCREAMING_SNAKE_CASE__ = 16		,SCREAMING_SNAKE_CASE__ = 40_96		,SCREAMING_SNAKE_CASE__ = 12		,SCREAMING_SNAKE_CASE__ = 16		,SCREAMING_SNAKE_CASE__ = 0.1		,SCREAMING_SNAKE_CASE__ = 0.1		,SCREAMING_SNAKE_CASE__ = 5_12		,SCREAMING_SNAKE_CASE__ = 0.0_2		,SCREAMING_SNAKE_CASE__ = True		,SCREAMING_SNAKE_CASE__ = True		,SCREAMING_SNAKE_CASE__ = 0		,SCREAMING_SNAKE_CASE__ = 2		,SCREAMING_SNAKE_CASE__ = 32		,SCREAMING_SNAKE_CASE__ = 1_28		,SCREAMING_SNAKE_CASE__ = False		,SCREAMING_SNAKE_CASE__ = 0.0		,SCREAMING_SNAKE_CASE__ = True		,SCREAMING_SNAKE_CASE__ = 0		,SCREAMING_SNAKE_CASE__ = 1		,SCREAMING_SNAKE_CASE__ = 2		,**SCREAMING_SNAKE_CASE__		,)      ->				Dict:





             """simple docstring"""






             __SCREAMING_SNAKE_CASE       :int		    =  vocab_size
             __SCREAMING_SNAKE_CASE       :Tuple		    =  hidden_size
             __SCREAMING_SNAKE_CASE       :Optional[int]		    =  encoder_ffn_dim
             __SCREAMING_SNAKE_CASE       :Optional[int]		    =  num_encoder_layers
             __SCREAMING_SNAKE_CASE       :Tuple		    =  num_encoder_attention_heads
             __SCREAMING_SNAKE_CASE       :List[Any]		    =  decoder_ffn_dim
             __SCREAMING_SNAKE_CASE       :Union[str, Any]		    =  num_decoder_layers
             __SCREAMING_SNAKE_CASE       :Optional[Any]		    =  num_decoder_attention_heads
             __SCREAMING_SNAKE_CASE       :List[str]		    =  max_position_embeddings
             __SCREAMING_SNAKE_CASE       :Dict		    =  init_std  # Normal(0, this parameter)
             __SCREAMING_SNAKE_CASE       :List[Any]		    =  activation_function

             # parameters for xlmprophetnet
             __SCREAMING_SNAKE_CASE       :Tuple		    =  ngram
             __SCREAMING_SNAKE_CASE       :int		    =  num_buckets
             __SCREAMING_SNAKE_CASE       :Optional[int]		    =  relative_max_distance
             __SCREAMING_SNAKE_CASE       :Union[str, Any]		    =  disable_ngram_loss
             __SCREAMING_SNAKE_CASE       :Dict		    =  eps

             # 3 Types of Dropout
             __SCREAMING_SNAKE_CASE       :List[str]		    =  attention_dropout
             __SCREAMING_SNAKE_CASE       :Dict		    =  activation_dropout
             __SCREAMING_SNAKE_CASE       :Union[str, Any]		    =  dropout

             __SCREAMING_SNAKE_CASE       :int		    =  use_cache

             super().__init__(
                 pad_token_id=SCREAMING_SNAKE_CASE__		,bos_token_id=SCREAMING_SNAKE_CASE__		,eos_token_id=SCREAMING_SNAKE_CASE__		,is_encoder_decoder=SCREAMING_SNAKE_CASE__		,add_cross_attention=SCREAMING_SNAKE_CASE__		,decoder_start_token_id=SCREAMING_SNAKE_CASE__		,**SCREAMING_SNAKE_CASE__		,)




       @property
       def    _UpperCamelCase					(						self							)      ->				int:





             """simple docstring"""






             return self.num_encoder_layers + self.num_decoder_layers




       @num_hidden_layers.setter
       def    _UpperCamelCase					(						self		,SCREAMING_SNAKE_CASE__							)      ->				Optional[int]:





             """simple docstring"""






             raise NotImplementedError(
                 '''This model does not support the setting of `num_hidden_layers`. Please set `num_encoder_layers` and'''
                 ''' `num_decoder_layers`.'''							)