docs: Add FAQ section for common questions#92
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive FAQ section to the README.md, detailing Agent-R1's core concepts, setup instructions, and comparisons with other RL frameworks. The review feedback recommends using consistent terminology for token sequences and suggests linking to the existing projects section to avoid content duplication.
| | DeepSeek-R1 | Reasoning | RL for reasoning | Math/coding tasks | | ||
| | RAGEN | RAG agents | RL for retrieval | RAG workflows | | ||
|
|
||
| **Agent-R1's key innovation**: Step-level MDP treats each interaction as a proper RL transition, not one growing token sequence. |
There was a problem hiding this comment.
For consistency with the 'Overview' section (line 51), consider using the term 'ever-growing' to describe the token sequence, which emphasizes the challenge Agent-R1 addresses.
| **Agent-R1's key innovation**: Step-level MDP treats each interaction as a proper RL transition, not one growing token sequence. | |
| **Agent-R1's key innovation**: Step-level MDP treats each interaction as a proper RL transition, not one ever-growing token sequence. |
| ### What projects use Agent-R1? | ||
|
|
||
| - **TableMind**: Tool-augmented table reasoning | ||
| - **PaperScout**: Academic paper search (with PSPO method) | ||
| - **Cast-R1**: Time series forecasting agent |
There was a problem hiding this comment.
This section duplicates the list of projects already detailed in the 'Awesome Projects Using Agent-R1' section (lines 120-126). To improve maintainability and ensure the documentation remains consistent as new projects are added, it is better to link to the existing section.
| ### What projects use Agent-R1? | |
| - **TableMind**: Tool-augmented table reasoning | |
| - **PaperScout**: Academic paper search (with PSPO method) | |
| - **Cast-R1**: Time series forecasting agent | |
| ### What projects use Agent-R1?\n\nSee the [Awesome Projects Using Agent-R1](#awesome-projects-using-agent-r1) section for a list of representative projects built on top of the framework. |
Fixes N/A
Changes
Checklist