Skip to content

Commit 1c3b6d3

Browse files
authored
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.
1 parent e371b6f commit 1c3b6d3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/concepts/metrics/context_recall.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
# Context Recall
44

5-
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.
5+
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.
66

7-
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.
7+
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.
88

99
The formula for calculating context recall is as follows:
1010

1111
```{math}
12-
\text{context recall} = {|\text{GT sentences that can be attributed to context}| \over |\text{Number of sentences in GT}|}
12+
\text{context recall} = {|\text{GT claims that can be attributed to context}| \over |\text{Number of claims in GT}|}
1313
```
1414

1515
```{hint}

0 commit comments

Comments
 (0)