-
Notifications
You must be signed in to change notification settings - Fork 47
Fix/fix agentscope tools example docs #205
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
Fix/fix agentscope tools example docs #205
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 @garyzhang99, 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 focuses on improving the accuracy and clarity of documentation related to agentscope tools examples. The changes ensure that users have the correct links and information to set up and run the examples successfully, specifically by updating outdated references and clarifying version requirements for dependencies.
Highlights
- Documentation Update: Updated the
Agentscope Github linkin theexample_react.mdtutorial to point to the correctv0branch. - Dependency Clarification: Added a crucial note in
example_react.mdspecifying the requiredAgentScopecommit or branch (v0) for the example to function correctly. - Configuration File Correction: Corrected the listed configuration file names in
examples/agentscope_tool_react/README.mdfromalfworld.yamltoagentscope_tool_react_dapo.yamlandtrain_alfworld.yamltotrain_react.yaml.
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 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
-
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 updates documentation for the agentscope tools example. The changes include updating the link to the agentscope repository, specifying the required version, and correcting the names of configuration files in the README. My review focuses on improving the clarity and usefulness of the documentation. I've suggested making a commit hash into a clickable link for easier navigation and including a missing configuration file in the README to match the example's description.
Co-authored-by: 问昊 <[email protected]>
Description
As the title says.
Checklist
Please check the following items before code is ready to be reviewed.