


"""simple docstring"""







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

import os
from pathlib import Path




def      UpperCAmelCase__ (lowerCAmelCase_						,		lowerCAmelCase_						,		lowerCAmelCase_     ):




					'''simple docstring'''


					__SCREAMING_SNAKE_CASE		     =       {
					    "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		     =       {
					    "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		     =       f"""{src_lang}-{tgt_lang}"""

					__SCREAMING_SNAKE_CASE		     =       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_     )
					__SCREAMING_SNAKE_CASE		     =       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
a__       :							str        =  Path(__file__).resolve().parent.parent.parent
a__       :							int        =  repo_dir / '''model_cards'''

for model_name in ["wmt19-ru-en", "wmt19-en-ru", "wmt19-en-de", "wmt19-de-en"]:
		a__    ,  a__    ,  a__       :							Optional[Any]        =  model_name.split('''-''')
		a__       :							Union[str, Any]        =  model_cards_dir / '''facebook''' / model_name
		write_model_card(model_card_dir, src_lang=src_lang, tgt_lang=tgt_lang)




"""simple docstring"""







import csv
from collections import defaultdict
from dataclasses import dataclass, field
from typing import List, Optional

import matplotlib.pyplot as plt
import numpy as np
from matplotlib.ticker import ScalarFormatter

from transformers import HfArgumentParser




def      UpperCAmelCase__ (lowerCAmelCase_=None						,		lowerCAmelCase_=None     ):




					'''simple docstring'''


					return field(default_factory=lambda: default						,		metadata=lowerCAmelCase_     )




@dataclass
class 				UpperCamelCase_			:

	"""simple docstring"""





	snake_case__       :						str					      =    field(
	    metadata={"help": "The csv file to plot."}    ,						)
	snake_case__       :						bool					      =    field(
	    default=UpperCamelCase    ,						metadata={"help": "Whether to plot along batch size or sequence length. Defaults to sequence length."}    ,						)
	snake_case__       :						bool					      =    field(
	    default=UpperCamelCase    ,						metadata={"help": "Whether the csv file has time results or memory results. Defaults to memory results."}    ,						)
	snake_case__       :						bool					      =    field(
	    default=UpperCamelCase    ,						metadata={"help": "Disable logarithmic scale when plotting"}    ,						)
	snake_case__       :						bool					      =    field(
	    default=UpperCamelCase    ,						metadata={
	        "help": "Whether the csv file has training results or inference results. Defaults to inference results."
	    }    ,						)
	snake_case__       :						Optional[str]					      =    field(
	    default=UpperCamelCase    ,						metadata={"help": "Filename under which the plot will be saved. If unused no plot is saved."}    ,						)
	snake_case__       :						Optional[List[str]]					      =    list_field(
	    default=UpperCamelCase    ,						metadata={"help": "List of model names that are used instead of the ones in the csv file."})




def      UpperCAmelCase__ (lowerCAmelCase_     ):




					'''simple docstring'''


					try:
										int(lowerCAmelCase_     )
										return True
					except ValueError:
										return False




def      UpperCAmelCase__ (lowerCAmelCase_     ):




					'''simple docstring'''


					try:
										float(lowerCAmelCase_     )
										return True
					except ValueError:
										return False




class 				UpperCamelCase_			:

	"""simple docstring"""





	def __init__(				self    :       str    ,    UpperCAmelCase__    :       Dict     ) ->			Optional[Any]:
						__SCREAMING_SNAKE_CASE		     =       args
						__SCREAMING_SNAKE_CASE		     =       defaultdict(lambda: {"bsz": [], "seq_len": [], "result": {}}     )

						with open(self.args.csv_file    ,    newline=""     ) as csv_file:
											__SCREAMING_SNAKE_CASE		     =       csv.DictReader(UpperCAmelCase__     )
											for row in reader:
																__SCREAMING_SNAKE_CASE		     =       row["model"]
																self.result_dict[model_name]["bsz"].append(int(row["batch_size"]     )     )
																self.result_dict[model_name]["seq_len"].append(int(row["sequence_length"]     )     )
																if can_convert_to_int(row["result"]     ):
																					# value is not None
																					__SCREAMING_SNAKE_CASE		     =       int(row["result"]     )
																elif can_convert_to_float(row["result"]     ):
																					# value is not None
																					__SCREAMING_SNAKE_CASE		     =       float(row["result"]     )




	def 						UpperCAmelCase_   (				self    :       List[str]     ) ->			Tuple:
						__SCREAMING_SNAKE_CASE     ,						__SCREAMING_SNAKE_CASE		     =       plt.subplots()
						__SCREAMING_SNAKE_CASE		     =       "Time usage" if self.args.is_time else "Memory usage"
						__SCREAMING_SNAKE_CASE		     =       title_str + " for training" if self.args.is_train else title_str + " for inference"

						if not self.args.no_log_scale:
											# set logarithm scales
											ax.set_xscale("log"     )
											ax.set_yscale("log"     )

						for axis in [ax.xaxis, ax.yaxis]:
											axis.set_major_formatter(ScalarFormatter()     )

						for model_name_idx, model_name in enumerate(self.result_dict.keys()     ):
											__SCREAMING_SNAKE_CASE		     =       sorted(set(self.result_dict[model_name]["bsz"]     )     )
											__SCREAMING_SNAKE_CASE		     =       sorted(set(self.result_dict[model_name]["seq_len"]     )     )
											__SCREAMING_SNAKE_CASE		     =       self.result_dict[model_name]["result"]

											((__SCREAMING_SNAKE_CASE)     ,						(__SCREAMING_SNAKE_CASE))		     =       (
											    (batch_sizes, sequence_lengths) if self.args.plot_along_batch else (sequence_lengths, batch_sizes)
											)

											__SCREAMING_SNAKE_CASE		     =       (
											    model_name if self.args.short_model_names is None else self.args.short_model_names[model_name_idx]
											)

											for inner_loop_value in inner_loop_array:
																if self.args.plot_along_batch:
																					__SCREAMING_SNAKE_CASE		     =       np.asarray(
																					    [results[(x, inner_loop_value)] for x in x_axis_array if (x, inner_loop_value) in results]    ,    dtype=UpperCAmelCase__    ,    )
																else:
																					__SCREAMING_SNAKE_CASE		     =       np.asarray(
																					    [results[(inner_loop_value, x)] for x in x_axis_array if (inner_loop_value, x) in results]    ,    dtype=np.floataa    ,    )

																((__SCREAMING_SNAKE_CASE)     ,						(__SCREAMING_SNAKE_CASE))		     =       (
																    ("batch_size", "len") if self.args.plot_along_batch else ("in #tokens", "bsz")
																)

																__SCREAMING_SNAKE_CASE		     =       np.asarray(UpperCAmelCase__    ,    UpperCAmelCase__     )[: len(UpperCAmelCase__     )]
																plt.scatter(
																    UpperCAmelCase__    ,    UpperCAmelCase__    ,    label=F"""{label_model_name} - {inner_loop_label}: {inner_loop_value}"""     )
																plt.plot(UpperCAmelCase__    ,    UpperCAmelCase__    ,    "--"     )

											title_str += F""" {label_model_name} vs."""

						__SCREAMING_SNAKE_CASE		     =       title_str[:-4]
						__SCREAMING_SNAKE_CASE		     =       "Time in s" if self.args.is_time else "Memory in MB"

						# plot
						plt.title(UpperCAmelCase__     )
						plt.xlabel(UpperCAmelCase__     )
						plt.ylabel(UpperCAmelCase__     )
						plt.legend()

						if self.args.figure_png_file is not None:
											plt.savefig(self.args.figure_png_file     )
						else:
											plt.show()




def      UpperCAmelCase__ ():




					'''simple docstring'''


					__SCREAMING_SNAKE_CASE		     =       HfArgumentParser(lowerCAmelCase_     )
					__SCREAMING_SNAKE_CASE		     =       parser.parse_args_into_dataclasses()[0]
					__SCREAMING_SNAKE_CASE		     =       Plot(args=lowerCAmelCase_     )
					plot.plot()


if __name__ == "__main__":
		main()
