-
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe recent update introduces functionality for running evaluations with RAGAS metrics using LlamaIndex's query engine. It demonstrates how to incorporate the query engine into the RagasLoader constructor to enhance dataset evaluation. Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
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.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
pages/evals/_meta.jsonis excluded by:!**/*.json
Files selected for processing (2)
- pages/evals/running_evals.mdx (1 hunks)
- pages/evals/running_evals_with_llama_index.mdx (1 hunks)
Additional comments: 7
pages/evals/running_evals.mdx (1)
- 32-32: Ensure the link to "Running evals with LlamaIndex" is correctly formatted and functional. Also, verify its placement in the list maintains logical order and consistency with other entries.
pages/evals/running_evals_with_llama_index.mdx (6)
- 1-3: Ensure the document title and section headers are appropriately formatted and accurately reflect the content's focus.
- 7-8: Confirm that the link to RAGAS documentation is functional and leads to the correct page.
- 10-32: Check the Python code example for syntax correctness, especially the string literals and dictionary keys. Ensure the example is clear and accurately demonstrates the intended functionality.
- 39-48: Verify the Python code snippet for creating a LlamaIndex query engine is correct and follows best practices for code examples in documentation.
- 50-54: The Callout component is used effectively to highlight important information. Ensure the message within the Callout is clear and provides value to the reader.
- 56-71: Review the final Python code example for correctness and clarity. Ensure it demonstrates the integration of the query engine with RagasLoader effectively.
| 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. | ||
|
|
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.
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.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
public/llama_index.pngis excluded by:!**/*.png
Files selected for processing (1)
- pages/evals/running_evals_with_llama_index.mdx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- pages/evals/running_evals_with_llama_index.mdx
Summary by CodeRabbit