-
Notifications
You must be signed in to change notification settings - Fork 0
update logging docs for llama index #17
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.
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
Open
akshat-g
wants to merge
2
commits into
main
Choose a base branch
from
feature/llama_index_docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import { Callout } from "nextra/components"; | ||
|
|
||
| ## Running Evals | ||
|
|
||
| ### Running RAGAS Evals with LlamaIndex | ||
|
|
||
| [RAGAS](/evals/preset_evals/ragas_evals) is a popular library with state-of-the-art evaluation metrics for RAG models. Athina supports evaluating your datasets | ||
| using RAGAS metrics. | ||
|
|
||
| ```python | ||
| from athina.loaders import RagasLoader | ||
| from athina.evals import RagasAnswerRelevancy | ||
|
|
||
| data = [ | ||
| { | ||
| "query": "Where is France and what is it's capital?", | ||
| "contexts": ["France is the country in europe known for delicious cuisine", "Tesla is an electric car", "Elephant is an animal"], | ||
| "response": "France is in europe. Paris is it's capital" | ||
| }, | ||
| { | ||
| "query": "What is Tesla? Who founded it?", | ||
| "contexts": ["Tesla is the electric car company. Tesla is registerd in United States", "Elon Musk founded it"], | ||
| "response": "Tesla is an electric car company. Elon Musk founded it." | ||
| }, | ||
| ] | ||
|
|
||
| # Load the data from CSV, JSON, Athina or Dictionary | ||
| dataset = RagasLoader().load_dict(data) | ||
|
|
||
| eval_model = "gpt-3.5-turbo" | ||
| RagasAnswerRelevancy(model=eval_model).run_batch(data=dataset).to_df() | ||
| ``` | ||
|
|
||
| In the above example, retrieved contexts are being explicitly provided in the dataset. In place of this, LlamaIndex's query engine can be sent as a parameter | ||
| in the RagasLoader constructor. | ||
|
|
||
| Sample code to create llamaindex query engine | ||
|
|
||
| ```python | ||
| WikipediaReader = download_loader("WikipediaReader") | ||
| loader = WikipediaReader() | ||
| documents = loader.load_data(pages=['Berlin']) | ||
| vector_index = VectorStoreIndex.from_documents( | ||
| documents, service_context=ServiceContext.from_defaults(chunk_size=512) | ||
| ) | ||
|
|
||
| query_engine = vector_index.as_query_engine() | ||
| ``` | ||
|
|
||
| <Callout> | ||
|
|
||
| Above query engine is just a sample. One can create any type of query engine using any type of loader and documents index | ||
|
|
||
| </Callout> | ||
|
|
||
| ```python | ||
| data = [ | ||
| { | ||
| "query": "Where is Berlin?", | ||
| }, | ||
| { | ||
| "query": "What is the main cuisine of Rome?", | ||
| }, | ||
| ] | ||
|
|
||
| dataset = RagasLoader(query_engine=query_engine).load_dict(data) | ||
| pd.DataFrame(dataset) | ||
|
|
||
| eval_model = "gpt-3.5-turbo" | ||
| RagasAnswerRelevancy(model=eval_model).run_batch(data=data).to_df() | ||
| ``` | ||
|
|
||
| Your results will be printed out as a dataframe that looks like this. | ||
|
|
||
| <img src="/llama_index.png" /> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarify the explanation regarding the use of LlamaIndex's query engine in the RagasLoader constructor to ensure readers understand how to integrate it.
Consider adding more context or a brief explanation on why integrating LlamaIndex's query engine is beneficial.