From 1c3b6d303c4f66e6d1c168aeee339b90c20c54f8 Mon Sep 17 00:00:00 2001 From: Art Matsak Date: Mon, 29 Jul 2024 08:53:41 +0200 Subject: [PATCH] Fix "sentence" -> "claim" the context recall metric docs (#1126) This PR fixes the docs for the context recall metric by renaming "sentence" to "claim". A minor formatting fix is included, too. --- docs/concepts/metrics/context_recall.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/concepts/metrics/context_recall.md b/docs/concepts/metrics/context_recall.md index 663e2d067..c98bc9e5b 100644 --- a/docs/concepts/metrics/context_recall.md +++ b/docs/concepts/metrics/context_recall.md @@ -2,14 +2,14 @@ # Context Recall -Context recall measures the extent to which the retrieved context aligns with the annotated answer, treated as the ground truth. It is computed based on the `ground truth` and the `retrieved context`, and the values range between 0 and 1, with higher values indicating better performance. +Context recall measures the extent to which the retrieved context aligns with the annotated answer, treated as the ground truth. It is computed based on the `ground truth` and the retrieved `context`, and the values range between 0 and 1, with higher values indicating better performance. -To estimate context recall from the ground truth answer, each sentence in the ground truth answer is analyzed to determine whether it can be attributed to the retrieved context or not. In an ideal scenario, all sentences in the ground truth answer should be attributable to the retrieved context. +To estimate context recall from the ground truth answer, each claim in the ground truth answer is analyzed to determine whether it can be attributed to the retrieved context or not. In an ideal scenario, all claims in the ground truth answer should be attributable to the retrieved context. The formula for calculating context recall is as follows: ```{math} -\text{context recall} = {|\text{GT sentences that can be attributed to context}| \over |\text{Number of sentences in GT}|} +\text{context recall} = {|\text{GT claims that can be attributed to context}| \over |\text{Number of claims in GT}|} ``` ```{hint}