

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

import os
from pathlib import Path







def 						_snake_case		(     SCREAMING_SNAKE_CASE		,				SCREAMING_SNAKE_CASE		,				SCREAMING_SNAKE_CASE		,				SCREAMING_SNAKE_CASE					)							->   Any:

     """simple docstring"""







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

     # BLUE scores as follows:
     # "pair": [fairseq, transformers]
     _lowerCAmelCase :       int	   =     {
         "wmt19-de-en-6-6-base": [0, 38.37],
         "wmt19-de-en-6-6-big": [0, 39.90],
     }
     _lowerCAmelCase :       Optional[int]	   =     f'''{src_lang}-{tgt_lang}'''

     _lowerCAmelCase :       Optional[Any]	   =     f'''
---

language:
- {src_lang}
- {tgt_lang}
thumbnail:
tags:
- translation
- wmt19
- allenai
license: apache-2.0
datasets:
- wmt19
metrics:
- bleu
---

# FSMT

## Model description

This is a ported version of fairseq-based [wmt19 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).

2 models are available:

* [wmt19-de-en-6-6-big](https://huggingface.co/allenai/wmt19-de-en-6-6-big)
* [wmt19-de-en-6-6-base](https://huggingface.co/allenai/wmt19-de-en-6-6-base)


## 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   |  transformers
-------|---------
{model_name}  |  {scores[model_name][1]}

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 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 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/wmt19/)
- [test set](http://matrix.statmt.org/test_sets/newstest2019.tgz?1556572561)


### 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=SCREAMING_SNAKE_CASE		,				exist_ok=SCREAMING_SNAKE_CASE					)
     _lowerCAmelCase :       int	   =     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
__UpperCAmelCase     					=  Path(__file__).resolve().parent.parent.parent
__UpperCAmelCase     					=  repo_dir / 'model_cards'

for model_name in ["wmt19-de-en-6-6-base", "wmt19-de-en-6-6-big"]:
  __UpperCAmelCase     					=  model_cards_dir / 'allenai' / model_name
  write_model_card(model_card_dir, src_lang='de', tgt_lang='en', model_name=model_name)









import argparse
import itertools
import operator
import sys
from collections import OrderedDict

from run_eval import datetime_now, run_generate

from utils import ROUGE_KEYS


# A table of supported tasks and the list of scores in the order of importance to be sorted by.
# To add a new task, simply list the score names that `run_eval.run_generate()` returns
__UpperCAmelCase     					=  {
    'translation': ['bleu'],
    'summarization': ROUGE_KEYS,
}







def 						_snake_case		(     SCREAMING_SNAKE_CASE					)							->   Optional[Any]:

     """simple docstring"""







     _lowerCAmelCase :       Dict	   =     search.split()
     _lowerCAmelCase :       int	   =     dict((g.split("="					) for g in groups)					)
     _lowerCAmelCase :       Dict	   =     list(entries.keys()					)
     _lowerCAmelCase :       Tuple	   =     [[f'''--{k} {v}''' for v in vs.split(":"					)] for k, vs in entries.items()]
     _lowerCAmelCase :       Dict	   =     [list(SCREAMING_SNAKE_CASE					) for x in itertools.product(*SCREAMING_SNAKE_CASE					)]
     return matrix, entry_names







def 						_snake_case		(     )							->   Tuple:

     """simple docstring"""







     _lowerCAmelCase :       List[str]	   =     sys.argv[0]

     _lowerCAmelCase :       Any	   =     argparse.ArgumentParser(
         usage=(
             "\n\nImportant: this script accepts all arguments `run_eval.py` accepts and then a few extra, therefore"
             " refer to `run_eval.py -h` for the complete list."
         )					)
     parser.add_argument(
         "--search"		,				type=SCREAMING_SNAKE_CASE		,				required=SCREAMING_SNAKE_CASE		,				help="param space to search, e.g. \"num_beams=5:10 length_penalty=0.8:1.0:1.2\""		,				)
     parser.add_argument(
         "--bs"		,				type=SCREAMING_SNAKE_CASE		,				default=8		,				required=SCREAMING_SNAKE_CASE		,				help="initial batch size (may get reduced if it's too big)"					)
     parser.add_argument("--task"		,				type=SCREAMING_SNAKE_CASE		,				help="used for task_specific_params + metrics"					)
     parser.add_argument(
         "--info"		,				nargs="?"		,				type=SCREAMING_SNAKE_CASE		,				const=datetime_now()		,				help=(
             "add custom notes to be printed before the results table. If no value is passed, the current datetime"
             " string will be used."
         )		,				)
     _lowerCAmelCase   ,      _lowerCAmelCase :       List[str]	   =     parser.parse_known_args()
     # we share some of the args
     args_main.extend(["--task", args.task]					)
     _lowerCAmelCase :       str	   =     [prog] + args_main

     # to support variations like translation_en_to_de"
     _lowerCAmelCase :       Any	   =     "translation" if "translation" in args.task else "summarization"

     _lowerCAmelCase   ,      _lowerCAmelCase :       int	   =     parse_search_arg(args.search					)
     _lowerCAmelCase :       Optional[Any]	   =     task_score_names[task]  # score cols first
     _lowerCAmelCase :       int	   =     {col: len(str(SCREAMING_SNAKE_CASE					)					) for col in col_names}
     _lowerCAmelCase :       Optional[int]	   =     []
     for r in matrix:
          _lowerCAmelCase :       List[str]	   =     dict((x.replace("--"		,				""					).split() for x in r)					)
          _lowerCAmelCase :       Any	   =     " ".join(SCREAMING_SNAKE_CASE					).split()
          args_exp.extend(["--bs", str(args.bs					)]					)  # in case we need to reduce its size due to CUDA OOM
          _lowerCAmelCase :       List[str]	   =     args_normal + args_exp

          # XXX: need to trap CUDA OOM and lower args.bs if that happens and retry

          _lowerCAmelCase :       Any	   =     run_generate(verbose=SCREAMING_SNAKE_CASE					)
          # make sure scores are first in the table
          _lowerCAmelCase :       Any	   =     OrderedDict()
          for score in task_score_names[task]:
               _lowerCAmelCase :       Dict	   =     scores[score]
          result.update(SCREAMING_SNAKE_CASE					)
          results.append(SCREAMING_SNAKE_CASE					)

          # find widest entries
          for k, v in result.items():
               _lowerCAmelCase :       Any	   =     len(str(SCREAMING_SNAKE_CASE					)					)
               if l > col_widths[k]:
                    _lowerCAmelCase :       str	   =     l

     _lowerCAmelCase :       Optional[Any]	   =     sorted(SCREAMING_SNAKE_CASE		,				key=operator.itemgetter(*task_score_names[task]					)		,				reverse=SCREAMING_SNAKE_CASE					)
     print(" | ".join([f'''{col:{col_widths[col]}}''' for col in col_names]					)					)
     print(" | ".join([f'''{'-'*col_widths[col]}''' for col in col_names]					)					)
     for row in results_sorted:
          print(" | ".join([f'''{row[col]:{col_widths[col]}}''' for col in col_names]					)					)

     _lowerCAmelCase :       Optional[int]	   =     results_sorted[0]
     for score in task_score_names[task]:
          del best[score]
     _lowerCAmelCase :       Tuple	   =     [f'''--{k} {v}''' for k, v in best.items()]
     _lowerCAmelCase :       Union[str, Any]	   =     ["--bs", str(args.bs					)]
     if args.info:
          print(f'''\nInfo: {args.info}'''					)
     print("\nBest score args:"					)
     print(" ".join(args_main + best_args + dyn_args					)					)

     return results_sorted


if __name__ == "__main__":
  # Usage:
  # [normal-run_eval_search.py cmd plus] \
  # --search="num_beams=1:5:10 length_penalty=0.8:1:1.2 early_stopping=true:false"
  #
  # Example:
  # PYTHONPATH="src:examples/seq2seq" python examples/seq2seq/run_eval_search.py $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 \
  # --search="num_beams=1:5:10 length_penalty=0.8:1:1.2 early_stopping=true:false"
  run_search()






