Awesome

BERTScore

Automatic Evaluation Metric described in the paper BERTScore: Evaluating Text Generation with BERT (ICLR 2020). We now support about 130 models (see this spreadsheet for their correlations with human evaluation). Currently, the best model is microsoft/deberta-xlarge-mnli, please consider using it instead of the default roberta-large in order to have the best correlation with human evaluation.

News:

• Updated to version 0.3.13

  • Fix bug with transformers version > 4.17.0 (#148)

• Updated to version 0.3.12

  • Having get_idf_dict compatible with DDP (#140)
  • Fix setup bug (#138)

• Updated to version 0.3.11

  • Support 6 DeBERTa v3 models
  • Support 3 ByT5 models

• Updated to version 0.3.10

  • Support 8 SimCSE models
  • Fix the support of scibert (to be compatible with transformers >= 4.0.0)
  • Add scripts for reproducing some results in our paper (See this folder)
  • Support fast tokenizers in huggingface transformers with --use_fast_tokenizer. Notably, you will get different scores because of the difference in the tokenizer implementations (#106).
  • Fix non-zero recall problem for empty candidate strings (#107).
  • Add Turkish BERT Supoort (#108).

• Updated to version 0.3.9

  • Support 3 BigBird models
  • Fix bugs for mBART and T5
  • Support 4 mT5 models as requested (#93)

• Updated to version 0.3.8

  • Support 53 new pretrained models including BART, mBART, BORT, DeBERTa, T5, BERTweet, MPNet, ConvBERT, SqueezeBERT, SpanBERT, PEGASUS, Longformer, LED, Blendbot, etc. Among them, DeBERTa achives higher correlation with human scores than RoBERTa (our default) on WMT16 dataset. The correlations are presented in this Google sheet.
  • Please consider using --model_type microsoft/deberta-xlarge-mnli or --model_type microsoft/deberta-large-mnli (faster) if you want the scores to correlate better with human scores.
  • Add baseline files for DeBERTa models.
  • Add example code to generate baseline files (please see the details).

• Updated to version 0.3.7

  • Being compatible with Huggingface's transformers version >=4.0.0. Thanks to public contributers (#84, #85, #86).

• See #22 if you want to replicate our experiments on the COCO Captioning dataset.

• For people in China, downloading pre-trained weights can be very slow. We provide copies of a few models on Baidu Pan.

  • roberta-large password: dhe5
  • bert-base-chinese password: jvk7
  • bert-base-multilingual-cased password: yx3q

• Huggingface's datasets library includes BERTScore in their metric collection.

• Updated to version 0.3.6
  • Support custom baseline files #74
  • The option --rescale-with-baseline is changed to --rescale_with_baseline so that it is consistent with other options.
• Updated to version 0.3.5
  • Being compatible with Huggingface's transformers >=v3.0.0 and minor fixes (#58, #66, #68)
  • Several improvements related to efficency (#67, #69)
• Updated to version 0.3.4
  • Compatible with transformers v2.11.0 now (#58)
• Updated to version 0.3.3
  • Fixing the bug with empty strings issue #47.
  • Supporting 6 ELECTRA models and 24 smaller BERT models.
  • A new Google sheet for keeping the performance (i.e., pearson correlation with human judgment) of different models on WMT16 to-English.
  • Including the script for tuning the best number of layers of an English pre-trained model on WMT16 to-English data (See the details).
• Updated to version 0.3.2
  • Bug fixed: fixing the bug in v0.3.1 when having multiple reference sentences.
  • Supporting multiple reference sentences with our command line tool.
• Updated to version 0.3.1
  • A new BERTScorer object that caches the model to avoid re-loading it multiple times. Please see our jupyter notebook example for the usage.
  • Supporting multiple reference sentences for each example. The score function now can take a list of lists of strings as the references and return the score between the candidate sentence and its closest reference sentence.

Please see release logs for older updates.

Authors:

• Tianyi Zhang*
• Varsha Kishore*
• Felix Wu*
• Kilian Q. Weinberger
• Yoav Artzi

*: Equal Contribution

Overview

BERTScore leverages the pre-trained contextual embeddings from BERT and matches words in candidate and reference sentences by cosine similarity. It has been shown to correlate with human judgment on sentence-level and system-level evaluation. Moreover, BERTScore computes precision, recall, and F1 measure, which can be useful for evaluating different language generation tasks.

For an illustration, BERTScore recall can be computed as

If you find this repo useful, please cite:

@inproceedings{bert-score,
  title={BERTScore: Evaluating Text Generation with BERT},
  author={Tianyi Zhang* and Varsha Kishore* and Felix Wu* and Kilian Q. Weinberger and Yoav Artzi},
  booktitle={International Conference on Learning Representations},
  year={2020},
  url={https://openreview.net/forum?id=SkeHuCVFDr}
}

Installation

• Python version >= 3.6
• PyTorch version >= 1.0.0

Install from pypi with pip by

pip install bert-score

Install latest unstable version from the master branch on Github by:

pip install git+https://github.com/Tiiiger/bert_score

Install it from the source by:

git clone https://github.com/Tiiiger/bert_score
cd bert_score
pip install .

and you may test your installation by:

python -m unittest discover

Usage

Python Function

On a high level, we provide a python function bert_score.score and a python object bert_score.BERTScorer. The function provides all the supported features while the scorer object caches the BERT model to faciliate multiple evaluations. Check our demo to see how to use these two interfaces. Please refer to bert_score/score.py for implementation details.

Running BERTScore can be computationally intensive (because it uses BERT :p). Therefore, a GPU is usually necessary. If you don't have access to a GPU, you can try our demo on Google Colab

Command Line Interface (CLI)

We provide a command line interface (CLI) of BERTScore as well as a python module. For the CLI, you can use it as follows:

1. To evaluate English text files:

We provide example inputs under ./example.

bert-score -r example/refs.txt -c example/hyps.txt --lang en

You will get the following output at the end:

roberta-large_L17_no-idf_version=0.3.0(hug_trans=2.3.0) P: 0.957378 R: 0.961325 F1: 0.959333

where "roberta-large_L17_no-idf_version=0.3.0(hug_trans=2.3.0)" is the hash code.

Starting from version 0.3.0, we support rescaling the scores with baseline scores

bert-score -r example/refs.txt -c example/hyps.txt --lang en --rescale_with_baseline

You will get:

roberta-large_L17_no-idf_version=0.3.0(hug_trans=2.3.0)-rescaled P: 0.747044 R: 0.770484 F1: 0.759045

This makes the range of the scores larger and more human-readable. Please see this post for details.

When having multiple reference sentences, please use

bert-score -r example/refs.txt example/refs2.txt -c example/hyps.txt --lang en

where the -r argument supports an arbitrary number of reference files. Each reference file should have the same number of lines as your candidate/hypothesis file. The i-th line in each reference file corresponds to the i-th line in the candidate file.

2. To evaluate text files in other languages:

We currently support the 104 languages in multilingual BERT (full list).

Please specify the two-letter abbreviation of the language. For instance, using --lang zh for Chinese text.

See more options by bert-score -h.

3. To load your own custom model: Please specify the path to the model and the number of layers to use by --model and --num_layers.

bert-score -r example/refs.txt -c example/hyps.txt --model path_to_my_bert --num_layers 9

4. To visualize matching scores:

bert-score-show --lang en -r "There are two bananas on the table." -c "On the table are two apples." -f out.png

The figure will be saved to out.png.

5. If you see the following message while using BERTScore, please ignore it. This is expected.

Some weights of the model checkpoint at roberta-large were not used when initializing RobertaModel: ['lm_head.decoder.weight', 'lm_head.layer_norm.weight', 'lm_head.dense.bias', 'lm_head.layer_norm.bias', 'lm_head.bias', 'lm_head.dense.weight']
- This IS expected if you are initializing RobertaModel from the checkpoint of a model trained on another task or with another architecture (e.g. initializing a BertForSequenceClassification model from a BertForPreTraining model).
- This IS NOT expected if you are initializing RobertaModel from the checkpoint of a model that you expect to be exactly identical (initializing a BertForSequenceClassification model from a BertForSequenceClassification model).

Practical Tips

• Report the hash code (e.g., roberta-large_L17_no-idf_version=0.3.0(hug_trans=2.3.0)-rescaled) in your paper so that people know what setting you use. This is inspired by sacreBLEU. Changes in huggingface's transformers version may also affect the score (See issue #46).
• Unlike BERT, RoBERTa uses GPT2-style tokenizer which creates addition " " tokens when there are multiple spaces appearing together. It is recommended to remove addition spaces by sent = re.sub(r' +', ' ', sent) or sent = re.sub(r'\s+', ' ', sent).
• Using inverse document frequency (idf) on the reference sentences to weigh word importance may correlate better with human judgment. However, when the set of reference sentences become too small, the idf score would become inaccurate/invalid. We now make it optional. To use idf, please set --idf when using the CLI tool or idf=True when calling bert_score.score function.
• When you are low on GPU memory, consider setting batch_size when calling bert_score.score function.
• To use a particular model please set -m MODEL_TYPE when using the CLI tool or model_type=MODEL_TYPE when calling bert_score.score function.
• We tune layer to use based on WMT16 metric evaluation dataset. You may use a different layer by setting -l LAYER or num_layers=LAYER. To tune the best layer for your custom model, please follow the instructions in tune_layers folder.
• Limitation: Because BERT, RoBERTa, and XLM with learned positional embeddings are pre-trained on sentences with max length 512, BERTScore is undefined between sentences longer than 510 (512 after adding [CLS] and [SEP] tokens). The sentences longer than this will be truncated. Please consider using XLNet which can support much longer inputs.

Default Behavior

Default Model

Default Layers

Please see this Google sheet for the supported models and their performance.

Acknowledgement

This repo wouldn't be possible without the awesome bert, fairseq, and transformers.