Skip to content

Commit fb17f9d

Browse files
authored
Update README (#25)
* update readme * update metrics info * fix type checks * add citations * update readme * add emojis * update readme
1 parent 727821f commit fb17f9d

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,22 @@
3232
<p>
3333
</h4>
3434

35+
ragas is a framework that helps you evaluate your Retrieval Augmented Generation (RAG) pipelines. RAG denotes a class of LLM applications that use external data to augment the LLM’s context. There are existing tools and frameworks that help you build these pipelines but evaluating it and quantifying your pipeline performance can be hard.. This is were ragas (RAG Assessment) comes in
3536

36-
## Quickstart
37+
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.
38+
39+
## Installation 🛡
40+
41+
```bash
42+
pip install ragas
43+
```
44+
if you want to install from source
45+
```bash
46+
git clone https://github.com/explodinggradients/ragas && cd ragas
47+
pip install -e .
48+
```
49+
50+
## Quickstart 🔥
3751

3852
This is a small example program you can run to see ragas in action!
3953
```python
@@ -61,14 +75,14 @@ results = e.eval(ds["ground_truth"], ds["generated_text"])
6175
print(results)
6276
```
6377
If you want a more in-depth explanation of core components, check out our quick-start notebook
64-
## Metrics
78+
## 🧰 Metrics
6579

66-
### Character based
80+
### ✏️ Character based
6781

6882
- **Levenshtein distance** the number of single character edits (additional, insertion, deletion) required to change your generated text to ground truth text.
6983
- **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.
7084

71-
### N-Gram based
85+
### 🖊 N-Gram based
7286

7387
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.
7488

@@ -80,7 +94,7 @@ N-gram based metrics as name indicates uses n-grams for comparing generated answ
8094

8195
It measures precision by comparing  clipped n-grams in generated text to ground truth text. These matches do not consider the ordering of words.
8296

83-
### Model Based
97+
### 🪄 Model Based
8498

8599
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.
86100

@@ -98,5 +112,5 @@ Model based methods uses language models combined with NLP techniques to compare
98112

99113
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. Q2Score score is highly correlated with human judgement.
100114

101-
Checkout [citations](./citations.md) for related publications.
115+
📜 Checkout [citations](./citations.md) for related publications.
102116

0 commit comments

Comments
 (0)