




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

import os
from pathlib import Path




def  a_		(							__snake_case     ,		__snake_case     ,		__snake_case     ,		__snake_case					)	->			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_     				= {
			    'wmt19-de-en-6-6-base': [0, 38.37],
			    'wmt19-de-en-6-6-big': [0, 39.90],
			}
			UpperCamelCase_     				= F'''{src_lang}-{tgt_lang}'''

			UpperCamelCase_     				= 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_					)
			UpperCamelCase_     				= 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
__a			:	Union[str, Any]							     =		Path(__file__).resolve().parent.parent.parent
__a			:	Tuple							     =		repo_dir / """model_cards"""

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


from typing import Any

import numpy as np
def 					lowerCAmelCase__     (    SCREAMING_SNAKE_CASE_	)							->						bool:
			assert np.shape(SCREAMING_SNAKE_CASE_	)[0] == np.shape(SCREAMING_SNAKE_CASE_	)[1]

			# If matrix not symmetric, exit right away.
			if np.allclose(SCREAMING_SNAKE_CASE_			,				matrix.T	) is False:
						return False

			# Get eigenvalues and eignevectors for a symmetric matrix.
			lowerCAmelCase__ ,							lowerCAmelCase__ : Optional[int]   =						np.linalg.eigh(SCREAMING_SNAKE_CASE_	)

			# Check sign of all eigenvalues.
			# np.all returns a value of type np.bool_
			return bool(np.all(eigen_values > 0	)	)
def 					lowerCAmelCase__     (    SCREAMING_SNAKE_CASE_	)							->						Any:
			lowerCAmelCase__ : List[Any]   =						np.random.randn(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)
			lowerCAmelCase__ : Any   =						np.dot(SCREAMING_SNAKE_CASE_			,				random_matrix.T	)
			assert _is_matrix_spd(SCREAMING_SNAKE_CASE_	)
			return spd_matrix
def 					lowerCAmelCase__     (    SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_ = 1_000			,				SCREAMING_SNAKE_CASE_ = 1e-8			,				)							->						Any:
			assert np.shape(SCREAMING_SNAKE_CASE_	)[0] == np.shape(SCREAMING_SNAKE_CASE_	)[1]
			assert np.shape(SCREAMING_SNAKE_CASE_	)[0] == np.shape(SCREAMING_SNAKE_CASE_	)[0]
			assert _is_matrix_spd(SCREAMING_SNAKE_CASE_	)

			# Initialize solution guess, residual, search direction.
			lowerCAmelCase__ : Optional[Any]   =						np.zeros((np.shape(SCREAMING_SNAKE_CASE_	)[0], 1)	)
			lowerCAmelCase__ : str   =						np.copy(SCREAMING_SNAKE_CASE_	)
			lowerCAmelCase__ : Dict   =						np.copy(SCREAMING_SNAKE_CASE_	)

			# Set initial errors in solution guess and residual.
			lowerCAmelCase__ : Union[str, Any]   =						1e9
			lowerCAmelCase__ : int   =						1e9
			lowerCAmelCase__ : Union[str, Any]   =						1e9

			# Set iteration counter to threshold number of iterations.
			lowerCAmelCase__ : List[str]   =						0

			while error > tol:
						# Save this value so we only calculate the matrix-vector product once.
						lowerCAmelCase__ : int   =						np.dot(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)

						# The main algorithm.

						# Update search direction magnitude.
						lowerCAmelCase__ : List[str]   =						np.dot(ra.T			,				SCREAMING_SNAKE_CASE_	) / np.dot(pa.T			,				SCREAMING_SNAKE_CASE_	)
						# Update solution guess.
						lowerCAmelCase__ : Dict   =						xa + alpha * pa
						# Calculate new residual.
						lowerCAmelCase__ : Tuple   =						ra - alpha * w
						# Calculate new Krylov subspace scale.
						lowerCAmelCase__ : str   =						np.dot(r.T			,				SCREAMING_SNAKE_CASE_	) / np.dot(ra.T			,				SCREAMING_SNAKE_CASE_	)
						# Calculate new A conjuage search direction.
						lowerCAmelCase__ : Dict   =						r + beta * pa

						# Calculate errors.
						lowerCAmelCase__ : List[str]   =						np.linalg.norm(r - ra	)
						lowerCAmelCase__ : Tuple   =						np.linalg.norm(x - xa	)
						lowerCAmelCase__ : str   =						np.maximum(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)

						# Update variables.
						lowerCAmelCase__ : List[Any]   =						np.copy(SCREAMING_SNAKE_CASE_	)
						lowerCAmelCase__ : Dict   =						np.copy(SCREAMING_SNAKE_CASE_	)
						lowerCAmelCase__ : str   =						np.copy(SCREAMING_SNAKE_CASE_	)

						# Update number of iterations.
						iterations += 1
						if iterations > max_iterations:
									break

			return x
def 					lowerCAmelCase__     (    )							->						None:
			lowerCAmelCase__ : Optional[Any]   =						3
			lowerCAmelCase__ : Optional[int]   =						_create_spd_matrix(SCREAMING_SNAKE_CASE_	)
			lowerCAmelCase__ : Tuple   =						np.random.randn(SCREAMING_SNAKE_CASE_			,				1	)
			lowerCAmelCase__ : int   =						np.dot(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)

			# Numpy solution.
			lowerCAmelCase__ : Optional[Any]   =						np.linalg.solve(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)

			# Our implementation.
			lowerCAmelCase__ : Optional[int]   =						conjugate_gradient(SCREAMING_SNAKE_CASE_			,				SCREAMING_SNAKE_CASE_	)

			# Ensure both solutions are close to x_true (and therefore one another).
			assert np.linalg.norm(x_numpy - x_true	) <= 1e-6
			assert np.linalg.norm(x_conjugate_gradient - x_true	) <= 1e-6


if __name__ == "__main__":
					import doctest

					doctest.testmod()
					test_conjugate_gradient()