





'''simple docstring'''







import importlib
from typing import List, Optional, Union

from seqeval.metrics import accuracy_score, classification_report

import datasets


snake_case_  :							Dict            =	'''\
@inproceedings{ramshaw-marcus-1995-text,
    title = "Text Chunking using Transformation-Based Learning",
    author = "Ramshaw, Lance  and
      Marcus, Mitch",
    booktitle = "Third Workshop on Very Large Corpora",
    year = "1995",
    url = "https://www.aclweb.org/anthology/W95-0107",
}
@misc{seqeval,
  title={{seqeval}: A Python framework for sequence labeling evaluation},
  url={https://github.com/chakki-works/seqeval},
  note={Software available from https://github.com/chakki-works/seqeval},
  author={Hiroki Nakayama},
  year={2018},
}
'''

snake_case_  :							Dict            =	'''\
seqeval is a Python framework for sequence labeling evaluation.
seqeval can evaluate the performance of chunking tasks such as named-entity recognition, part-of-speech tagging, semantic role labeling and so on.

This is well-tested by using the Perl script conlleval, which can be used for
measuring the performance of a system that has processed the CoNLL-2000 shared task data.

seqeval supports following formats:
IOB1
IOB2
IOE1
IOE2
IOBES

See the [README.md] file at https://github.com/chakki-works/seqeval for more information.
'''

snake_case_  :							str            =	'''
Produces labelling scores along with its sufficient statistics
from a source against one or more references.

Args:
    predictions: List of List of predicted labels (Estimated targets as returned by a tagger)
    references: List of List of reference labels (Ground truth (correct) target values)
    suffix: True if the IOB prefix is after type, False otherwise. default: False
    scheme: Specify target tagging scheme. Should be one of ["IOB1", "IOB2", "IOE1", "IOE2", "IOBES", "BILOU"].
        default: None
    mode: Whether to count correct entity labels with incorrect I/B tags as true positives or not.
        If you want to only count exact matches, pass mode="strict". default: None.
    sample_weight: Array-like of shape (n_samples,), weights for individual samples. default: None
    zero_division: Which value to substitute as a metric value when encountering zero division. Should be on of 0, 1,
        "warn". "warn" acts as 0, but the warning is raised.

Returns:
    \'scores\': dict. Summary of the scores for overall and per type
        Overall:
            \'accuracy\': accuracy,
            \'precision\': precision,
            \'recall\': recall,
            \'f1\': F1 score, also known as balanced F-score or F-measure,
        Per type:
            \'precision\': precision,
            \'recall\': recall,
            \'f1\': F1 score, also known as balanced F-score or F-measure
Examples:

    >>> predictions = [[\'O\', \'O\', \'B-MISC\', \'I-MISC\', \'I-MISC\', \'I-MISC\', \'O\'], [\'B-PER\', \'I-PER\', \'O\']]
    >>> references = [[\'O\', \'O\', \'O\', \'B-MISC\', \'I-MISC\', \'I-MISC\', \'O\'], [\'B-PER\', \'I-PER\', \'O\']]
    >>> seqeval = datasets.load_metric("seqeval")
    >>> results = seqeval.compute(predictions=predictions, references=references)
    >>> print(list(results.keys()))
    [\'MISC\', \'PER\', \'overall_precision\', \'overall_recall\', \'overall_f1\', \'overall_accuracy\']
    >>> print(results["overall_f1"])
    0.5
    >>> print(results["PER"]["f1"])
    1.0
'''


@datasets.utils.file_utils.add_start_docstrings(_DESCRIPTION							,		_KWARGS_DESCRIPTION  )
class        __a   (datasets.Metric  ):

							def      UpperCAmelCase__						(				self				:  int )       ->							List[str]:







													"""simple docstring"""
													return datasets.MetricInfo(
													    description=_DESCRIPTION							,  citation=_CITATION							,  homepage='''https://github.com/chakki-works/seqeval'''							,  inputs_description=_KWARGS_DESCRIPTION							,  features=datasets.Features(
													        {
													            '''predictions''': datasets.Sequence(datasets.Value('''string'''							,  id='''label''' )							,  id='''sequence''' ),
													            '''references''': datasets.Sequence(datasets.Value('''string'''							,  id='''label''' )							,  id='''sequence''' ),
													        } )							,  codebase_urls=['''https://github.com/chakki-works/seqeval''']							,  reference_urls=['''https://github.com/chakki-works/seqeval''']							,  )



							def      UpperCAmelCase__						(				self				:  Tuple							,  __magic_name__				:  Tuple							,  __magic_name__				:  Union[str, Any]							,  __magic_name__				:  Tuple = False							,  __magic_name__				:  int = None							,  __magic_name__				:  Tuple = None							,  __magic_name__				:  int = None							,  __magic_name__				:  List[str] = "warn"							,  )       ->							Optional[Any]:







													"""simple docstring"""
													if scheme is not None:
																			try:
																									UpperCAmelCase_      :   List[Any]      =	importlib.import_module('''seqeval.scheme''' )
																									UpperCAmelCase_      :   str      =	getattr(lowercase__							,  lowercase__ )
																			except AttributeError:
																									raise ValueError(F"""Scheme should be one of [IOB1, IOB2, IOE1, IOE2, IOBES, BILOU], got {scheme}""" )
													UpperCAmelCase_      :   List[str]      =	classification_report(
													    y_true=lowercase__							,  y_pred=lowercase__							,  suffix=lowercase__							,  output_dict=lowercase__							,  scheme=lowercase__							,  mode=lowercase__							,  sample_weight=lowercase__							,  zero_division=lowercase__							,  )
													report.pop('''macro avg''' )
													report.pop('''weighted avg''' )
													UpperCAmelCase_      :   Union[str, Any]      =	report.pop('''micro avg''' )

													UpperCAmelCase_      :   Tuple      =	{
													    type_name: {
													        '''precision''': score['''precision'''],
													        '''recall''': score['''recall'''],
													        '''f1''': score['''f1-score'''],
													        '''number''': score['''support'''],
													    }
													    for type_name, score in report.items()
													}
													UpperCAmelCase_      :   int      =	overall_score['''precision''']
													UpperCAmelCase_      :   List[str]      =	overall_score['''recall''']
													UpperCAmelCase_      :   Tuple      =	overall_score['''f1-score''']
													UpperCAmelCase_      :   Optional[Any]      =	accuracy_score(y_true=lowercase__							,  y_pred=lowercase__ )

													return scores













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

import os
from pathlib import Path



def      UpperCAmelCase						( lowerCAmelCase__					,     lowerCAmelCase__					,     lowerCAmelCase__					,     lowerCAmelCase__	):


		'''simple docstring'''

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

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

		__A    =							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=lowerCAmelCase__					,     exist_ok=lowerCAmelCase__	)
		__A    =							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
snake_case_   :	Optional[int]							      =Path(__file__).resolve().parent.parent.parent
snake_case_   :	Dict							      =repo_dir / '''model_cards'''

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

