Skip to content

Commit

Permalink
Fix "sentence" -> "claim" the context recall metric docs (#1126)
Browse files Browse the repository at this point in the history
This PR fixes the docs for the context recall metric by renaming
"sentence" to "claim". A minor formatting fix is included, too.
  • Loading branch information
artmatsak authored Jul 29, 2024
1 parent e371b6f commit 1c3b6d3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/concepts/metrics/context_recall.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit 1c3b6d3

Please sign in to comment.