Skip to main content

PyTorch implementation of BERT score

Project description

BERTScore

Automatic Evaluation Metric described in the paper BERTScore: Evaluating Text Generation with BERT.

Authors:

*: 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 setence-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 precision can be computed as

If you find this repo useful, please cite:

@article{bert-score,
  title={BERTScore: Evaluating Text Generation with BERT},
  author={Zhang, Tianyi and Kishore, Varsha and Wu, Felix and Weinberger, Kilian Q. and Artzi, Yoav.},
  journal={arXiv preprint arXiv:1904.09675},
  year={2019}
}

Installation

Install from pip by

pip install bert-score

Install it from the source by:

git clone https://github.com/Tiiiger/bert_score
cd bert_score
pip install -r requiremnts.txt
pip install .

Usage

Metric

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 --bert bert-base-uncased 
  1. To evaluate Chinese text files:

Please format your input files similar to the ones in ./example.

bert-score -r [references] -c [candidates] --bert bert-base-chinese
  1. To evaluate text files in other languages:

Please format your input files similar to the ones in ./example.

bert-score -r [references] -c [candidates]

See more options by bert-score -h.

For the python module, we provide a demo. Please refer to bert_score/score.py for more details.

Acknowledgement

This repo wouldn't be possible without the awesome bert and pytorch-pretrained-BERT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bert_score-0.1.1.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

bert_score-0.1.1-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file bert_score-0.1.1.tar.gz.

File metadata

  • Download URL: bert_score-0.1.1.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.24.0 CPython/3.6.7

File hashes

Hashes for bert_score-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7ff0a70ac3d43aa94887168079d079d02623f8a5bb157efa50ed7a874de4fdfb
MD5 521d962fcd2a09a36f18d8cb2d9d42b9
BLAKE2b-256 997334b87d5ae5eecaab7269d57e96adad01c4ae1a30acc3a6c26c1f89a1563e

See more details on using hashes here.

File details

Details for the file bert_score-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: bert_score-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.24.0 CPython/3.6.7

File hashes

Hashes for bert_score-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15947a9680d2e3af9e480f7a905d8c0adf2ca0dadef4505fd2b950e7cd9d191e
MD5 e077efb278739754b82a23e92aab20dd
BLAKE2b-256 3ca165ab39291884caf5466f443add017c072bf081b548dff073520825fbdc43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page