| 环境变量 |
功能 |
类型 |
取值 |
说明 |
| MS_ROLE |
指定本进程角色。 |
String |
- MS_SCHED: 代表Scheduler进程，一个训练任务只启动一个Scheduler，负责组网，容灾恢复等，不会执行训练代码。
- MS_WORKER: 代表Worker进程，一般设置分布式训练进程为此角色。
- MS_PSERVER: 代表Parameter Server进程，只有在Parameter Server模式下此角色生效，具体请参考Parameter Server模式。
|
Worker和Parameter Server进程会向Scheduler进程注册从而完成组网。 |
| MS_SCHED_HOST |
指定Scheduler的IP地址。 |
String |
合法的IP地址。 |
当前版本还支持Ascend平台下的IPv6地址。在使用IPv6地址进行组网时，环境变量MS_HCCL_CM_INIT必须被设置为1。 |
| MS_SCHED_PORT |
指定Scheduler绑定端口号。 |
Integer |
1024～65535范围内的端口号。 |
|
| MS_NODE_ID |
指定本进程的ID，集群内唯一。 |
String |
代表本进程的唯一ID，默认由MindSpore自动生成。 |
MS_NODE_ID在在以下情况需要设置，一般情况下无需设置，由MindSpore自动生成：
- 开启容灾场景：容灾恢复时需要获取当前进程ID，从而向Scheduler重新注册。
- 开启GLOG日志重定向场景：为了保证各训练进程日志独立保存，需设置进程ID，作为日志保存路径后缀。
- 指定进程rank id场景：用户可通过设置MS_NODE_ID为某个整数，来指定本进程的rank id。
|
| MS_WORKER_NUM |
指定角色为MS_WORKER的进程数量。 |
Integer |
大于0的整数。 |
用户启动的Worker进程数量应当与此环境变量值相等。若小于此数值，组网失败；若大于此数值，Scheduler进程会根据Worker注册先后顺序完成组网，多余的Worker进程会启动失败。
|
| MS_SERVER_NUM |
指定角色为MS_PSERVER的进程数量。 |
Integer |
大于0的整数。 |
只在Parameter Server训练模式下需要设置。 |
| MS_WORKER_IP |
指定当前进程和其他进程进行通信和组网使用的IP地址。 |
String |
合法的IP地址。 |
在使用IPv6地址进行组网时，此环境变量必须被设置。但当用户设置MS_SCHED_HOST为::1时（代表IPv6的本地回环地址），无需设置此环境变量，这是因为MindSpore会默认使用本地回环地址进行通信。 |
| MS_ENABLE_RECOVERY |
开启容灾。 |
Integer |
1代表开启，0代表关闭。默认为0。 |
|
| MS_RECOVERY_PATH |
持久化路径文件夹。 |
String |
合法的用户目录。 |
Worker和Scheduler进程在执行过程中会进行必要的持久化，如用于恢复组网的节点信息以及训练业务中间状态等，并通过文件保存。 |
| MS_HCCL_CM_INIT |
是否使用CM方式初始化HCCL。 |
Integer |
1代表是，其他值代表否。默认为否。 |
此环境变量只在Ascend硬件平台并且通信域数量较多的情况下建议开启。开启此环境变量后，能够降低HCCL集合通信库的内存占用，并且训练任务执行方式与rank table启动方式相同
将此环境变量设置为1时，无法设置图编译等级为O0，否则MindSpore提示Environment variable settings conflict错误。 |
| MS_ENABLE_LCCL |
是否使用LCCL通信库。 |
Integer |
1代表开启，0代表关闭。默认为0。 |
LCCL通信库暂只支持单机多卡，并且必须在KernelByKernel模式下执行。LCCL不支持创建子通信域。 |
| MS_TOPO_TIMEOUT |
集群组网阶段超时时间，单位：秒。 |
Integer |
默认为30分钟。 |
此数值代表在所有节点在这个时间窗口内均可向Scheduler进行注册，超出此时间窗口则注册失败，若节点数量不满足要求，则集群组网失败。建议用户在集群规模较大时配置此环境变量。 |
| MS_NODE_TIMEOUT |
节点心跳超时时间，单位：秒。 |
Integer |
默认为300秒 |
此数值代表Scheduler以及Worker间心跳超时时间，若此时间窗口内没有心跳消息，则集群异常退出。 |
| MS_RECEIVE_MSG_TIMEOUT |
节点接收消息超时时间，单位：秒。 |
Integer |
默认为300秒 |
此数值代表节点接收对端消息超时时间，若时间窗口内无消息响应，则返回空消息。 |
> 环境变量`MS_SCHED_HOST`、`MS_SCHED_PORT`、`MS_WORKER_NUM`内容需保持一致，否则会由于各进程配置不一致导致组网失败。
## 操作实践
动态组网启动脚本在各硬件平台下一致，下面以Ascend为例演示如何编写启动脚本：
> 您可以在这里下载完整的样例代码：[startup_method](https://gitee.com/mindspore/docs/tree/master/docs/sample_code/startup_method)。
目录结构如下：
```text
└─ sample_code
├─ startup_method
├── net.py
├── run_dynamic_cluster.sh
├── run_dynamic_cluster_1.sh
├── run_dynamic_cluster_2.sh
...
```
其中，`net.py`是定义网络结构和训练过程，`run_dynamic_cluster.sh`、`run_dynamic_cluster_1.sh`和`run_dynamic_cluster_2.sh`是执行脚本。
### 1. 准备Python训练脚本
这里以数据并行为例，训练一个MNIST数据集的识别网络。
首先指定运行模式、硬件设备等，与单卡脚本不同，并行脚本还需指定并行模式等配置项，并通过`init()`初始化HCCL、NCCL或MCCL通信域。此处不设置`device_target`会自动指定为MindSpore包对应的后端硬件设备。
```python
import mindspore as ms
from mindspore.communication import init
ms.set_context(mode=ms.GRAPH_MODE)
ms.set_auto_parallel_context(parallel_mode=ms.ParallelMode.DATA_PARALLEL, gradients_mean=True)
init()
ms.set_seed(1)
```
然后构建如下网络：
```python
from mindspore import nn
class Network(nn.Cell):
def __init__(self):
super().__init__()
self.flatten = nn.Flatten()
self.fc = nn.Dense(28*28, 10, weight_init="normal", bias_init="zeros")
self.relu = nn.ReLU()
def construct(self, x):
x = self.flatten(x)
logits = self.relu(self.fc(x))
return logits
net = Network()
```
最后是数据集处理和定义训练过程：
```python
import os
from mindspore import nn
import mindspore as ms
import mindspore.dataset as ds
from mindspore.communication import get_rank, get_group_size
def create_dataset(batch_size):
dataset_path = os.getenv("DATA_PATH")
rank_id = get_rank()
rank_size = get_group_size()
dataset = ds.MnistDataset(dataset_path, num_shards=rank_size, shard_id=rank_id)
image_transforms = [
ds.vision.Rescale(1.0 / 255.0, 0),
ds.vision.Normalize(mean=(0.1307,), std=(0.3081,)),
ds.vision.HWC2CHW()
]
label_transform = ds.transforms.TypeCast(ms.int32)
dataset = dataset.map(image_transforms, 'image')
dataset = dataset.map(label_transform, 'label')
dataset = dataset.batch(batch_size)
return dataset
data_set = create_dataset(32)
loss_fn = nn.CrossEntropyLoss()
optimizer = nn.SGD(net.trainable_params(), 1e-2)
def forward_fn(data, label):
logits = net(data)
loss = loss_fn(logits, label)
return loss, logits
grad_fn = ms.value_and_grad(forward_fn, None, net.trainable_params(), has_aux=True)
grad_reducer = nn.DistributedGradReducer(optimizer.parameters)
for epoch in range(10):
i = 0
for data, label in data_set:
(loss, _), grads = grad_fn(data, label)
grads = grad_reducer(grads)
optimizer(grads)
if i % 10 == 0:
print("epoch: %s, step: %s, loss is %s" % (epoch, i, loss))
i += 1
```
### 2. 准备启动脚本
#### 单机多卡
单机多卡启动脚本内容[run_dynamic_cluster.sh](https://gitee.com/mindspore/docs/blob/master/docs/sample_code/startup_method/run_dynamic_cluster.sh)如下，以单机8卡为例：
```bash
EXEC_PATH=$(pwd)
if [ ! -d "${EXEC_PATH}/MNIST_Data" ]; then
if [ ! -f "${EXEC_PATH}/MNIST_Data.zip" ]; then
wget http://mindspore-website.obs.cn-north-4.myhuaweicloud.com/notebook/datasets/MNIST_Data.zip
fi
unzip MNIST_Data.zip
fi
export DATA_PATH=${EXEC_PATH}/MNIST_Data/train/
rm -rf device
mkdir device
echo "start training"
# 循环启动8个Worker训练进程
for((i=0;i<8;i++));
do
export MS_WORKER_NUM=8 # 设置集群中Worker进程数量为8
export MS_SCHED_HOST=127.0.0.1 # 设置Scheduler IP地址为本地环路地址
export MS_SCHED_PORT=8118 # 设置Scheduler端口
export MS_ROLE=MS_WORKER # 设置启动的进程为MS_WORKER角色
export MS_NODE_ID=$i # 设置进程id，可选
python ./net.py > device/worker_$i.log 2>&1 & # 启动训练脚本
done
# 启动1个Scheduler进程
export MS_WORKER_NUM=8 # 设置集群中Worker进程数量为8
export MS_SCHED_HOST=127.0.0.1 # 设置Scheduler IP地址为本地环路地址
export MS_SCHED_PORT=8118 # 设置Scheduler端口
export MS_ROLE=MS_SCHED # 设置启动的进程为MS_SCHED角色
python ./net.py > device/scheduler.log 2>&1 & # 启动训练脚本
```
> Scheduler和Worker进程的训练脚本内容和启动方式完全一致，这是因为在MindSpore已经差异化处理了两种角色内部流程。用户只需按照普通的训练方式拉起进程即可，无需按照角色修改Python代码。这是动态组网启动脚本在多硬件平台能够保持一致的原因之一。
执行如下指令，即可启动单机8卡训练网络：
```bash
bash run_dynamic_cluster.sh
```
脚本会在后台运行，日志文件会保存到device目录下，结果保存在worker_*.log中，Loss结果如下：
```text
epoch: 0, step: 0, loss is 2.3499548
epoch: 0, step: 10, loss is 1.6682479
epoch: 0, step: 20, loss is 1.4237018
epoch: 0, step: 30, loss is 1.0437132
epoch: 0, step: 40, loss is 1.0643986
epoch: 0, step: 50, loss is 1.1021575
epoch: 0, step: 60, loss is 0.8510884
epoch: 0, step: 70, loss is 1.0581372
epoch: 0, step: 80, loss is 1.0076828
epoch: 0, step: 90, loss is 0.88950706
...
```
#### 多机多卡
多机训练场景下，需拆分启动脚本。下面以执行2机8卡训练，每台机器执行启动4个Worker为例：
脚本[run_dynamic_cluster_1.sh](https://gitee.com/mindspore/docs/blob/master/docs/sample_code/startup_method/run_dynamic_cluster_1.sh)在节点1上启动1个`Scheduler`进程以及4个`Worker`进程：
```bash
EXEC_PATH=$(pwd)
if [ ! -d "${EXEC_PATH}/MNIST_Data" ]; then
if [ ! -f "${EXEC_PATH}/MNIST_Data.zip" ]; then
wget http://mindspore-website.obs.cn-north-4.myhuaweicloud.com/notebook/datasets/MNIST_Data.zip
fi
unzip MNIST_Data.zip
fi
export DATA_PATH=${EXEC_PATH}/MNIST_Data/train/
rm -rf device
mkdir device
echo "start training"
# 循环启动Worker1到Worker4，4个Worker训练进程
for((i=0;i<4;i++));
do
export MS_WORKER_NUM=8 # 设置集群中Worker进程数量为8
export MS_SCHED_HOST=