-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Update evaluate_rag_gen_ai_evaluation_service_sdk.ipynb #2182
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
Conversation
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.
Summary of Changes
Hello @smithakolan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a minor but important bug in the RAG GenAI evaluation service SDK notebook. It ensures that the correct utility function is invoked and referenced for displaying evaluation results, thereby improving the accuracy and functionality of the notebook's reporting capabilities.
Highlights
- Bug Fix: Corrected an erroneous function call within the
evaluate_rag_gen_ai_evaluation_service_sdk.ipynb
notebook. The incorrectnotebook_utils.display_eval_report
function call has been replaced withnotebook_utils.display_eval_result
to ensure proper display of evaluation summaries. - Documentation Update: Updated the accompanying markdown text within the notebook to accurately reflect the change from
display_eval_report
todisplay_eval_result
, ensuring consistency between documentation and code.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request renames the function display_eval_report
to display_eval_result
in the notebook, aligning the documentation and code. The changes are accurate and address the issue described.
@@ -988,11 +988,11 @@ | |||
}, | |||
"outputs": [], | |||
"source": [ | |||
"notebook_utils.display_eval_report(\n", | |||
"notebook_utils.display_eval_result(\n", |
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.
" title=\"Model A Eval Result\",\n", | ||
" eval_result=referenced_result_rag_a,\n", | ||
")\n", | ||
"notebook_utils.display_eval_report(\n", | ||
"notebook_utils.display_eval_result(\n", |
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.
Description
Fix the incorrect calling of
notebook_utils.display_eval_report
tonotebook_utils.display_eval_result
.