From 66ef7321a8e5b2e8c6836ad9868b69c75da3d553 Mon Sep 17 00:00:00 2001 From: Mikyo King Date: Tue, 24 Oct 2023 12:52:50 -0600 Subject: [PATCH] update relevancy_ratio --- src/phoenix/trace/evaluation_conventions.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/phoenix/trace/evaluation_conventions.py b/src/phoenix/trace/evaluation_conventions.py index 69ba9e3a29..8536b4779b 100644 --- a/src/phoenix/trace/evaluation_conventions.py +++ b/src/phoenix/trace/evaluation_conventions.py @@ -7,14 +7,15 @@ EVAL_DOCUMENT_RELEVANCIES = "eval.document_relevancies" """ -Attached to a document within a retriever span. An Int value of 1 or -0 indicating whether the document is relevant to the input query. +A list of relevancies for the documents of a retriever span. An Int value of 1 or +0 indicates whether the document is relevant to the input query. """ -EVAL_DOCUMENTS_RELEVANCY_PERCENT = "eval.documents_relevancy_percent" +EVAL_DOCUMENTS_RELEVANCY_RATIO = "eval.documents_relevancy_ratio" """ -Span level attribute denoting the percentage of relevant documents that were -outputted by the span (typically a retriever). +Span level attribute denoting the ratio of relevant documents that were +outputted by the span (typically a retriever). E.g. if the document_relevancies +is [1, 0, 1, 1, 0], then the documents_relevancy_ratio would be 0.6 """ EVAL_DOCUMENTS_PRECISION = "eval.documents_precision"