Skip to content

Commit 09555e9

Browse files
jingyushenPanAndy
authored andcommitted
(docs): Add docs in README and fix prompt generation guide
1 parent 1f66a59 commit 09555e9

4 files changed

Lines changed: 45 additions & 453 deletions

File tree

README.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,15 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
3737

3838
| 📣 Updates |
3939
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
40-
| **[08/11/2025]** 🎉 Our Paper released, see [Part I: Tricks or Traps? A Deep Dive into RL for LLM Reasoning](https://arxiv.org/abs/2508.08221). |
4140
| **[08/13/2025]** 🎉 ROLL supports AMD GPUs with out-of-box image docker and Dockerfile and specific yamls under `examples/` directory. Please refer to [Installation](https://alibaba.github.io/ROLL/docs/English/QuickStart/installation). |
41+
| **[08/11/2025]** 🎉 Our Paper released, see [Part I: Tricks or Traps? A Deep Dive into RL for LLM Reasoning](https://arxiv.org/abs/2508.08221). |
4242
| **[08/10/2025]** 🎉 Agentic RL supports [stepwise learning](examples/qwen2.5-0.5B-agentic/agent_val_frozen_lake_gigpo.yaml), like [GiGPO](https://arxiv.org/abs/2505.10978); Distill supports [VLM](examples/qwen2.5-vl-7B-distill/distill_vl_megatron.yaml). Explore the new capabilities! |
4343
| **[07/31/2025]** 🎉 Refactor agentic rl design. Support agentic rl [async training](examples/qwen2.5-0.5B-agentic/agent_val_frozen_lake_async.yaml). Explore the new capabilities! |
4444
| **[07/31/2025]** 🎉 Support [DistillPipeline](examples/qwen2.5-7B-distill_megatron/run_distill_pipeline.sh)/[DpoPipeline](examples/qwen2.5-3B-dpo_megatron/run_dpo_pipeline.sh). Support [lora](examples/qwen2.5-7B-rlvr_megatron/rlvr_lora_zero3.yaml). Support [GSPO](https://arxiv.org/abs/2507.18071) |
4545
| **[06/25/2025]** 🎉 Support thread env for env scaling and support qwen2.5 VL agentic pipeline. |
4646
| **[06/13/2025]** 🎉 Support Qwen2.5 VL rlvr pipeline and upgrade mcore to 0.12 version. |
4747
| **[06/09/2025]** 🎉 ROLL tech report is now available! Access the report [here](https://arxiv.org/abs/2506.06122). |
48+
| **[06/08/2025]** 🎉Supports Qwen3(8B/14B/32B), Qwen3-MoE(30A3/235A22), Qwen2.5(7B/14B/32B/72B) LLM models. |
4849
| **[05/30/2025]** 🎉 Training RLVR and Agentic RL with ROLL is now available! Explore the new capabilities. |
4950
---
5051

@@ -54,14 +55,50 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
5455
[Documents](https://alibaba.github.io/ROLL/)
5556

5657
### Quick Start
57-
58-
[Quick Start based on alicloud](https://alibaba.github.io/ROLL/docs/English/StepByStep/alicloud_pipeline_quick_start_en)
5958
[Installation](https://alibaba.github.io/ROLL/docs/English/QuickStart/installation)
60-
[Config guide](https://alibaba.github.io/ROLL/docs/English/QuickStart/config_guide)
59+
[Config System Explanation](https://alibaba.github.io/ROLL/docs/English/QuickStart/config_system)
60+
[Debugging Guide](https://alibaba.github.io/ROLL/docs/English/QuickStart/debugging_guide_en)
61+
[Trackers and Metrics](https://alibaba.github.io/ROLL/docs/English/UserGuide/trackers_and_metrics)
62+
[Checkpoint Saving and Resuming Guide](https://alibaba.github.io/ROLL/docs/English/UserGuide/checkpoint_and_resume)
63+
[Converting MCoreAdapter Models to Hugging Face Format](https://alibaba.github.io/ROLL/docs/English/UserGuide/megatron_convert_2_hf)
64+
[Quick Start: Single-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/English/QuickStart/single_node_quick_start)
65+
[Quick Start: Multi-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/English/QuickStart/multi_node_quick_start)
66+
[Frequently Asked Questions](https://alibaba.github.io/ROLL/docs/English/QuickStart/qa_issues)
67+
68+
### UserGuide
69+
70+
#### Pipeline Step by Step
71+
[RLVR Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/rlvr_pipeline_start)
72+
[Agentic Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agentic_pipeline_start)
73+
[Agentic Comprehensive Guide](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agent_pipeline_start)
74+
[Distill Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/distill_pipeline_start)
75+
76+
#### Algorithms
77+
[Reinforce++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/Reinforce_Plus_Plus)
78+
[TOPR](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/TOPR)
79+
[GiGPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_GiGPO)
80+
[PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/PPO)
81+
[Lite PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/LitePPO)
82+
[GRPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GRPO)
83+
[GSPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GSPO)
84+
[RAFT++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/RAFT_Plus_Plus)
85+
[StarPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_StarPO)
86+
87+
#### Beckend
88+
[DeepSeed](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/deepspeed)
89+
[Megatron](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/megatron)
90+
[LoRA](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/lora)
91+
[vLLM](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/vllm)
92+
[SGLang](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/sglang)
93+
94+
#### Advanced Features
95+
[Agentic Asynchronous Parallel Rollout](https://alibaba.github.io/ROLL/docs/English/UserGuide/agentic_async_parallel_rollout)
96+
[Agentic Asynchronous Training Feature](https://alibaba.github.io/ROLL/docs/English/UserGuide/async_training_agentic)
97+
98+
#### Performance Optimization & Resource Management
99+
[Resource Config](https://alibaba.github.io/ROLL/docs/English/UserGuide/device_mapping)
100+
[GPU Time-Division Multiplexing Control](https://alibaba.github.io/ROLL/docs/English/UserGuide/offload_reload_control)
61101

62-
### Step By Step
63-
[RLVR Pipeline](https://alibaba.github.io/ROLL/docs/English/StepByStep/rlvr_pipeline_start)
64-
[Agentic RL Pipeline](https://alibaba.github.io/ROLL/docs/English/StepByStep/agent_pipeline_start)
65102

66103
---
67104

0 commit comments

Comments
 (0)