Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import DocsFolerLink from '../../src/components/DocsFolderLink';

<div align="center">

<img src="https://img.alicdn.com/imgextra/i2/O1CN01R6uYoU1VrrET7d1G6_!!6000000002707-0-tps-1292-407.jpg" width="40%" alt="ROLL Logo" />
Expand Down Expand Up @@ -33,6 +35,8 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource

---



## 🚀 Get Started

[Documents](https://alibaba.github.io/ROLL/)
Expand All @@ -50,39 +54,9 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource

### UserGuide

#### Pipeline Step by Step
[RLVR Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/rlvr_pipeline_start)
[Agentic Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agentic_pipeline_start)
[Agentic Comprehensive Guide](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agent_pipeline_start)
[Distill Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/distill_pipeline_start)

#### Algorithms
[Reinforce++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/Reinforce_Plus_Plus)
[TOPR](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/TOPR)
[GiGPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_GiGPO)
[PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/PPO)
[Lite PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/LitePPO)
[GRPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GRPO)
[GSPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GSPO)
[RAFT++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/RAFT_Plus_Plus)
[StarPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_StarPO)

#### Backend
[DeepSeed](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/deepspeed)
[Megatron](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/megatron)
[vLLM](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/vllm)
[SGLang](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/sglang)

#### Advanced Features
[Agentic Asynchronous Parallel Rollout](https://alibaba.github.io/ROLL/docs/English/UserGuide/agentic_async_parallel_rollout)
[Agentic Asynchronous Training Feature](https://alibaba.github.io/ROLL/docs/English/UserGuide/async_training_agentic)

#### Performance Optimization & Resource Management
[Resource Config](https://alibaba.github.io/ROLL/docs/English/UserGuide/device_mapping)
[GPU Time-Division Multiplexing Control](https://alibaba.github.io/ROLL/docs/English/UserGuide/offload_reload_control)

-----
<DocsFolerLink folder_label="UserGuide" />

---
<div align="center">
We welcome contributions from the community! 🤝
</div>
38 changes: 38 additions & 0 deletions docs_roll/src/components/DocsFolderLink/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import React from 'react';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

function CategoryLink({ item, subLabel }) {
if (item.type === 'link') {
return <div><a href={item.href}>{item.label}</a></div>;
}

if (item.type === 'category') {
return (<div>
{
item.label !== subLabel &&
<h4 style={{ marginTop: 8 }}>{item.label}</h4>
}
<div>
{item.items.sort((a) => a.type === 'link' ? -1 : 1).map(subItem => <CategoryLink item={subItem} subLabel={subLabel} />)}
</div>
</div>)
}

return <div>aa</div>
}

function LinksOfFolder({ folder_label }) {
const category = useCurrentSidebarCategory();

return (
<div>
{/* 这里不再显示这个标题,改为在start里展示,方便对应的页面展示出子导航 */}
{/* <h3>{folder_label}</h3> */}
{category.items.filter(item => item.label === folder_label).sort((a) => a.type === 'link' ? 1 : -1).map(item => <CategoryLink item={item} subLabel={folder_label} />)}
</div>
);
}



export default LinksOfFolder;
2 changes: 1 addition & 1 deletion docs_roll/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export default function Home() {

const history = useHistory();
useEffect(() => {
history.replace('/ROLL/docs/English/QuickStart/start');
history.replace('/ROLL/docs/English/start');
}, [history]);

return (
Expand Down