Skip to content

Commit f944d8d

Browse files
committed
update documents
1 parent e7d3fb3 commit f944d8d

File tree

6 files changed

+22
-13
lines changed

6 files changed

+22
-13
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,12 @@ Choose one of the following options:
191191
conda create -n trinity python=3.12
192192
conda activate trinity
193193

194-
# If you have no GPU, skip following two commands and use Tinker instead.
195-
# pip install -e ".[tinker]"
196194
pip install -e ".[verl]"
197195
pip install -e ".[flash_attn]"
196+
197+
# If you have no GPU, comment out the two lines above and uncomment this instead:
198+
# pip install -e ".[tinker]"
199+
198200
# If you encounter issues when installing flash-attn, try:
199201
# pip install flash-attn==2.8.1 --no-build-isolation
200202

@@ -207,10 +209,12 @@ pip install -e ".[dev]" # for development like linting and debugging
207209
python3.10 -m venv .venv
208210
source .venv/bin/activate
209211

210-
# If you have no GPU, skip following two commands and use Tinker instead.
211-
# pip install -e ".[tinker]"
212212
pip install -e ".[verl]"
213213
pip install -e ".[flash_attn]"
214+
215+
# If you have no GPU, comment out the two lines above and uncomment this instead:
216+
# pip install -e ".[tinker]"
217+
214218
# If you encounter issues when installing flash-attn, try:
215219
# pip install flash-attn==2.8.1 --no-build-isolation
216220

@@ -222,7 +226,7 @@ pip install -e ".[dev]" # for development like linting and debugging
222226
[`uv`](https://github.com/astral-sh/uv) is a modern Python package installer.
223227

224228
```bash
225-
uv sync --extra dev --extra flash_attn
229+
uv sync --extra verl --extra dev --extra flash_attn
226230
```
227231

228232

README_zh.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,12 @@ cd Trinity-RFT
190190
conda create -n trinity python=3.12
191191
conda activate trinity
192192

193-
# 如果没有GPU,可以跳过下面的两行命令,改为使用Tinker:
194-
# pip install -e ".[tinker]"
195193
pip install -e ".[verl]"
196194
pip install -e ".[flash_attn]"
195+
196+
# 如果没有GPU,可以注释上两行的命令,改为使用Tinker:
197+
# pip install -e ".[tinker]"
198+
197199
# 如果安装 flash-attn 时遇到问题,可尝试:
198200
# pip install flash-attn==2.8.1 --no-build-isolation
199201

@@ -206,10 +208,12 @@ pip install -e ".[dev]" # 用于调试和开发
206208
python3.10 -m venv .venv
207209
source .venv/bin/activate
208210

209-
# 如果没有GPU,可以跳过下面的两行命令,改为使用Tinker:
210-
# pip install -e ".[tinker]"
211211
pip install -e ".[verl]"
212212
pip install -e ".[flash_attn]"
213+
214+
# 如果没有GPU,可以注释上两行的命令,改为使用Tinker:
215+
# pip install -e ".[tinker]"
216+
213217
# 如果安装 flash-attn 时遇到问题,可尝试:
214218
# pip install flash-attn==2.8.1 --no-build-isolation
215219

@@ -221,7 +225,7 @@ pip install -e ".[dev]" # 用于调试和开发
221225
[`uv`](https://github.com/astral-sh/uv) 是现代的 Python 包管理工具。
222226

223227
```bash
224-
uv sync --extra dev --extra flash_attn
228+
uv sync --extra verl --extra dev --extra flash_attn
225229
```
226230

227231
## 通过 PyPI 安装

scripts/docker/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ RUN chmod 1777 /tmp && apt update && apt install -y \
2727
# copy the Trinity-RFT dir into the workspace
2828
COPY . .
2929

30-
RUN pip install --upgrade pip && pip install -e .[mm,dev] && pip install flash_attn==2.8.1 --no-build-isolation
30+
RUN pip install --upgrade pip && pip install -e .[verl,mm,dev] && pip install flash_attn==2.8.1 --no-build-isolation
3131

3232
# Set Env variables
3333

scripts/docker/Dockerfile.megatron

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ COPY . .
2828

2929
# Install Trinity-RFT with Megatron
3030
RUN pip install --upgrade pip \
31-
&& pip install -e .[mm,dev] \
31+
&& pip install -e .[verl,mm,dev] \
3232
&& pip install flash_attn==2.8.1 --no-build-isolation \
3333
&& pip install -e .[megatron] \
3434
&& NVCC_APPEND_FLAGS="--threads 4" APEX_PARALLEL_BUILD=8 pip install -v \

scripts/docker/Dockerfile.uv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ RUN pip install uv && uv venv /opt/venv --python=python3.12
3535

3636
# Install minimal Trinity-RFT
3737
RUN . /opt/venv/bin/activate && \
38-
uv pip install -e.[mm,dev]
38+
uv pip install -e.[verl,mm,dev]
3939

4040
# Install flash_attn and Megatron
4141
RUN . /opt/venv/bin/activate && \

tests/common/config_test.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ def test_all_examples_are_valid(self):
4545
filename.startswith("train_")
4646
or filename.startswith("verl_")
4747
or filename.startswith("dj_")
48+
or filename.startswith("tinker")
4849
):
4950
print(f"Checking config: {filename}")
5051
config_path = os.path.join(example_dir, example_name, filename)

0 commit comments

Comments
 (0)