Update notebook to address review comments.
"Recall-Oriented Understudy for Gisting Evaluation(ROUGE) is a set of metrics for evaluating automatic text summarization and machine translation results. The metrics compare machine-generated summaries or translations against one or multiple reference summaries or translations created by human. \n",
"Commonly used ROUGE metrics are ROUGE-1, ROUGE-2, and ROUGE-L\n",
"* ROUGE-1: Overlap of unigrams (single words) between machine-generated and reference summaries. \n",
- "* ROUGE-2: Overlap of bigrams (two adjcent words) between machine-generated and reference summaries.\n",
- "* ROUGE-L: Longest Common Subsequence (LCS), which doesn't require consecutive matches but in-sequence matches that refect sentence level structure similarity. \n",
+ "* ROUGE-2: Overlap of bigrams (two adjacent words) between machine-generated and reference summaries.\n",
+ "* ROUGE-L: Longest Common Subsequence (LCS), which doesn't require consecutive matches but in-sequence matches that refect sentence-level structure similarity. \n",
"\n",
"For each metric, recall, precision, and F1 score are computed. \n",
"\n",
"**Utilities for computing ROUGE**\n",
- "* `compute_rouge_perl`: The [pyrouge](https://github.com/bheinzerling/pyrouge/tree/master/pyrouge) package based on the ROUGE package written in perl is the most popular package for computing ROUGE scores. We provide the `compute_rouge_perl` function based on pyrouge. \n",
- "* `compute_rouge_python`: The [py-rouge](https://pypi.org/project/py-rouge/) package is a Python implementation of the ROUGE metric which produces almost the same results as the perl implemenation. Since it's easier to install than pyrouge and can be extended to other languages, we provide the `compute_rouge_python` function based on py-rouge. Currently, only English is supported. Supports for other languages will be provided on an as-needed basis. "
+ "* `compute_rouge_perl`: The [pyrouge](https://github.com/bheinzerling/pyrouge) package based on the ROUGE package written in perl is the most popular package for computing ROUGE scores. We provide the `compute_rouge_perl` function based on pyrouge. This function supports English only. \n",
+ "* `compute_rouge_python`: The [py-rouge](https://pypi.org/project/py-rouge/) package is a Python implementation of the ROUGE metric which produces almost the same results as the perl implemenation. Since it's easier to install than pyrouge and can be extended to other languages, we provide the `compute_rouge_python` function based on py-rouge. Currently, English and Hindi are supported. Supports for other languages will be provided on an as-needed basis."
]
},
{
"metadata": {},
"source": [
"### Sample inputs\n",
- "Both `compute_rouge_perl` and `compute_rouge_python` takes lists of candidate summaries and reference summaries as inputs. Alternatively, you can also provide paths to files containing the candidates and references and set the `input_files` argument to `True`. "
+ "Both `compute_rouge_perl` and `compute_rouge_python` takes lists of candidate summaries and reference summaries as inputs. Alternatively, you can also provide paths to files containing the candidates and references and set the `input_is_files` argument to `True`. "
]
},
{
