Skip to content

Commit

Permalink
Reformat text
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeldking committed Oct 24, 2023
1 parent d37a5a9 commit 63ab5cd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/phoenix/trace/evaluation_conventions.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
EVAL_DOCUMENTS_PRECISION = "eval.documents_precision"
"""
The precision of a retriever.
This is the proportion (expressed as a value between 0 and 1) of relevant documents over the total
This is the proportion (expressed as a value between 0 and 1) of relevant documents over the total.
"""

EVAL_DOCUMENTS_PRECISION_AT_K_TEMPLATE = "eval.documents_precision_at_{k}"
"""
The prefix given to an evaluation metric that captures the precision of a
retriever up to K. E.x. you would have eval.documents_precision_at_1,
eval.documents_precision_at_2, etc. This value
would be computed on top of the document_relevancy attribute of each document.
eval.documents_precision_at_2, etc. This value would be computed on top of the
document_relevancy attribute of each document.
"""

0 comments on commit 63ab5cd

Please sign in to comment.