From 67c1c26690a8cb18357ae5d9b87788eb816065f9 Mon Sep 17 00:00:00 2001 From: Mikyo King Date: Tue, 24 Oct 2023 15:32:03 -0600 Subject: [PATCH] ci: stub out open AI key during CI to avoid embedding model downloads in llama_index (#1661) * ci: high watermark on CI * Reformat text * adjust watermark * fake openai key --- .github/workflows/python-CI.yml | 1 + src/phoenix/trace/evaluation_conventions.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/python-CI.yml b/.github/workflows/python-CI.yml index fa3c2b20bc..a1c40364d5 100644 --- a/.github/workflows/python-CI.yml +++ b/.github/workflows/python-CI.yml @@ -18,6 +18,7 @@ concurrency: env: pip-version: 23.1.2 + OPENAI_API_KEY: "sk-fake-openai-key" # fake openai key so that llama_index doesn't download huggingface embeddings jobs: lint: diff --git a/src/phoenix/trace/evaluation_conventions.py b/src/phoenix/trace/evaluation_conventions.py index 10764899ee..aa777d9479 100644 --- a/src/phoenix/trace/evaluation_conventions.py +++ b/src/phoenix/trace/evaluation_conventions.py @@ -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. """