Skip to content

docs: Add FAQ section for common questions#92

Open
meichuanyi wants to merge 1 commit into
AgentR1:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section for common questions#92
meichuanyi wants to merge 1 commit into
AgentR1:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Fixes N/A

Changes

  • Add comprehensive FAQ section covering:
    • Project overview and comparison with similar frameworks
    • Key features and capabilities
    • LLM providers and model support
    • Getting started guide
    • Benchmarks and use cases
    • License information
    • Help resources

Checklist

  • Documentation updated
  • FAQ addresses common questions

Copy link
Copy Markdown

@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

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.

Comment thread README.md
| 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
**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.

Comment thread README.md
Comment on lines +191 to +195
### What projects use Agent-R1?

- **TableMind**: Tool-augmented table reasoning
- **PaperScout**: Academic paper search (with PSPO method)
- **Cast-R1**: Time series forecasting agent
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
### 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.

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