update readme #702
update readme #702
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @wangxingjun778, 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!
I've updated the documentation to provide clearer and more comprehensive installation instructions for the ms-agent framework. This includes distinguishing between basic and deep research functionalities for PyPI installations in the main README.md, and adding PyPI installation steps to the projects/deep_research/README.md alongside the existing source code installation guide.
Highlights
- Main README Update: Clarified ms-agent installation instructions in README.md to differentiate between basic functionalities and deep research functionalities, specifically noting the ms-agent['research'] extra.
- Deep Research README Update: Added PyPI installation instructions (pip install ms-agent[research]) to projects/deep_research/README.md to complement the existing source code installation guide.
- Documentation Clarity: Renamed the installation section heading in projects/deep_research/README.md from "Install from source code" to the more general "Installation" to accommodate both source and PyPI methods.
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 or fill out our survey 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.
Code Review
This pull request updates the installation instructions in the main README.md and the deep_research project's README.md. The changes add instructions for installing optional dependencies for 'deep research' functionality. My review includes suggestions to correct the pip install commands for extras, as the current syntax is likely to fail in many shell environments. I've also suggested adding a cd command to the source installation instructions to ensure the correct path is used.
README.md
Outdated
| pip install ms-agent | ||
|
|
||
| # For the deep research functionalities | ||
| pip install ms-agent['research'] |
There was a problem hiding this comment.
The command to install the package with the 'research' extra is not correctly quoted for most shells. The square brackets are special characters and need to be quoted. The single quotes should surround the package name and the extra, not just the extra name.
| pip install ms-agent['research'] | |
| pip install 'ms-agent[research]' |
| git clone https://github.com/modelscope/ms-agent.git | ||
|
|
||
| pip install -r requirements/research.txt |
There was a problem hiding this comment.
After cloning the repository, the user needs to change into the newly created ms-agent directory before they can run pip install -r requirements/research.txt, as the requirements directory is at the root of the repository.
| git clone https://github.com/modelscope/ms-agent.git | |
| pip install -r requirements/research.txt | |
| git clone https://github.com/modelscope/ms-agent.git | |
| cd ms-agent | |
| pip install -r requirements/research.txt |
projects/deep_research/README.md
Outdated
| pip install -r requirements/research.txt | ||
|
|
||
| # PyPI | ||
| pip install ms-agent[research] |
There was a problem hiding this comment.
The command to install the package with the 'research' extra is not quoted, which will cause it to fail in many shells because [ and ] are special characters. It's best practice to quote the package name and extras.
| pip install ms-agent[research] | |
| pip install 'ms-agent[research]' |
wangxingjun778
had a problem deploying
to
testci
GitHub Actions
Failure
1 participant
No description provided.