update README

README.md

@@ -24,20 +24,147 @@ Step-3引入了两大优化设计:
 
 
 ## 环境配置
+### 硬件需求
+DCU型号：BW1000，节点数量：2 台，卡数：2*8 张。
+
+### 通信配置
+一、节点间基础通信
+
+`在本地机器上配置以下内容：`
+
+1、关闭防火墙：
+```
+systemctl stop  firewalld # 若为centos 
+ufw disable # 若为Ubuntu
+```
+2、设置amd_iommu=on:
+```
+vim /etc/default/grub
+```
+<div align=center>
+    <img src="./figures/amd_iommu.png"/>
+</div>
+
+更新下配置:
+```
+grub2-mkconfig -o /boot/efi/EFI/rocky/grub.cfg
+```
+重启机器后校验是否生效(检查是否存在imxxx=pt)：
+```
+BOOT_IMAGE=(hd0,gpt3)/vmlinuz-4.18.0-372.9.1.el8.x86_64 root=UUID=80974f58-7d23-49bb-bd8b-8e299eb0d188 ro crashkernel=auto rhgb quiet systemd.unified_cgroup_hierachy=1 systemd.unified_cgroup_hierarchy=1 amd_iommu=on iommu=pt
+```
+
+`在后面步骤启动的容器里面配置以下内容：`
+
+```
+apt update
+apt install openssh-server -y
+```
+vim /etc/ssh/sshd_config # 修改下面PermitRootLogin为yes
+```
+# 取消以下4句命令的注释
+RSAAuthentication yes #启用 RSA 认证
+PubkeyAuthentication yes #启用公钥私钥配对认证方式
+AuthorizedKeysFile ~/.ssh/authorized_keys #公钥文件路径（和下面生成的文件同）
+PermitRootLogin yes #root能使用ssh登录
+```
+
+重启ssh服务，并设置开机启动：
+```
+service sshd restart
+chkconfig sshd on
+
+查看sshd状态：service ssh status
+开启sshd服务：/etc/init.d/ssh restart
+```
+
+下面开始设置节点间免密通信的秘钥：
+
+1、ssh-keygen生成秘钥
+```
+ssh-keygen -t ed25519 # 此处以ed25519为例，读者可自己设置为其它名字，遇到提问全部回车键确认
+```
+2、将需要使用的各个节点`~/.ssh/authorized_keys`里的秘钥收集复制到`~/.ssh/id_rsa.pub`，每个节点`~/.ssh/id_rsa.pub`里的所有秘钥最终一致。格式类似如下：
+<div align=center>
+    <img src="./figures/id_rsa.png"/>
+</div>
+
+3、设置节点间的通信端口号
+```
+/usr/sbin/sshd -p 10085 # 不同节点可以设置不同的端口号，打通秘钥和端口号之后可以用ssh -p之类的命令验证节点间是否通信已经通畅，否则需检查前面步骤是否设置成功。
+```
+
+以上设置非标准步骤，不同服务器或集群存在明显差异，无法完全复制此过程，请读者根据自己机器的实际情况灵活采用，总体目标是开启amd_iommu、打通节点间的容器内可以直接免密登录。
+
+二、ray相关通信
+
+`在后面步骤启动的容器里面配置以下内容：`
+```
+vim ~/.bashrc
+```
+在脚本`.bashrc`最后面添加以下命令（以BW200卡的集群为例）：
+
+```
+export ALLREDUCE_STREAM_WITH_COMPUTE=1
+export VLLM_HOST_IP=x.x.x.x
+export NCCL_SOCKET_IFNAME=enp33s0f3u1
+export GLOO_SOCKET_IFNAME=enp33s0f3u1
+unset NCCL_ALGO
+export NCCL_MIN_NCHANNELS=16
+export NCCL_MAX_NCHANNELS=16
+export NCCL_NET_GDR_READ=1
+export HIP_VISIBLE_DEVICES=0,1,2,3,4,5,6,7
+export VLLM_SPEC_DECODE_EAGER=1
+export VLLM_MLA_DISABLE=0
+export VLLM_USE_FLASH_MLA=1
+
+# 若为BW卡，则添加以下信息：
+export NCCL_NET_GDR_LEVEL=7
+export NCCL_SDMA_COPY_ENABLE=0
+export NCCL_IB_HCA=mlx5_2:1,mlx5_3:1,mlx5_4:1,mlx5_5:1,mlx5_6:1,mlx5_7:1,mlx5_8:1,mlx5_9:1
+# 若为K100_AI卡，则添加以下信息(本步骤以BW卡为示例，故注释了以下信息。)：
+# export VLLM_ENFORCE_EAGER_BS_THRESHOLD=44 
+```
+其中`VLLM_HOST_IP`和`NCCL_SOCKET_IFNAME`需要替换成每个自己机器上查到的信息，每个节点的ip不同，查询方式如下：
+```
+通信口和ip查询方法：ifconfig
+VLLM_HOST_IP： 节点本地通信口ip
+NCCL_SOCKET_IFNAME和GLOO_SOCKET_IFNAME： 节点本地通信网口名
+```
+`示例：`
+<div align=center>
+    <img src="./figures/ip.png"/>
+</div>
+
+带BW卡的集群VLLM_HOST_IP需要设置为ib网卡对应的IP，避免出现rccl超时问题：
+
+<div align=center>
+    <img src="./figures/ip_bw.png"/>
+</div>
+
+
+注意：添加完以上信息后需要激活环境变量
+```
+source ~/.bashrc
+```
+
+`Tips：由于通信配置方面属于运维人员的专业内容，以上关于通信的配置建议读者联系运维人员进行配置。`
 
 ### Docker（方法一）
 ```
 docker pull image.sourcefind.cn:5000/dcu/admin/base/custom:vllm-ubuntu22.04-dtk25.04.1-rc5-das1.6-py3.10-20250802-step3
 # <your IMAGE ID>为以上拉取的docker的镜像ID替换
 docker run -it --shm-size=1024G -v $PWD/Step3_pytorch:/home/Step3_pytorch -v /opt/hyhal:/opt/hyhal:ro --privileged=true --device=/dev/kfd --device=/dev/dri/ --group-add video --name step3 <your IMAGE ID> bash
-
+wget --content-disposition 'https://download.sourcefind.cn:65024/file/4/triton/DAS1.6/triton-3.0.0+das.opt1.dtk25041-cp310-cp310-manylinux_2_28_x86_64.whl'
+pip install triton-3.0.0+das.opt1.dtk25041-cp310-cp310-manylinux_2_28_x86_64.whl
 ```
 ### Dockerfile（方法二）
 ```
 cd $PWD/Step3_pytorch/docker
 docker build --no-cache -t step3:latest .
 docker run --shm-size=1024G --name step3 -v /opt/hyhal:/opt/hyhal:ro --privileged=true --device=/dev/kfd --device=/dev/dri/ --group-add video -v $PWD/Step3_pytorch:/home/Step3_pytorch -it step3 bash
-
+wget --content-disposition 'https://download.sourcefind.cn:65024/file/4/triton/DAS1.6/triton-3.0.0+das.opt1.dtk25041-cp310-cp310-manylinux_2_28_x86_64.whl'
+pip install triton-3.0.0+das.opt1.dtk25041-cp310-cp310-manylinux_2_28_x86_64.whl
 ```
 
 ## 数据集
