Skip to content

Commit c6ba686

Browse files
Updating Readme
1 parent ebea5e9 commit c6ba686

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

Readme.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# SacreROUGE
22
![Master](https://github.com/danieldeutsch/sacrerouge/workflows/Master/badge.svg?branch=master&event=push)
33

4-
SacreROUGE is a library dedicated to summarization evaluation metrics.
5-
Its two main uses are to evaluate summarization systems and to evaluation the evaluation metrics themselves by calculating their correlations to human judgments.
4+
SacreROUGE is a library dedicated to the development and use of summarization evaluation metrics.
5+
It can be viewed as an [AllenNLP](https://github.com/allenai/allennlp) for evaluation metrics (with an emphasis on summarization).
6+
The inspiration for the library came from [SacreBLEU](https://github.com/mjpost/sacreBLEU), a library with a standardized implementation of BLEU and dataset readers for common machine translation datasets.
67

78
The development of SacreROUGE was motivated by three problems:
89

@@ -16,8 +17,14 @@ SacreROUGE wraps many popular evaluation metrics in a common interface so it is
1617
There are there are several different correlation coefficients commonly used, there are different levels at which the correlation can be calculated, and comparing system summaries to human summaries requires implementing jackknifing.
1718
The evaluation code in SacreROUGE is shared among all of the metrics, so once a new metric implements the common interface, all of the details of the evaluation are taken care of for free.
1819

20+
The two main uses of SacreROUGE are to evaluate summarization systems and to evaluation the evaluation metrics themselves by calculating their correlations to human judgments.
21+
1922
## Installing
20-
`pip install sacrerouge`
23+
The easiest method of using SacreROUGE is to install the [pypi library](https://pypi.org/project/sacrerouge/) via:
24+
```
25+
pip install sacrerouge
26+
```
27+
This will add a new `sacrerouge` bash command to your path, which serves as the primary interface for the library.
2128

2229
## Evaluating Summarization Systems
2330
The `sacrerouge evaluate` command is typically used when you want to evaluate a summarization model on a particular dataset using one or more evaluation metrics.

0 commit comments

Comments
 (0)