Class Rouge (1.71.1) 

Rouge(
    *,
    rouge_type: typing.Literal[
        "rouge1",
        "rouge2",
        "rouge3",
        "rouge4",
        "rouge5",
        "rouge6",
        "rouge7",
        "rouge8",
        "rouge9",
        "rougeL",
        "rougeLsum",
    ],
    use_stemmer: bool = False,
    split_summaries: bool = False
)

The ROUGE Metric.

Calculates the recall of n-grams in prediction as compared to reference and returns a score ranging between 0 and 1. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

Methods

Rouge

Rouge(
    *,
    rouge_type: typing.Literal[
        "rouge1",
        "rouge2",
        "rouge3",
        "rouge4",
        "rouge5",
        "rouge6",
        "rouge7",
        "rouge8",
        "rouge9",
        "rougeL",
        "rougeLsum",
    ],
    use_stemmer: bool = False,
    split_summaries: bool = False
)

Initializes the ROUGE metric.