@@ -47,25 +174,25 @@ docker run --shm-size=1024G --name step3 -v /opt/hyhal:/opt/hyhal:ro --privilege
 `无`
 
 ## 推理
-
-注意：运行该模型需要16x64(GB)显存。
+预训练权重目录结构，将后续模型地址切换成实际模型权重地址：
+/home/Step3_pytorch/
+    └── stepfun-ai/step3
 ### 多机多卡
 启动ray集群
 ```
-#head节点执行
-ray start --head --node-ip-address=*.*.*.*（主节点ip） --port=*** --num-gpus=8 --num-cpus=**
+# 启动ray
+# 启动主节点的ray, x.x.x.x 为前面步骤中ifconfig查到的主节点ip（VLLM_HOST_IP），--port为端口号，可以随意设置，保持主节点和其余节点端口号一致。
+ray start --head --node-ip-address=x.x.x.x --port=6379 --num-gpus=8 --num-cpus=16 
+# 启动其它节点的ray,注意 x.x.x.x 为前面步骤中ifconfig查到的主节点ip（VLLM_HOST_IP）。
+ray start --address='x.x.x.x:6379' --num-gpus=8 --num-cpus=16
+# 可用ray status 查看ray的集群启动状态。
 ```
 
-```
-其余节点执行
-ray start --address='*.*.*.*:***' (*.*.*.*:主节点ip,***:port) --num-gpus=8 --num-cpus=**
-```
 
 vLLM Deployment(vllm官方暂不支持AFD，只支持非分离模式部署):
 
 ```
 #head节点执行
-#Tensor Parallelism
 
 VLLM_USE_NN=0 VLLM_USE_FLASH_ATTN_PA=0 vllm serve /path/to/step3 \
     --reasoning-parser step3 \
@@ -79,7 +206,6 @@ VLLM_USE_NN=0 VLLM_USE_FLASH_ATTN_PA=0 vllm serve /path/to/step3 \
     --port $PORT_SERVING 
 
 ```
-` 暂不支持attention data parallelism`
 
 - Client Request Examples
 ```
@@ -171,7 +297,7 @@ chat_response = client.chat.completions.create(
 )
 print("Chat response:", chat_response.choices[0].message.content)
 ```
-
+更多资料可参考源项目中的[`README_origin`](./README_origin.md)。
 ## result
 example1:
 - text:Please describe the image.