Skip to content

Conversation

alcholiclg
Copy link
Collaborator

Change Summary

Add chinese doc for deep research project.

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Run pre-commit install and pre-commit run --all-files before git commit, and passed lint check.
  • Documentation reflects the changes where applicable

Copy link

Summary of Changes

Hello @alcholiclg, 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 introduces new, comprehensive Chinese documentation for the DeepResearch project. The documentation aims to provide users with a clear understanding of the project's core principles, including its basic and extended versions, and guides them through the installation, configuration, and usage with practical code examples. This addition significantly enhances the project's accessibility and ease of adoption for Chinese-speaking users.

Highlights

  • New Documentation: Added comprehensive Chinese documentation for the DeepResearch project, detailing its principles, usage, installation, and code examples for both basic and extended versions.
  • DeepResearch Project Overview: The documentation introduces the DeepResearch project, which offers Agent workflows for complex task solving, particularly for generating in-depth multimodal research reports in scientific research and other fields. It covers two versions: a lightweight, efficient basic version and a deep, comprehensive extended version.
  • Usage and Configuration: Detailed instructions are provided for installing the DeepResearch project, configuring environment variables for search engines (like Exa or SerpApi), and setting up OpenAI-compatible API endpoints for the extended version.
  • Code Examples: Ready-to-use Python code examples are included for quickly starting both the basic and extended DeepResearch workflows, demonstrating how to integrate chat clients and search engines.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

本次PR为DeepResearch项目添加了中文文档,内容清晰、结构合理,对项目的原理、使用方式和代码示例都进行了详细说明。文档质量很高,仅发现一处关于模型名称的笔误,修正后即可合并。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant