



'''simple docstring'''


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

import os
from pathlib import Path







def 				__lowerCamelCase				(   A__    ,						A__    ,						A__    ,						A__    )       ->	Union[str, Any]:






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

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

   UpperCamelCase					=  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=A__    ,						exist_ok=A__    )
   UpperCamelCase					=  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	:       str      	=	Path(__file__).resolve().parent.parent.parent
_lowerCamelCase	:       Tuple      	=	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"]:
   _lowerCamelCase	:       Any      	=	model_cards_dir / "allenai" / model_name
   write_model_card(model_card_dir, src_lang="en", tgt_lang="de", model_name=model_name)






'''simple docstring'''


from dataclasses import dataclass
from typing import Optional, Tuple, Union

import numpy as np
import torch

from ..configuration_utils import ConfigMixin, register_to_config
from ..utils import BaseOutput, randn_tensor
from .scheduling_utils import SchedulerMixin

@dataclass
class  SCREAMING_SNAKE_CASE (  _a		):






    """simple docstring"""





    _SCREAMING_SNAKE_CASE	  =  42
    _SCREAMING_SNAKE_CASE	  =  42
    _SCREAMING_SNAKE_CASE	  =  None

class  SCREAMING_SNAKE_CASE (  _a   ,						_a		):






    """simple docstring"""





    _SCREAMING_SNAKE_CASE	  =  2






    @register_to_config
    def __init__(  self      :					Union[str, Any]  ,						UpperCamelCase__      :					float = 0.0_2  ,						UpperCamelCase__      :					float = 1_0_0  ,						UpperCamelCase__      :					float = 1.0_0_7  ,						UpperCamelCase__      :					float = 8_0  ,						UpperCamelCase__      :					float = 0.0_5  ,						UpperCamelCase__      :					float = 5_0  ,						):


       """simple docstring"""







       UpperCamelCase					=  sigma_max

       # setable values
       UpperCamelCase					=  None
       UpperCamelCase					=  None
       UpperCamelCase					=  None  # sigma(t_i)






    def  A       (  self      :					str  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					Optional[int] = None ):


       """simple docstring"""







       return sample






    def  A       (  self      :					Union[str, Any]  ,						UpperCamelCase__      :					int  ,						UpperCamelCase__      :					Union[str, torch.device] = None ):


       """simple docstring"""







       UpperCamelCase					=  num_inference_steps
       UpperCamelCase					=  np.arange(0  ,						self.num_inference_steps )[::-1].copy()
       UpperCamelCase					=  torch.from_numpy(UpperCamelCase__ ).to(UpperCamelCase__ )
       UpperCamelCase					=  [
           (
               self.config.sigma_max**2
               * (self.config.sigma_min**2 / self.config.sigma_max**2) ** (i / (num_inference_steps - 1))
           )
           for i in self.timesteps
       ]
       UpperCamelCase					=  torch.tensor(UpperCamelCase__  ,						dtype=torch.floataa  ,						device=UpperCamelCase__ )






    def  A       (  self      :					Dict  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					float  ,						UpperCamelCase__      :					Optional[torch.Generator] = None ):


       """simple docstring"""







       if self.config.s_min <= sigma <= self.config.s_max:
          UpperCamelCase					=  min(self.config.s_churn / self.num_inference_steps  ,						2**0.5 - 1 )
       else:
          UpperCamelCase					=  0

       # sample eps ~ N(0, S_noise^2 * I)
       UpperCamelCase					=  self.config.s_noise * randn_tensor(sample.shape  ,						generator=UpperCamelCase__ ).to(sample.device )
       UpperCamelCase					=  sigma + gamma * sigma
       UpperCamelCase					=  sample + ((sigma_hat**2 - sigma**2) ** 0.5 * eps)

       return sample_hat, sigma_hat






    def  A       (  self      :					str  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					float  ,						UpperCamelCase__      :					float  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					bool = True  ,						):


       """simple docstring"""







       UpperCamelCase					=  sample_hat + sigma_hat * model_output
       UpperCamelCase					=  (sample_hat - pred_original_sample) / sigma_hat
       UpperCamelCase					=  sample_hat + (sigma_prev - sigma_hat) * derivative

       if not return_dict:
          return (sample_prev, derivative)

       return KarrasVeOutput(
           prev_sample=UpperCamelCase__  ,						derivative=UpperCamelCase__  ,						pred_original_sample=UpperCamelCase__ )






    def  A       (  self      :					List[Any]  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					float  ,						UpperCamelCase__      :					float  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					torch.FloatTensor  ,						UpperCamelCase__      :					bool = True  ,						):


       """simple docstring"""







       UpperCamelCase					=  sample_prev + sigma_prev * model_output
       UpperCamelCase					=  (sample_prev - pred_original_sample) / sigma_prev
       UpperCamelCase					=  sample_hat + (sigma_prev - sigma_hat) * (0.5 * derivative + 0.5 * derivative_corr)

       if not return_dict:
          return (sample_prev, derivative)

       return KarrasVeOutput(
           prev_sample=UpperCamelCase__  ,						derivative=UpperCamelCase__  ,						pred_original_sample=UpperCamelCase__ )






    def  A       (  self      :					Optional[Any]  ,						UpperCamelCase__      :					str  ,						UpperCamelCase__      :					int  ,						UpperCamelCase__      :					str ):


       """simple docstring"""







       raise NotImplementedError()

