Skip to content

Commit e260a3a

Browse files
anisha-amdanisha-amd
authored
Docs: verl framework - installation - 25.11 release (#646)
1 parent 47ff712 commit e260a3a

File tree

3 files changed

+174
-10
lines changed

3 files changed

+174
-10
lines changed

‎docs/install/3rd-party/previous-versions/verl-history.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. meta::
2+
:description: verl version history
3+
:keywords: installation, compatibility, Docker, version, verl, volcano engine, reinforcement learning, AMD, ROCm
4+
5+
********************************************************************************
6+
verl version history
7+
********************************************************************************
8+
9+
This table lists previous versions of the ROCm verl Docker image for
10+
installation and testing. For detailed information about available models,
11+
see the version-specific documentation. You can find tagged
12+
previous releases of the ``ROCm/verl`` Docker image on `Docker Hub
13+
<https://hub.docker.com/r/rocm/verl/tags>`__.
14+
15+
.. list-table::
16+
:header-rows: 1
17+
18+
* - Release
19+
- Version
20+
- Components
21+
- Resources
22+
23+
* - 25.11 (latest)
24+
- `0.6.0 <https://github.com/volcengine/verl/releases/tag/v0.6.0>`__
25+
-
26+
* ROCm 7.0.0
27+
* Ubuntu 22.04
28+
* vllm 0.11.0
29+
* Python 3.12
30+
31+
-
32+
* :doc:`Documentation <../verl-install>`
33+
* `Docker Hub <https://hub.docker.com/r/rocm/verl/tags?name=verl-0.6.0>`__
34+
35+
* - 25.06
36+
- `0.3.0post0 <https://github.com/volcengine/verl/releases/tag/v0.3.0.post0>`__
37+
-
38+
* ROCm 6.2.0
39+
* Ubuntu 20.04
40+
* vllm 0.6.3
41+
* Python 3.9
42+
43+
-
44+
* :doc:`Documentation <verl-install-v25.6>`
45+
* `Docker Hub <https://hub.docker.com/r/rocm/verl/tags?name=verl-0.3.0>`__

‎docs/install/3rd-party/previous-versions/verl-install-v25.6.rst‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
.. meta::
2+
:description: Install verl on ROCm
3+
:keywords: installation, Docker, verl, AMD, ROCm
4+
5+
********************************************************************************
6+
verl on ROCm installation
7+
********************************************************************************
8+
.. caution::
9+
10+
This topic does not reflect the latest version of verl on ROCm documentation. See :doc:`../verl-install` for the latest version.
11+
12+
Volcano Engine Reinforcement Learning for LLMs (`verl <https://verl.readthedocs.io/en/latest/>`__)
13+
is a reinforcement learning framework designed for large language models (LLMs).
14+
15+
This topic covers setup instructions and the necessary files to build, test, and run
16+
verl with ROCm support in a Docker environment. To learn more about verl
17+
on ROCm, including its use cases, recommendations, as well as hardware and software compatibility,
18+
see :doc:`rocm:compatibility/ml-compatibility/verl-compatibility`.
19+
20+
.. note::
21+
22+
verl is supported on ROCm 6.2.0.
23+
24+
Install verl
25+
================================================================================
26+
27+
To install verl on ROCm, you have the following options:
28+
29+
- :ref:`Use the prebuilt Docker image <using-docker-with-verl-pre-installed>` **(recommended)**
30+
- :ref:`Build your own Docker image <build-verl-rocm-docker-image>`
31+
32+
Running verl in a Docker environment is suitable for both runtime and CI workflows.
33+
34+
.. _using-docker-with-verl-pre-installed:
35+
36+
Use a prebuilt Docker image with verl pre-installed
37+
--------------------------------------------------------------------------------
38+
39+
The recommended way to set up a verl environment and avoid potential installation issues is with Docker.
40+
The tested, prebuilt image includes verl, PyTorch, ROCm, and other dependencies.
41+
42+
Prebuilt Docker images with verl configured for ROCm 6.2.0 are available on `Docker Hub <https://hub.docker.com/r/rocm/verl/tags>`_.
43+
44+
1. Pull the Docker image
45+
46+
.. code-block:: bash
47+
48+
docker pull rocm/verl:verl-0.3.0.post0_rocm6.2_vllm0.6.3
49+
50+
2. Launch and connect to the Docker container
51+
52+
.. code-block:: bash
53+
54+
docker run --rm -it --device /dev/dri --device /dev/kfd -p 8265:8265 --group-add video \
55+
--cap-add SYS_PTRACE --security-opt seccomp=unconfined --privileged -v $HOME/.ssh:/root/.ssh \
56+
-v $HOME:$HOME --shm-size 128G -w $PWD --name rocm_verl \
57+
rocm/verl:verl-0.3.0.post0_rocm6.2_vllm0.6.3 /bin/bash
58+
59+
60+
.. _build-verl-rocm-docker-image:
61+
62+
Build your own Docker image
63+
--------------------------------------------------------------------------------
64+
65+
1. Clone the `https://github.com/ROCm/verl <https://github.com/ROCm/verl>`_ repository
66+
67+
.. code-block:: bash
68+
69+
git clone https://github.com/volcengine/verl.git -b v0.3.0.post0
70+
71+
2. Build the Docker container using the Dockerfile in the ``verl/docker`` directory
72+
73+
.. code-block:: bash
74+
75+
cd verl
76+
docker build -f docker/Dockerfile.rocm -t my-rocm-verl
77+
78+
3. Launch and connect to the container
79+
80+
.. code-block:: bash
81+
82+
docker run --rm -it --device /dev/dri --device /dev/kfd -p 8265:8265 --group-add video \
83+
--cap-add SYS_PTRACE --security-opt seccomp=unconfined --privileged -v $HOME/.ssh:/root/.ssh \
84+
-v $HOME:$HOME --shm-size 128G -w $PWD --name rocm_verl \
85+
my-rocm-verl /bin/bash
86+
87+
.. note::
88+
89+
The ``--shm-size`` parameter allocates shared memory for the container. It can be adjusted based on your system's resources.
90+
91+
92+
Test the verl installation
93+
================================================================================
94+
95+
Once connected to the Docker container, verify that verl is installed:
96+
97+
.. code-block:: bash
98+
99+
pip list | grep verl
100+
verl 0.3.0.post0 /app
101+
102+
103+
Run a verl example
104+
================================================================================
105+
106+
The ``/app/examples`` directory contains examples for using verl with ROCm.
107+
These examples are described in the `Reinforcement Learning from Human Feedback on AMD GPUs with verl and ROCm Integration <https://rocm.blogs.amd.com/artificial-intelligence/verl-large-scale/README.html>`_ blog.

‎docs/install/3rd-party/verl-install.rst‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. meta::
22
:description: Install verl on ROCm
3-
:keywords: installation, docker, verl, AMD, ROCm
3+
:keywords: installation, Docker, verl, AMD, ROCm
44

55
********************************************************************************
66
verl on ROCm installation
@@ -16,7 +16,8 @@ see :doc:`rocm:compatibility/ml-compatibility/verl-compatibility`.
1616

1717
.. note::
1818

19-
verl is supported on ROCm 6.2.0.
19+
verl is supported on ROCm 7.0.0 and 6.2.0. This topic provides installation
20+
instructions for ROCm 7.0.0. For ROCm 6.2.0, see :doc:`previous-versions/verl-history`.
2021

2122
Install verl
2223
================================================================================
@@ -36,13 +37,13 @@ Use a prebuilt Docker image with verl pre-installed
3637
The recommended way to set up a verl environment and avoid potential installation issues is with Docker.
3738
The tested, prebuilt image includes verl, PyTorch, ROCm, and other dependencies.
3839

39-
Prebuilt Docker images with verl configured for ROCm 6.2.0 are available on `Docker Hub <https://hub.docker.com/r/rocm/verl/tags>`_.
40+
Prebuilt Docker images with verl configured for ROCm 7.0.0 are available on `Docker Hub <https://hub.docker.com/r/rocm/verl/tags>`_.
4041

4142
1. Pull the Docker image
4243

4344
.. code-block:: bash
4445
45-
docker pull rocm/verl:verl-0.3.0.post0_rocm6.2_vllm0.6.3
46+
docker pull rocm/verl:verl-0.6.0.amd0_rocm7.0_vllm0.11.0.dev
4647
4748
2. Launch and connect to the Docker container
4849

@@ -51,7 +52,7 @@ Prebuilt Docker images with verl configured for ROCm 6.2.0 are available on `Doc
5152
docker run --rm -it --device /dev/dri --device /dev/kfd -p 8265:8265 --group-add video \
5253
--cap-add SYS_PTRACE --security-opt seccomp=unconfined --privileged -v $HOME/.ssh:/root/.ssh \
5354
-v $HOME:$HOME --shm-size 128G -w $PWD --name rocm_verl \
54-
rocm/verl:verl-0.3.0.post0_rocm6.2_vllm0.6.3 /bin/bash
55+
rocm/verl:verl-0.6.0.amd0_rocm7.0_vllm0.11.0.dev /bin/bash
5556
5657
5758
.. _build-verl-rocm-docker-image:
@@ -63,14 +64,18 @@ Build your own Docker image
6364

6465
.. code-block:: bash
6566
66-
git clone https://github.com/volcengine/verl.git -b v0.3.0.post0
67+
git clone https://github.com/ROCm/verl.git
6768
6869
2. Build the Docker container using the Dockerfile in the ``verl/docker`` directory
6970

7071
.. code-block:: bash
7172
7273
cd verl
73-
docker build -f docker/Dockerfile.rocm -t my-rocm-verl
74+
docker build --build-arg VLLM_REPO=https://github.com/vllm-project/vllm.git \
75+
--build-arg VLLM_BRANCH=4ca5cd5740c0cd7788cdfa8b7ec6a27335607a48 \
76+
--build-arg VERL_REPO=https://github.com/ROCm/verl.git \
77+
--build-arg VERL_BRANCH=0eb50ec4a33cda97e05ed8caab9c7f17a30c05a9 \
78+
-f docker/Dockerfile.rocm7 -t my-rocm-verl .
7479
7580
3. Launch and connect to the container
7681

@@ -93,12 +98,19 @@ Once connected to the Docker container, verify that verl is installed:
9398

9499
.. code-block:: bash
95100
96-
pip list | grep verl
97-
verl 0.3.0.post0 /app
101+
pip freeze verl | grep verl
102+
-e git+https://github.com/volcengine/verl.git@0ef0e05b36550a7c8bcce80ee6fe8768dfc47439#egg=verl
98103
99104
100105
Run a verl example
101106
================================================================================
102107

103108
The ``/app/examples`` directory contains examples for using verl with ROCm.
104-
These examples are described in the `Reinforcement Learning from Human Feedback on AMD GPUs with verl and ROCm Integration <https://rocm.blogs.amd.com/artificial-intelligence/verl-large-scale/README.html>`_ blog.
109+
These examples are described in the `Reinforcement Learning from Human
110+
Feedback on AMD GPUs with verl and ROCm Integration <https://rocm.blogs.amd.com/artificial-intelligence/verl-large-scale/README.html>`_ blog.
111+
112+
113+
Previous versions
114+
===============================================================================
115+
See :doc:`previous-versions/verl-history` to find documentation for previous releases
116+
of the ``ROCm/verl`` Docker image.

0 commit comments

Comments
 (0)