EASSE (Easier Automatic Sentence Simplification Evaluation) is a Python 3 package aiming to facilitate and standardise automatic evaluation and comparison of Sentence Simplification systems. (What is Sentence Simplification?)
We edited EASSE to evaluate German simplification systems. We made the following changes to the original:
- uploaded German sentence-level test sets and document-level test sets
- uploaded German sentence-level system outputs
- uploaded human judgements regarding German test sets (so far only on gold simplifications)
- uploaded evaluation reports for German sentence-level experiments
- added reproduction scripts for available German TS systems
- added script to add German resources easse/install.sh on sentence and document level
- removed some English resources (turkcorpus, qats and pwkp kept for tests)
- added evaluation metrics for German data
- Flesch Reading Ease adapted by Amstad (1978)
- Wiener Sachtextformeln following Bamberger & Vaneck (1984)
- added an interpretation sheet for readability metrics
- added identity baseline (source text copied)
- added multi-lingual tokenizer (i.e., spacy)
- chaged tseval from English version (https://github.com/facebookresearch/text-simplification-evaluation) to multilingual version (https://github.com/rstodden/text-simplification-evaluation)
- Automatic evaluation metrics (e.g. SARI1, BLEU, SAMSA, etc.).
- Commonly used evaluation sets.
- Literature system outputs to compare to.
- Word-level transformation analysis.
- Referenceless Quality Estimation features.
- Straightforward access to commonly used evaluation datasets.
- Comprehensive HTML report for quantitative and qualitative evaluation of a simplification output.
[1]: The SARI version in EASSE fixes inconsistencies and bugs in the original version. See the dedicated section for more details.
Python 3.6 or 3.7 is required. In Python 3.8, the nltk.tokenizer sentence splitter splits the sentence differently, hence the test does not work anymore. For example, the sentence "presidential candidate john f . kennedy proposed the peace corps on the steps of michigan union in 1960 ." is plit into sentences in 3.7 but not in 3.8.
Install EASSE by running:
git clone https://github.com/feralvam/easse.git
cd easse
pip install -e .
This will make easse available on your system but it will use the sources from the local clone
you made of the source repository.
Pick the fasttextmodel of your language from here https://fasttext.cc/docs/en/crawl-vectors.html, unzip and save into the tseval/resources/fasttext-vectors/cc..300.vec folder. Download spacy model of your language from here https://spacy.io/models/.
Please specify the language of your interest in ./easse/utils/constants.py.
Once EASSE has been installed, you can run the command-line interface with the easse command.
$ easse
Usage: easse [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
evaluate Evaluate a system output with automatic metrics.
report Create a HTML report file with automatic metrics, plots and samples.
$ easse evaluate -h
Usage: easse evaluate [OPTIONS]
Options:
-m, --metrics TEXT Comma-separated list of metrics to compute.
Valid: bleu,sari,samsa,fkgl,fre (SAMSA is
disabled by default for the sake of speed)
-tok, --tokenizer [13a|intl|moses|penn|none|spacy]
Tokenization method to use.
--refs_sents_paths TEXT Comma-separated list of path(s) to the
references(s). Only used when test_set ==
"custom"
--orig_sents_path PATH Path to the source sentences. Only used when
test_set == "custom"
--sys_sents_path PATH Path to the system predictions input file
that is to be evaluated.
-t, --test_set [zest_(test|valid)|textcomplexityde_test|apa_lha-or-a2_(test|valid)|
apa_lha-or-b1()test|valid)|deasy-share_test|custom]
test set to use. [required]
-a, --analysis Perform word-level transformation analysis.
-q, --quality_estimation Perform quality estimation.
-h, --help Show this message and exit.
Example with the ACCESS system outputs:
easse evaluate -t turkcorpus_test -m 'bleu,sari,fkgl' -q < easse/resources/data/system_outputs/turkcorpus/test/ACCESS
$ easse report -h
Usage: easse report [OPTIONS]
Options:
-m, --metrics TEXT Comma-separated list of metrics to compute.
Valid: bleu,sari,samsa,fkgl,fre_sent (SAMSA is
disabled by default for the sake of speed
-tok, --tokenizer [13a|intl|moses|penn|none|spacy]
Tokenization method to use.
--refs_sents_paths TEXT Comma-separated list of path(s) to the
references(s). Only used when test_set ==
"custom"
--orig_sents_path PATH Path to the source sentences. Only used when
test_set == "custom"
--sys_sents_path PATH Path to the system predictions input file
that is to be evaluated.
-t, --test_set [zest_(test|valid)|textcomplexityde_test|apa_lha-or-a2_(test|valid)|
apa_lha-or-b1()test|valid)|deasy-share_test|custom]
test set to use. [required]
-p, --report_path PATH Path to the output HTML report.
-h, --help Show this message and exit.
Reproduce EN-example:
easse report -t turkcorpus_test_legacy -m 'bleu,sari,fkgl' -tok "13a" -lc -p "report_access.html" --sys_sents_path easse/resources/data/system_outputs/turkcorpus/test/tok.low/ACCESS.tok.low
German example APALHA:
easse report -t custom --orig_sents_path ../LongFormer/results_20221201/APALHA/a2_test_or.txt -
-refs_sents_paths ../LongFormer/results_20221201/APALHA/a2_test_si.txt -m 'bleu,sari,fkgl' -tok "13a" --no-lc -p "../LongFormer/results_20221201/APALHA/report_apalha_longmbart.html" --sys_sents_path ../LongFormer/results_20221201/APALHA/LongMBart.txt
German example DEASY:
easse report -t custom --orig_sents_path ../LongFormer/results_20221201/DEASY_2/test_OR.txt --r
efs_sents_paths ../LongFormer/results_20221201/DEASY_2/test_SI.txt -m 'bleu,sari,fkgl,fre_corpus,fre_sent,bertscore,wiener_sachtextformel_1_sent,wiener_sachtextformel_1_corpus' -tok "13a" --no-lc -p "../LongFormer/results_20221201/DEASY_2/report_all.html" --sys_sents_path ../LongFormer/results_20221201/DEASY_2/LongMBart.txt,../LongFormer/results_20221201/DEASY_2/MBart.txt,../LongFormer/results_20221201/DEASY_2/TrimmedLongMBart.txt,../LongFormer/results_20221201/DEASY_2/TrimmedMBart.txtYou can also use the different functions available in EASSE from your Python code.
from easse.sari import corpus_sari
corpus_sari(orig_sents=["About 95 species are currently accepted.", "The cat perched on the mat."],
sys_sents=["About 95 you now get in.", "Cat on mat."],
refs_sents=[["About 95 species are currently known.", "The cat sat on the mat."],
["About 95 species are now accepted.", "The cat is on the mat."],
["95 species are now accepted.", "The cat sat."]])
Out[1]: 33.17472563619544The version of SARI fixes inconsistencies and bugs that were present in the original implementation. The main differences are:
- The original SARI implementation applies normalisation (NIST style tokenization and rejoin ‘s, ‘re ...) only on the prediction and references but not on the source sentence (see STAR.java file). This results in incorrect ngram additions or deletions. EASSE applies the same normalization to source, prediction and references.
- The original SARI implementation takes tokenized text as input that are then tokenized a second time. This also causes discrepancies between the tokenization of the training set and the evaluation set. EASSE uses untokenized text that is then tokenized uniformly at runtime, during evaluation. This allows for training models on raw text without worrying about matching the evaluation tokenizer.
- The original JAVA implementation had a silent overflow bug where ngram statistics would go beyond the maximum limit for integers and silently start over from the minimum value. This caused incorrect SARIs when rating too many sentences but did not raise an error.
- 13a: sacrebleu.tokenizers.tokenizer_13a.Tokenizer13a
- "Tokenizes an input line using a relatively minimal tokenization that is however equivalent to mteval-v13a, used by WMT."
- intl: sacrebleu.tokenizers.tokenizers_intl.TokenizerV14International
- "Tokenizes a string following the official BLEU implementation."
- moses: sacremoses.MosesTokenizer()
- penn: sacremoses.MosesTokenizer().penn_tokenize()
- none: sacrebleu.tokenizers.tokenizers_none.NoneTokenizer.()
- No tokenization applied.
- please choose this option, if your data is already tokenized.
- spacy
- tokenization based on spacy models.
- Can be specified for German or other languages.
- in comparison to the other tokenizers, rather slow
EASSE is licenced under the GNU General Public License v3.0.
If you use EASSE-multi in your research, please cite the original EASSE paper and the EASSE-DE paper. If you use the system generations or reproducability code please also cite our reproduction paper.
Regina Stodden. 2024 (to appear). Reproduction & Benchmark of German Text Simplification Systems. In Proceedings of the 1st Workshop on Evaluating Text Difficulty in a Multilingual Context (DeTermIt!), Turino, Italy.
@inproceedings{stodden-2024-reproduction,
author = {Regina Stodden},
title = {{Reproduction \& Benchmark of German Text Simplification Systems}},
booktitle = "Proceedings of the 1st Workshop on Evaluating Text Difficulty in a Multilingual Context (DeTermIt!)",
year = {2024 (to appear)},
address = "Turino, Italy"
}
Regina Stodden. 2024. EASSE-DE: Easier Automatic Sentence Simplification Evaluation for German. ArXiv preprint, arXiv:2404.03563.
@misc{stodden-2024-easse,
author = {Regina Stodden},
title={{EASSE-DE: Easier Automatic Sentence Simplification Evaluation for German}},
year={2024},
eprint={2404.03563},
archivePrefix={arXiv},
primaryClass={cs.CL},
url = {https://arxiv.org/abs/2404.03563},
note = {arXiv preprint, arXiv:2404.03563}
}
Fernando Alva-Manchego, Louis Martin, Carolina Scarton, and Lucia Specia. 2019. EASSE: Easier Automatic Sentence Simplification Evaluation. In Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing and the 9th International Joint Conference on Natural Language Processing (EMNLP-IJCNLP): System Demonstrations, pages 49–54, Hong Kong, China. Association for Computational Linguistics.
@inproceedings{alva-manchego-etal-2019-easse,
title = "{EASSE}: {E}asier Automatic Sentence Simplification Evaluation",
author = "Alva-Manchego, Fernando and
Martin, Louis and
Scarton, Carolina and
Specia, Lucia",
booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing and the 9th International Joint Conference on Natural Language Processing (EMNLP-IJCNLP): System Demonstrations",
month = nov,
year = "2019",
address = "Hong Kong, China",
publisher = "Association for Computational Linguistics",
url = "https://aclanthology.org/D19-3009",
doi = "10.18653/v1/D19-3009",
pages = "49--54",
}