-
Notifications
You must be signed in to change notification settings - Fork 47
Update Benchmark doc and FAQ #436
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
Summary of ChangesHello @pan-x-c, 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 primarily focuses on improving the project's documentation by expanding the benchmark section with new examples and detailed reports, and by enhancing the Frequently Asked Questions (FAQ) guides. The updates aim to provide clearer instructions on configuration, debugging, and a better understanding of the system's architecture and its relation to underlying frameworks, thereby making the project more accessible and user-friendly. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
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 updates the benchmark documentation and the FAQ across both English and Chinese versions. A new 'Benchmarks' section has been added to the READMEs and main documentation pages, including links to new benchmark reports. The FAQ has been significantly restructured and expanded for better clarity. My review includes suggestions to fix a few typos, formatting inconsistencies, and, most importantly, some potentially broken links in the Sphinx documentation that should be addressed to ensure the documentation renders correctly.
yanxi-chen
left a comment
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.
Please see the inline comments, otherwise lgtm
|
Others LGTM |
Description
As the title says
Checklist
Please check the following items before code is ready to be reviewed.