Skip to content

Updated README #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 9, 2023
Merged

Updated README #40

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
72fe84a
added readme
shahules786 Jun 7, 2023
58859f6
added how to use
shahules786 Jun 7, 2023
bd526dc
added metrics to docs
shahules786 Jun 7, 2023
93a96f2
update readme
shahules786 Jun 7, 2023
cbffce1
set model_max_length
shahules786 Jun 8, 2023
71cf2ef
fix import paths
shahules786 Jun 8, 2023
5260672
Merge branch 'main' of https://github.com/shahules786/ragas into dev
shahules786 Jun 8, 2023
5474736
Merge branch 'main' into dev
shahules786 Jun 8, 2023
94e21ad
Merge branch 'main' of https://github.com/explodinggradients/ragas in…
shahules786 Jun 9, 2023
91c35e8
update readme
shahules786 Jun 9, 2023
0b28cc5
Merge branch 'dev' of https://github.com/shahules786/ragas into dev
shahules786 Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ pip install -e .
This is a small example program you can run to see ragas in action!
```python

from ragas.metrics import factuality, answer_relevancy, context_relevancy
from ragas import evaluate
import os

Expand All @@ -64,7 +63,7 @@ ds = Dataset({
features: ['question','context','answer'],
num_rows: 25
})
results = evaluate(ds, metrics=[nli, answer_relevancy, context_relevancy])
results = evaluate(ds)

```
If you want a more in-depth explanation of core components, check out our quick-start notebook
Expand Down