





"""simple docstring"""


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

import os
from pathlib import Path

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

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

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


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

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




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


_lowerCAmelCase       =		logging.get_logger(__name__)

_lowerCAmelCase       =		{
    "microsoft/trocr-base-handwritten": (
        "https://huggingface.co/microsoft/trocr-base-handwritten/resolve/main/config.json"
    ),
    # See all TrOCR models at https://huggingface.co/models?filter=trocr
}
class     lowerCAmelCase_     (       __lowercase ):
							UpperCAmelCase				   =     "trocr"
							UpperCAmelCase				   =     ["past_key_values"]
							UpperCAmelCase				   =     {
							    "num_attention_heads": "decoder_attention_heads",
							    "hidden_size": "d_model",
							    "num_hidden_layers": "decoder_layers",
							}







							def __init__(   self      :     List[str] ,			_A      :     Optional[Any]=5_0265 ,			_A      :     Optional[Any]=1024 ,			_A      :     Optional[Any]=12 ,			_A      :     Any=16 ,			_A      :     Any=4096 ,			_A      :     Optional[Any]="gelu" ,			_A      :     Union[str, Any]=512 ,			_A      :     Dict=0.1 ,			_A      :     List[str]=0.0 ,			_A      :     Optional[Any]=0.0 ,			_A      :     Union[str, Any]=2 ,			_A      :     Any=0.02 ,			_A      :     List[str]=0.0 ,			_A      :     List[str]=True ,			_A      :     str=False ,			_A      :     List[str]=True ,			_A      :     Optional[Any]=True ,			_A      :     Optional[int]=1 ,			_A      :     int=0 ,			_A      :     Any=2 ,			**_A      :     Optional[int] ,			):
												_UpperCamelCase			     =     vocab_size
												_UpperCamelCase			     =     d_model
												_UpperCamelCase			     =     decoder_layers
												_UpperCamelCase			     =     decoder_attention_heads
												_UpperCamelCase			     =     decoder_ffn_dim
												_UpperCamelCase			     =     activation_function
												_UpperCamelCase			     =     max_position_embeddings
												_UpperCamelCase			     =     dropout
												_UpperCamelCase			     =     attention_dropout
												_UpperCamelCase			     =     activation_dropout
												_UpperCamelCase			     =     init_std
												_UpperCamelCase			     =     decoder_layerdrop
												_UpperCamelCase			     =     use_cache
												_UpperCamelCase			     =     scale_embedding
												_UpperCamelCase			     =     use_learned_position_embeddings
												_UpperCamelCase			     =     layernorm_embedding

												super().__init__(
												    pad_token_id=_A ,			bos_token_id=_A ,			eos_token_id=_A ,			decoder_start_token_id=_A ,			**_A ,			)
