paramname

harim_plus.py

@@ -30,11 +30,16 @@ _CITATION = """\
 }
 """
 
-_DESCRIPTION = f"""HaRiM+ is a reference-less evaluation metric (i.e. requires only article-summary pair, no reference summary) for summarization which hurls the power of summarization model.
+_DESCRIPTION = f"""**HaRiM+** is a reference-less evaluation metric (i.e. requires only article-summary pair, no reference summary) for summarization which hurls the power of summarization model.
 Summarization model inside the HaRiM+ will read and evaluate how good the quality of a summary given the paired article.
 It will work great for ranking the summary-article pairs according to its quality.
 
 HaRiM+ is proved effective for benchmarking summarization systems (system-level performance) as well as ranking the article-summary pairs (segment-level performance) in comprehensive aspect such as factuality, consistency, coherency, fluency, and relevance. For details, refer to our [paper]({PAPER_URL}) published in AACL2022.
+
+NOTE that for HaRiM+...
+* predictions = summaries (List[str])
+* references = articles (List[str])
+
 """
 
 _KWARGS_DESCRIPTION = """
@@ -89,8 +94,8 @@ class Harimplus(evaluate.Metric):
             inputs_description=_KWARGS_DESCRIPTION,
             features=datasets.Features(
                 {
-                    "predictions (summaries)": datasets.Value("string", id="sequence"),
-                    "references (articles)": datasets.Value("string", id="sequence"),
+                    "predictions": datasets.Value("string", id="sequence"),
+                    "references": datasets.Value("string", id="sequence"),
                 }
             ),
             codebase_urls=[CODEBASE_URL],