Update evaluation documentation

microsoft / rag-experiment-accelerator

The RAG Experiment Accelerator is a versatile tool designed to expedite and facilitate the process of conducting experiments and evaluations using Azure Cognitive Search and RAG pattern.

https://github.com/microsoft/rag-experiment-accelerator

Other

179 stars 60 forks source link

Update evaluation documentation #571

Closed kcortinas closed 4 months ago

kcortinas commented 4 months ago

closes #304

This PR updates the following:

README.md: improve clarity around the metrics included in the accelerator, description of evaluation reports and common pitfalls.
evaluation-metrics.md: make clear how cosine similarity is computed
eval.py: update cosine description. Fix experiment name bug.