Improve documentation for CPU-only users and first-time contributors #474

P09s · 2026-01-11T18:15:23Z

This PR improves onboarding for new users by:

Adding a minimal CPU-only quick start using the Tinker backend
Clarifying GPU vs CPU hardware requirements
Making the contribution section more welcoming for new contributors

These changes help lower the entry barrier for first-time users.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Improve documentation for CPU-only users and first-time contributors

gemini-code-assist · 2026-01-11T18:15:38Z

Summary of Changes

Hello @P09s, 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 significantly improves the project's documentation, making it more accessible and user-friendly for a broader audience. It specifically addresses the needs of CPU-only users by providing a streamlined quick-start guide and clarifies hardware requirements. Additionally, the contribution section has been refined to encourage and guide first-time contributors, lowering the barrier to entry for community involvement.

Highlights

CPU-Only Quick Start: Introduced a new "Minimal CPU-Only Quick Start" guide, leveraging the Tinker backend, to facilitate easier onboarding for users without GPU hardware.
Hardware Requirements Clarification: Enhanced clarity on hardware requirements, distinguishing between GPU and CPU-only setups and recommending installation methods based on user needs.
Improved Contribution Guide: Revised the "Contribution Guide" to be more welcoming and provide clearer entry points for new contributors.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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

P09s · 2026-01-11T18:16:34Z

Hi maintainers, this PR improves documentation for CPU-only users and first-time contributors.
Please let me know if any changes are needed. Thanks for your time!

gemini-code-assist

Code Review

This pull request significantly improves the onboarding experience for new users by adding a CPU-only quick start guide, clarifying hardware requirements, and making the contribution section more welcoming. The changes are well-structured and greatly enhance the clarity of the README.md file. My review includes a couple of suggestions to address minor inconsistencies in the installation instructions, which will further improve the documentation's consistency and help prevent potential setup issues for users.

README.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

pan-x-c

Thanks for your suggestion.

README.md

Co-authored-by: Xuchen Pan <32844285+pan-x-c@users.noreply.github.com>

Updated installation section to improve clarity and added GPU and CPU-only support details.

Removed unnecessary line breaks in the README for better readability.

P09s · 2026-01-12T05:44:11Z

Thank you for the feedback. I’ve separated the GPU requirements and CPU-only support as discussed and cleaned up the README formatting that was causing the pre-commit check to fail. The latest commits should now pass CI.
Please let me know if anything else needs adjustment.

yanxi-chen

Please see the inline comments. Some deleted statements are actually useful or more precise, and I think it would be good to bring them back. Otherwise lgtm.

yanxi-chen · 2026-01-12T06:26:27Z

README.md

+> **No GPU? No problem!** You can still try it out using the Tinker backend:
+> 1. Follow the installation steps (skip GPU-specific packages like `flash-attn`)
+> 2. Run the **[Tinker training example](https://github.com/modelscope/Trinity-RFT/tree/main/examples/tinker)**, which is designed for CPU-only systems.


These lines can be removed.

README.md

yanxi-chen · 2026-01-12T06:33:58Z

README.md

+#### CPU-Only Support
+
+- CPU-only execution is supported via the Tinker backend.
+- This mode is intended for testing, development, and experimentation.
+  (see: Minimal CPU-Only Quick Start)


These lines can be removed.

yanxi-chen · 2026-01-12T06:47:24Z

README.md

 trinity studio --port 8080
 ```

-Then you can configure your RFT process in the web page and generate a config file. You can save the config file for later use or run it directly as described in the following section.


Keep this line

yanxi-chen · 2026-01-12T06:48:27Z

README.md

-For example, to log in to Wandb:
-
-```shell
-export WANDB_API_KEY=<your_api_key>
-wandb login
-```


Keep these lines

yanxi-chen · 2026-01-12T06:48:55Z

README.md

 trinity run --config examples/grpo_gsm8k/gsm8k.yaml
 ```

-For studio users, click "Run" in the web interface.


Keep this line

README.md

yanxi-chen · 2026-01-12T06:51:04Z

README.md

-+ we have also drawn inspirations from RL frameworks like [OpenRLHF](https://github.com/OpenRLHF/OpenRLHF), [TRL](https://github.com/huggingface/trl), [ChatLearn](https://github.com/alibaba/ChatLearn) and [rLLM](https://github.com/rllm-org/rllm);
-+ ......


Revert to the original version

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

P09s and others added 8 commits January 11, 2026 01:43

docs: add CPU-only quick start and improve beginner documentation

fade366

docs: restore references and helpful links in README

157eccd

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

docs: restore references and helpful links in README

695e2a4

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update README.md

d5d2e8f

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update README.md

266113c

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

docs: restore references and helpful links in README

418b808

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

docs: restore references and helpful links in README

52e8dc2

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Merge pull request #1 from P09s/P09s-patch-1

d712b6b

Improve documentation for CPU-only users and first-time contributors

gemini-code-assist bot reviewed Jan 11, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

P09s and others added 2 commits January 11, 2026 23:49

python version updated

438e2ab

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

note added

2e0de4e

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

pan-x-c reviewed Jan 12, 2026

View reviewed changes

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

P09s and others added 5 commits January 12, 2026 10:31

blank line added

d181897

Co-authored-by: Xuchen Pan <32844285+pan-x-c@users.noreply.github.com>

Update README.md

0997606

Co-authored-by: Xuchen Pan <32844285+pan-x-c@users.noreply.github.com>

Revise installation instructions and add requirements

3b77fa4

Updated installation section to improve clarity and added GPU and CPU-only support details.

Update headings in README for clarity

b238da3

Clean up formatting in README.md

b32328b

Removed unnecessary line breaks in the README for better readability.

yanxi-chen reviewed Jan 12, 2026

View reviewed changes

P09s and others added 6 commits January 12, 2026 13:21

Update README.md

196aadc

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

Update README.md

ffc5a97

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

Update README.md

68997f2

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

Update README.md

3cfb821

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

Update README.md

6612cd0

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

Update README.md

1e4dae8

Co-authored-by: Yanxi Chen <153061753+yanxi-chen@users.noreply.github.com>

		+ we have also drawn inspirations from RL frameworks like [OpenRLHF](https://github.com/OpenRLHF/OpenRLHF), [TRL](https://github.com/huggingface/trl), [ChatLearn](https://github.com/alibaba/ChatLearn) and [rLLM](https://github.com/rllm-org/rllm);
		+ ......

Improve documentation for CPU-only users and first-time contributors #474

Are you sure you want to change the base?

Improve documentation for CPU-only users and first-time contributors #474

Conversation

P09s commented Jan 11, 2026

Uh oh!

gemini-code-assist bot commented Jan 11, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

P09s commented Jan 11, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

pan-x-c left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

P09s commented Jan 12, 2026

Uh oh!

yanxi-chen left a comment

Choose a reason for hiding this comment

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yanxi-chen Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants