Update Readme

[pan-x-c]

Description

As the title says

Checklist

Please check the following items before code is ready to be reviewed.

• Code has passed all tests
• Docstrings have been added/updated in Google Style
• Documentation has been updated
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @pan-x-c, I'm Gemini Code Assist¹! 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 enhances the project's documentation by refining the explanation of the Trinity-RFT framework. The updates provide a more precise understanding of how its Explorer, Trainer, and Buffer modules decouple the reinforcement fine-tuning process for large language models. These changes aim to improve clarity for various user groups, from application developers to data engineers, across both English and Chinese READMEs and Sphinx documentation.

Highlights

• Clarified Trinity-RFT Architecture: The description of the Trinity-RFT framework has been updated to explicitly highlight its decoupling into three key components: Explorer, Trainer, and Buffer, providing a clearer understanding of its modular design.
• Updated Module Descriptions and Examples: The descriptions and associated examples for the Explorer, Trainer, and Buffer modules have been refined for improved clarity and accuracy across both English and Chinese documentation.
• Documentation Formatting Improvements: Minor formatting adjustments were made, including standardizing 'Key Features' headings and converting a Sphinx note directive to a standard Markdown blockquote in the Chinese README for better readability.

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

[gemini-code-assist]

Code Review

This pull request updates the README and documentation files. The changes improve clarity and update content. However, I've found several inconsistencies across the different documentation files (both English and Chinese versions) regarding example names and formatting. I've left specific comments to address these issues to ensure all documentation is consistent and grammatically correct. Please review the suggestions to align the content across all updated files.

[yanxi-chen]

lgtm