Skip to content

Commit 7393296

Browse files
117503445PanAndy
authored andcommitted
docs: add quick start guide for Alibaba Cloud Function Compute DevPod
Signed-off-by: 117503445 <t117503445@gmail.com>
1 parent 7d09e85 commit 7393296

5 files changed

Lines changed: 97 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
8080
[Converting MCoreAdapter Models to Hugging Face Format](https://alibaba.github.io/ROLL/docs/User%20Guides/Advanced%20Features/megatron_convert_2_hf)
8181
[Quick Start: Single-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/single_node_quick_start)
8282
[Quick Start: Multi-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/multi_nodes_quick_start)
83+
[Quick Start: Using Alibaba Cloud Function Compute DevPod for Rapid Development](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/aliyun_serverless_devpod_quick_start)
8384
[Frequently Asked Questions](https://alibaba.github.io/ROLL/docs/Getting%20Started/FAQ/qa_issues)
8485

8586
### UserGuide
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Quick Start: Alibaba Cloud Function Compute DevPod for Rapid Development
2+
3+
> DevPod is a rapid development environment provided by Alibaba Cloud Function Compute that can help you quickly deploy and run the ROLL project.
4+
5+
## Prerequisites
6+
7+
Before you begin, ensure you have completed the following preparations:
8+
9+
- You have an Alibaba Cloud account.
10+
- You are logged into the [Function Compute FunModel Console](https://fcnext.console.aliyun.com/fun-model).
11+
- Complete the required RAM role authorization and configuration as guided by the console.
12+
13+
## Create a Training DevPod Environment
14+
15+
1. Click **Create Model - Custom Development**.
16+
2. Select **Custom Environment** and configure as follows:
17+
* **Container Image**: Choose a non-public custom image - Container Image Address - `roll-registry.cn-hangzhou.cr.aliyuncs.com/roll/pytorch:nvcr-24.05-py3-torch260-vllm084`
18+
* **Model Name**: Enter a name, e.g., `roll-dev`
19+
* **Model Source**: Select `No Model`
20+
* **Startup Command**: Keep the default, no modification needed
21+
* **Instance Specification**: Select `GPU Performance Type`
22+
* Click the **DevPod Development & Debugging** button (**Note**: Do *not* click "Create Model Service")
23+
3. Wait for deployment to complete (typically 1–2 minutes).
24+
25+
## Configure and Test
26+
27+
### Download the ROLL Project and Install Dependencies
28+
29+
```bash
30+
# /mnt/ModelName is the default NAS mount point; replace 'roll-dev' with your actual model name
31+
cd /mnt/roll-dev
32+
33+
# 1. Clone the project code
34+
git clone https://github.com/alibaba/ROLL.git
35+
36+
# 2. Install project dependencies
37+
cd ROLL
38+
pip install -r requirements_torch260_vllm.txt -i https://mirrors.aliyun.com/pypi/simple/
39+
```
40+
41+
### Run a Pipeline Example
42+
43+
```bash
44+
bash examples/agentic_demo/run_agentic_pipeline_frozen_lake_single_node_demo.sh
45+
```
46+
47+
For more DevPod usage guidelines, see [https://fun-model-docs.devsapp.net/user-guide/devpod/](https://fun-model-docs.devsapp.net/user-guide/devpod/)

docs_roll/docs/Overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
4646
[Installation](https://alibaba.github.io/ROLL/docs/Getting%20Started/Installation/)
4747
[Quick Start: Single-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/single_node_quick_start)
4848
[Quick Start: Multi-Node Deployment Guide](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/multi_nodes_quick_start)
49+
[Quick Start: Alibaba Cloud Function Compute DevPod for Rapid Development](https://alibaba.github.io/ROLL/docs/Getting%20Started/Quick%20Start/aliyun_serverless_devpod_quick_start)
4950
[Debugging Guide](https://alibaba.github.io/ROLL/docs/Getting%20Started/Debugging%20Guide/debug_guide)
5051
[Frequently Asked Questions](https://alibaba.github.io/ROLL/docs/Getting%20Started/FAQ/qa_issues)
5152

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# 快速上手:使用阿里云函数计算 DevPod 进行快速开发
2+
3+
> DevPod 是阿里云函数计算提供的一种快速开发环境,可以帮助您快速部署和运行 ROLL 项目。
4+
5+
## 先决条件
6+
7+
在开始之前,请确保您已完成以下准备工作:
8+
9+
- 拥有一个阿里云账号
10+
- 登录 [函数计算 FunModel 控制台](https://fcnext.console.aliyun.com/fun-model)
11+
- 根据控制台指引,完成 RAM 相关的角色授权等配置
12+
13+
## 创建训练 DevPod 环境
14+
15+
1. 点击 **创建模型 - 自定义开发**
16+
2. 选择 **自定义环境**,并按如下配置:
17+
* **容器镜像**:选择不可公开访问的自定义镜像 - 容器镜像地址 - `roll-registry.cn-hangzhou.cr.aliyuncs.com/roll/pytorch:nvcr-24.05-py3-torch260-vllm084`
18+
* **模型名称**:输入一个名称,例如 `roll-dev`
19+
* **模型来源**:选中 `无模型`
20+
* **启动命令**:保持默认,无需修改
21+
* **实例规格**:选择 `GPU性能型`
22+
* 点击 **DevPod开发调试** 按钮(**注意**:不要点击"创建模型服务")
23+
3. 等待部署成功(通常 1–2 分钟)。
24+
25+
## 配置和测试
26+
27+
### 下载 ROLL 项目并安装依赖
28+
29+
```bash
30+
# /mnt/模型名称 为默认的 NAS 挂载点,请将 roll-dev 修改为实际的模型名称
31+
cd /mnt/roll-dev
32+
33+
# 1. 克隆项目代码
34+
git clone https://github.com/alibaba/ROLL.git
35+
36+
# 2. 安装项目依赖
37+
cd ROLL
38+
pip install -r requirements_torch260_vllm.txt -i https://mirrors.aliyun.com/pypi/simple/
39+
```
40+
41+
### 运行 pipeline 示例
42+
43+
```bash
44+
bash examples/agentic_demo/run_agentic_pipeline_frozen_lake_single_node_demo.sh
45+
```
46+
47+
更多 DevPod 使用指南,见 [https://fun-model-docs.devsapp.net/user-guide/devpod/](https://fun-model-docs.devsapp.net/user-guide/devpod/)

docs_roll/i18n/zh-Hans/docusaurus-plugin-content-docs/current/Overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
4848
[安装指南](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Installation/)
4949
[快速上手:单机版部署指南](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Quick%20Start/single_node_quick_start)
5050
[快速上手:多节点部署指南](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Quick%20Start/multi_nodes_quick_start)
51+
[快速上手:使用阿里云函数计算 DevPod 进行快速开发](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Quick%20Start/aliyun_serverless_devpod_quick_start)
5152
[ROLL 调试指南](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Debugging%20Guide/debug_guide)
5253
[常见问题解答 (Q&A)](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/FAQ/qa_issues)
5354

0 commit comments

Comments
 (0)