You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -37,7 +37,7 @@ ragas is a framework that helps you evaluate your Retrieval Augmented Generation
37
37
38
38
ragas provides you with the tools based on the latest research for evaluating LLM generated text to give you insights about your RAG pipeline. ragas can be integrated with your CI/CD to provide continuous check to ensure performance.
39
39
40
-
## :beers: Installation
40
+
## :shield: Installation
41
41
42
42
```bash
43
43
pip install ragas
@@ -48,7 +48,7 @@ git clone https://github.com/explodinggradients/ragas && cd ragas
48
48
pip install -e .
49
49
```
50
50
51
-
## :beers: Quickstart
51
+
## :fire: Quickstart
52
52
53
53
This is a small example program you can run to see ragas in action!
If you want a more in-depth explanation of core components, check out our quick-start notebook
79
-
## :beers: Metrics
79
+
## :luggage: Metrics
80
80
81
-
### ✏️ Character based
81
+
### :3rd_place_medal: Character based
82
82
83
83
-**Levenshtein distance** the number of single character edits (additional, insertion, deletion) required to change your generated text to ground truth text.
84
84
-**Levenshtein****ratio** is obtained by dividing the Levenshtein distance by sum of number of characters in generated text and ground truth. This type of metrics is suitable where one works with short and precise texts.
85
85
86
-
### 🖊 N-Gram based
86
+
### :2nd_place_medal: N-Gram based
87
87
88
88
N-gram based metrics as name indicates uses n-grams for comparing generated answer with ground truth. It is suitable to extractive and abstractive tasks but has its limitations in long free form answers due to the word based comparison.
89
89
@@ -95,7 +95,7 @@ N-gram based metrics as name indicates uses n-grams for comparing generated answ
95
95
96
96
It measures precision by comparing clipped n-grams in generated text to ground truth text. These matches do not consider the ordering of words.
97
97
98
-
### 🪄 Model Based
98
+
### :1st_place_medal: Model Based
99
99
100
100
Model based methods uses language models combined with NLP techniques to compare generated text with ground truth. It is well suited for free form long or short answer types.
101
101
@@ -111,7 +111,7 @@ Model based methods uses language models combined with NLP techniques to compare
111
111
112
112
-**$Q^2$**
113
113
114
-
Best used to measure factual consistencies between ground truth and generated text. Scores can range from 0 to 1. Higher score indicates better factual consistency between ground truth and generated answer. Employs QA-QG paradigm followed by NLI to compare ground truth and generated answer. $Q^2$ score is highly correlated with human judgement.
114
+
Best used to measure factual consistencies between ground truth and generated text. Scores can range from 0 to 1. Higher score indicates better factual consistency between ground truth and generated answer. Employs QA-QG paradigm followed by NLI to compare ground truth and generated answer. $Q^2$ score is highly correlated with human judgement.:warning: time and resource hungry metrics.
115
115
116
-
📜 Checkout [citations](./citations.md) for related publications.
116
+
📜 Checkout [citations](./references.md) for related publications.
0 commit comments