Initial commit

Signed-off-by: lijian <lijian6@sugon.com>

Doc/Tutorial_Cpp/Classifier.md

+# 分类器
+
+## 模型简介
+
+本示例使用了经典的mnist模型，模型下载地址：https://github.com/onnx/models/blob/main/vision/classification/mnist/model/mnist-12.onnx，模型结构如下图所示（可以通过netron (https://netron.app/) 查看），该模型的输入shape为[1,1,28,28] ，数据排布为NCHW，输出是10个类别的概率（未归一化）。
+
+![image-20221212165226581](../Images/Classifier_01.png)
+
+​																														
+
+## 预处理
+
+在将数据输入到模型之前，需要对图像做如下预处理操作：
+
+1. 转换为单通道灰度图
+2. resize到28x28
+3. 将像素值归一化到[0.0, 1.0]
+4. 转换数据排布为NCHW
+
+
+
+本示例代码采用了OpenCV的cv::dnn::blobFromImages()函数实现了预处理操作：
+
+```
+ErrorCode Classifier::Classify(const std::vector<cv::Mat> &srcImages,std::vector<std::vector<ResultOfPrediction>> &predictions)
+{
+	...
+	
+    // 预处理
+    cv::Mat inputBlob;
+    cv::dnn::blobFromImages(srcImages,// 输入数据，支持多张图像
+                    inputBlob, // 输出数据
+                    scale, //  缩放系数，这里为1/255.0
+                    inputSize, // 模型输入大小，这里为28x28
+                    meanValue, // 均值，这里不需要减均值，所以设置为0.0
+                    swapRB, // 单通道图像，这里设置为0
+                    false);
+                    
+     ...
+}
+```
+
+cv::dnn::blobFromImages()函数支持多个输入图像，首先将输入图像resize到inputSize，然后减去均值meanValue，最后乘以scale并转换为NCHW，最终将转换好的数据保存到inputBlob中，然后就可以输入到模型中执行推理了。
+
+
+
+## 推理
+
+完成预处理后，就可以执行推理了：
+
+```
+ErrorCode Classifier::Classify(const std::vector<cv::Mat> &srcImages,std::vector<std::vector<ResultOfPrediction>> &predictions)
+{
+	...
+	
+	// 预处理
+	
+	// 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> results = net.eval(inputData);
+
+    // 获取输出节点的属性
+    migraphx::argument result  = results[0]; // 获取第一个输出节点的数据
+   	
+   	...
+   	
+}
+```
+
+1. inputData表示MIGraphX的输入数据，inputData是一个映射关系，每个输入节点名都会对应一个输入数据，如果有多个输入，则需要为每个输入节点名创建数据，inputName表示输入节点名，这里为Input3，migraphx::argument{inputShape, (float*)inputBlob.data}表示该节点名对应的数据，这里是通过前面预处理的数据inputBlob来创建的，第一个参数表示数据的shape，第二个参数表示数据指针。
+2. net.eval(inputData)返回模型的推理结果，由于这里只有一个输出节点，所以std::vector中只有一个数据，results[0]表示第一个输出节点，这里对应Plus214_Output_0节点，获取输出数据之后，就可以对输出数据进行各种操作了。
+3. 由于该模型输出的是一个未归一化的概率，所以如果需要得到每一类的实际的概率值，还需要计算softmax。
+
+
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```
+./MIGraphX_Samples 0
+```
+
+输出结果为：
+
+```
+...
+========== 0 result ==========
+label:0,confidence:0.000000
+label:1,confidence:0.000034
+label:2,confidence:0.000012
+label:3,confidence:0.000169
+label:4,confidence:0.000044
+label:5,confidence:0.000001
+label:6,confidence:0.000000
+label:7,confidence:0.000725
+label:8,confidence:0.000278
+label:9,confidence:0.998737
+```
+
+由于示例图像为数字9，所以结果中label为9的概率最高。
+
+![image-20221212173655309](../Images/Classifier_02.png)
\ No newline at end of file

Doc/Tutorial_Cpp/DynamicShape.md

+# 动态shape(MTCNN人脸检测器)
+
+## 模型简介
+
+动态shape示例程序采用了MTCNN人脸检测器模型中的PNet模型(https://arxiv.org/abs/1604.02878)，论文主页：https://kpzhang93.github.io/MTCNN_face_detection_alignment/index.html。MTCNN中的PNet是一个典型的动态shape模型，PNet网络结构如下图所示，PNet是一个全卷积网络，所以可以输入不同大小的图像。
+
+![image-20221214101121257](../Images/DynamicShape_01.png)
+
+MTCNN检测器在检测之前会对输入图像构建一个图像金字塔，这个图像金字塔中包含了不同尺度的图像，然后将不同尺度的图像依次输入到PNet提取人脸候选区域，经过PNet提取出来的人脸候选区域再经过RNet和ONet进一步筛选和微调得到最后的检测结果。
+
+![image-20221214104253947](../Images/DynamicShape_02.png)
+
+
+
+本示例对原始的PNet模型做了一些调整，训练的时候将输入图像大小修改为24x24，同时将第1个卷积和第3个卷积的步长修改为2。
+
+## 模型转换
+
+论文中作者提供的是Caffe训练好的模型，可以通过caffe-onnx这个工具(https://github.com/htshinichi/caffe-onnx)转换为onnx模型。
+
+
+
+## 设置最大输入shape
+
+由于PNet是一个动态shape模型，所以在推理之前需要设置最大输入shape，Resource/Configuration.xml文件中的DetectorMTCNN节点的MaxHeight和MaxWidth表示最大输入图像的高和宽，可以根据实际情况来定，本示例设置为512和512，程序中通过如下代码设置最大输入shape：
+
+```
+// 设置最大输入大小
+migraphx::onnx_options onnx_options;
+onnx_options.map_input_dims["input"]={1,3,maxHeight,maxWidth};
+```
+
+
+
+## 预处理
+
+在将数据输入到模型之前，需要对图像做如下预处理操作：
+
+1. 减去均值127.5并乘以系数0.0078125
+2. 转换数据排布为NCHW
+
+
+
+本示例代码采用了OpenCV的cv::dnn::blobFromImage()函数实现了预处理操作：
+
+```
+cv::Mat inputBlob = blobFromImage(inputImage, 0.0078125, cv::Size(), cv::Scalar(127.5, 127.5, 127.5), false);
+```
+
+
+
+## 推理
+
+完成预处理后，就可以执行推理了：
+
+```
+	...
+	
+	// 处理图像金字塔的每一级图像
+	for (int k = 0; k < scales.size(); ++k)
+    {
+    	// 输入图像
+        float scale = scales[k];
+        cv::Mat inputImage;
+        cv::Size inputSize=cv::Size(ceil(srcImage.cols*scale), ceil(srcImage.rows*scale));
+        resize(srcImage, inputImage,inputSize, 0, 0, cv::INTER_LINEAR);
+        
+        // 每次输入shape发生变化后，需要对模型进行reshape
+        std::vector<std::size_t> inputShapeOfReshape={1,3,inputSize.height,inputSize.width};
+        std::unordered_map<std::string, std::vector<std::size_t>> inputShapeMap;
+        inputShapeMap[inputName] = inputShapeOfReshape;
+        net.reshape(inputShapeMap);
+
+        // 预处理并转换为NCHW
+		cv::Mat inputBlob = blobFromImage(inputImage, 0.0078125, cv::Size(), cv::Scalar(127.5, 127.5, 127.5), false);
+        
+        // 输入数据
+        migraphx::parameter_map inputData;
+        inputData[inputName]= migraphx::argument{migraphx::shape(inputShape.type(),inputShapeOfReshape), (float*)inputBlob.data};
+
+        // 推理
+        std::vector<migraphx::argument> results = net.eval(inputData);
+
+        ...
+    }
+    
+    ...
+```
+
+1. for循环表示依次处理图像金字塔的每一级图像，由于每一级图像大小都不一样，所以推理之前需要对模型进行reshape操作，每一级图像经过预处理操作之后就可以输入到模型中执行推理了。
+
+2. results表示推理返回的结果，这里表示conv4-2_Y和prob1_Y节点，results中的顺序与onnx中输出节点保持一致，可以通过netron (https://netron.app/) 查看，可以看出results中依次表示conv4-2_Y，prob1_Y节点，
+
+   ![image-20221214201946030](../Images/DynamicShape_04.png)
+
+   返回的结果需要经过进一步的后处理操作才能得到最后的人脸候选区域。
+
+
+
+
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```
+# 设置动态shape模式
+export MIGRAPHX_DYNAMIC_SHAPE=1
+
+# 运行示例
+./MIGraphX_Samples 3
+```
+
+会在当前目录生成检测结果图像Result.jpg
+
+![image-20221214112810405](../Images/DynamicShape_03.png)
\ No newline at end of file

Doc/Tutorial_Cpp/RetinaFace.md

+# RetinaFace人脸检测器
+
+## 模型简介
+
+RetinaFace是一个经典的人脸检测模型(https://arxiv.org/abs/1905.00641)，采用了SSD架构。
+
+![image-20221215140647406](../Images/RetinaFace_01.png)
+
+本示例采用了如下的开源实现：https://github.com/biubug6/Pytorch_Retinaface，作者提供了restnet50 和mobilenet0.25两个预训练模型，本示例使用了mobilenet0.25预训练模型，将mobilenet0.25预训练模型下载下来后，保存到Pytorch_Retinaface工程的weights目录。
+
+
+
+## 模型转换
+
+在将mobilenet0.25预训练模型转换为onnx文件的时候，本示例需要对作者提供的python代码做如下改变：
+
+### 修改models/retinaface.py
+
+1. **将ClassHead类修改为如下实现**
+
+   ```
+   class ClassHead(nn.Module):
+       def __init__(self,inchannels=512,num_anchors=3):
+           super(ClassHead,self).__init__()
+           self.num_anchors = num_anchors
+           self.conv1x1 = nn.Conv2d(inchannels,self.num_anchors*2,kernel_size=(1,1),stride=1,padding=0)
+   
+       def forward(self,x):
+           out = self.conv1x1(x)
+           
+           return out
+   ```
+
+   由于本示例的C++推理代码已经实现了permute操作，所以这里需要去掉out.permute(0,2,3,1).contiguous()。
+
+2. **将BboxHead类修改为如下实现**
+
+   ```
+   class BboxHead(nn.Module):
+       def __init__(self,inchannels=512,num_anchors=3):
+           super(BboxHead,self).__init__()
+           self.conv1x1 = nn.Conv2d(inchannels,num_anchors*4,kernel_size=(1,1),stride=1,padding=0)
+   
+       def forward(self,x):
+           out = self.conv1x1(x)
+   
+           return out
+   ```
+
+   与ClassHead一样，需要去掉permute操作。
+
+3. **将RetinaFace类的forward修改为如下实现**
+
+   ```
+   def forward(self,inputs):
+           out = self.body(inputs)
+   
+           # FPN
+           fpn = self.fpn(out)
+   
+           # SSH
+           feature1 = self.ssh1(fpn[0])
+           feature2 = self.ssh2(fpn[1])
+           feature3 = self.ssh3(fpn[2])
+           features = [feature1, feature2, feature3]
+   
+           bbox_regressions = [self.BboxHead[i](feature) for i, feature in enumerate(features)]
+           classifications = [self.ClassHead[i](feature) for i, feature in enumerate(features)]
+          
+           output=(bbox_regressions[0],classifications[0],bbox_regressions[1],classifications[1],bbox_regressions[2],classifications[2])
+   
+           return output
+   ```
+
+   本示例去掉了landmark检测功能，所以需要去掉forward中的landmark部分，bbox_regressions和classifications需要删除torch.cat操作，同时需要修改output为(bbox_regressions[0],classifications[0],bbox_regressions[1],classifications[1],bbox_regressions[2],classifications[2])。
+
+
+
+### 修改data/config.py
+
+将cfg_mnet中的'pretrain': True,修改为'pretrain': False,
+
+
+
+### 修改convert_to_onnx.py
+
+导出onnx模型的时候，需要修改原来的output_names，可以直接删除torch.onnx._export()的output_names参数或者手动指定每个输出节点的名字，如果直接删除了output_names参数，则会生成一个随机名，本示例直接删除了output_names参数，同时本示例修改了onnx文件名output_onnx，修改后的main函数如下：
+
+```
+if __name__ == '__main__':
+    torch.set_grad_enabled(False)
+    cfg = None
+    if args.network == "mobile0.25":
+        cfg = cfg_mnet
+    elif args.network == "resnet50":
+        cfg = cfg_re50
+    # net and model
+    net = RetinaFace(cfg=cfg, phase = 'test')
+    net = load_model(net, args.trained_model, args.cpu)
+    net.eval()
+    print('Finished loading model!')
+    print(net)
+    device = torch.device("cpu" if args.cpu else "cuda")
+    net = net.to(device)
+
+    # ------------------------ export -----------------------------
+    output_onnx = 'mobilenet0.25_Final.onnx'
+    print("==> Exporting model to ONNX format at '{}'".format(output_onnx))
+    input_names = ["input0"]
+    output_names = ["output0"]
+    inputs = torch.randn(1, 3, args.long_side, args.long_side).to(device)
+
+    torch_out = torch.onnx._export(net, inputs, output_onnx, export_params=True, verbose=False,
+                                   input_names=input_names)
+```
+
+注意：如果需要修改模型的输入大小，可以修改args.long_side参数，默认为640x640。
+
+
+
+完成上述修改后，执行python convert_to_onnx.py命令就可以实现模型转换了，转换成功后会在当前目录生成mobilenet0.25_Final.onnx文件，下面就可以进行推理了。本示例将修改好的工程保存到了samples工程中的Resource/Models/Detector/RetinaFace目录中，在Pytorch_Retinaface目录中执行python convert_to_onnx.py命令可以直接生成onnx文件。
+
+
+
+## 检测器参数设置
+
+samples工程中的Resource/Configuration.xml文件的DetectorRetinaFace节点表示RetinaFace检测器的参数，这些参数是根据Pytorch_Retinaface工程中的data/config.py文件中的cfg_mnet来设置的，下面我们看一下是如何通过cfg_mnet来设置的。
+
+2. **设置anchor大小**
+   cfg_mnet的min_sizes表示每一个priorbox层的anchor大小，我们可以看到该模型一共有3个priorbox层，第一层anchor大小为16和32，第二层anchor大小为64和128，第三层anchor大小为256和512，注意：**Configuration.xml中priorbox层的顺序要与onnx文件中的输出节点顺序保持一致**，通过netron (https://netron.app/) 可以看到首先输出的是467和470节点，这两个节点对应的是特征图最大的检测层，所以对应的anchor大小为16和32，最后输出的是469和472节点，这两个节点对应的是特征图最小的检测层，所以对应的anchor大小为256和512，
+
+   ![image-20221215153957174](../Images/RetinaFace_02.png)
+   
+   
+   所以Configuration.xml配置文件中的参数设置如下：
+   
+   ```
+   <!--priorbox层的个数-->
+   <PriorBoxLayerNumber>3</PriorBoxLayerNumber>
+   
+   <!--每个priorbox层的minisize-->
+   <MinSize11>16</MinSize11>
+   <MinSize12>32</MinSize12>
+   <MinSize21>64</MinSize21>
+   <MinSize22>128</MinSize22>
+   <MinSize31>256</MinSize31>
+   <MinSize32>512</MinSize32>
+   ```
+   
+3. **设置Flip和Clip**
+   cfg_mnet中的clip为False，所以Configuration.xml中对应的参数设置为0即可，由于只有一个宽高比为1的anchor，所以Flip设置为0。
+
+   ```
+   <Flip1>0</Flip1>
+   <Flip2>0</Flip2>
+   <Flip3>0</Flip3>
+   
+   <Clip1>0</Clip1>
+   <Clip2>0</Clip2>
+   <Clip3>0</Clip3>
+   ```
+
+4. **设置anchor的宽高比**
+   由于RetinaFace只包含宽高比为1的anchor，所以这里不需要设置宽高比。
+
+5. **设置每个priorbox层的步长**
+   cfg_mnet中的steps表示每个priorbox层的步长，所以三个priorbox的步长依次为8,16,32，对应的Configuration.xml的设置如下：
+
+   ```
+   <!--每个priorbox层的step-->
+   <PriorBoxStepWidth1>8</PriorBoxStepWidth1><!--第一个priorbox层的step的width-->
+   <PriorBoxStepWidth2>16</PriorBoxStepWidth2>
+   <PriorBoxStepWidth3>32</PriorBoxStepWidth3>
+   
+   <PriorBoxStepHeight1>8</PriorBoxStepHeight1><!--第一个priorbox层的step的height-->
+   <PriorBoxStepHeight2>16</PriorBoxStepHeight2>
+   <PriorBoxStepHeight3>32</PriorBoxStepHeight3>
+   ```
+
+6. **设置DetectionOutput层的参数**
+
+   由于本示例模型是一个人脸检测模型，所以只有两类目标（背景和人脸），所以ClassNumber为2，DetectionOutput层的其他参数可以根据实际情况做微调，本示例中采用如下设置：
+
+   ```
+   <TopK>400</TopK>
+   <KeepTopK>200</KeepTopK>
+   <NMSThreshold>0.3</NMSThreshold>
+   <ConfidenceThreshold>0.9</ConfidenceThreshold>
+   ```
+
+
+
+## 预处理
+
+在将数据输入到模型之前，需要对图像做如下预处理操作：
+
+1. 减去均值，RetinaFace训练的时候对图像做了减均值的操作(train.py文件中的第38行)，注意均值的顺序是BGR顺序。
+2. 转换数据排布为NCHW
+
+
+
+本示例代码采用了OpenCV的cv::dnn::blobFromImage()函数实现了预处理操作：
+
+```
+ErrorCode DetectorRetinaFace::Detect(const cv::Mat &srcImage,std::vector<ResultOfDetection> &resultsOfDetection)
+{
+	...
+
+    // 预处理并转换为NCHW
+    cv::Mat inputBlob;
+    blobFromImage(srcImage,   // 输入数据
+                    inputBlob, // 输出数据
+                    scale, // 1
+                    inputSize, // SSD输入大小，本示例为640x480
+                    meanValue,// (104,117,123)
+                    swapRB, // false
+                    false);
+    
+    ...
+ }
+```
+
+
+
+## 推理
+
+模型转换成功并且设置好检测器参数之后就可以执行推理了。
+
+```
+ErrorCode DetectorRetinaFace::Detect(const cv::Mat &srcImage,std::vector<ResultOfDetection> &resultsOfDetection)
+{
+
+    ...
+ 
+    // 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> inferenceResults=net.eval(inputData);
+    vector<vector<float>> regressions;
+    vector<vector<float>> classifications;
+    for(int i=0;i<ssdParameter.numberOfPriorBoxLayer;++i) // 执行Permute操作
+    {
+        int numberOfPriorBox=ssdParameter.detectInputChn[i]/(4*(ssdParameter.priorBoxHeight[i] * ssdParameter.priorBoxWidth[i]));
+
+        // BboxHead
+        std::vector<float> regression;
+        migraphx::argument result0  = inferenceResults[2*i]; 
+        result0.visit([&](auto output) { regression.assign(output.begin(), output.end()); });
+        regression=PermuteLayer(regression,ssdParameter.priorBoxWidth[i],ssdParameter.priorBoxHeight[i],numberOfPriorBox*4);
+        regressions.push_back(regression);
+        
+        // ClassHead
+        std::vector<float> classification;
+        migraphx::argument result1  = inferenceResults[2*i+1]; 
+        result1.visit([&](auto output) { classification.assign(output.begin(), output.end()); });
+        classification=PermuteLayer(classification,ssdParameter.priorBoxWidth[i],ssdParameter.priorBoxHeight[i],numberOfPriorBox*ssdParameter.classNum);
+        classifications.push_back(classification);
+    }
+
+    // 对推理结果进行处理，得到最后SSD检测的结果
+    GetResult(classifications,regressions,resultsOfDetection);
+
+    // 转换到原图坐标
+    for(int i=0;i<resultsOfDetection.size();++i)
+    {
+        float ratioOfWidth=(1.0*srcImage.cols)/inputSize.width;
+        float ratioOfHeight=(1.0*srcImage.rows)/inputSize.height;
+
+        resultsOfDetection[i].boundingBox.x*=ratioOfWidth;
+        resultsOfDetection[i].boundingBox.width*=ratioOfWidth;
+        resultsOfDetection[i].boundingBox.y*=ratioOfHeight;
+        resultsOfDetection[i].boundingBox.height*=ratioOfHeight;
+    }
+
+    // 按照置信度排序
+    sort(resultsOfDetection.begin(), resultsOfDetection.end(),CompareConfidence);
+
+    return SUCCESS;
+
+}
+```
+
+1. net.eval(inputData)返回推理结果，顺序与onnx输出保持一致，可以通过netron查看输出节点顺序，其中inferenceResults[2 * i]表示每个检测层的BboxHead的输出，inferenceResults [2 * i + 1]表示每个检测层的ClassHead的输出。
+
+1. 经过PermuteLayer处理之后的所有检测层数据通过GetResult()得到最后的输出结果，注意这里的输出结果还不是最后的检测结果，最后需要转换到原图坐标才能够得到最终的检测结果。
+
+
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```
+./MIGraphX_Samples 2
+```
+
+会在当前目录生成检测结果图像Result.jpg
+
+![image-20221215164140724](../Images/RetinaFace_03.png)
\ No newline at end of file

Doc/Tutorial_Cpp/SSD.md

+# SSD检测器
+
+## 模型简介
+
+SSD检测器示例使用了经典的SSD算法(https://arxiv.org/abs/1512.02325)，原论文作者使用Caffe框架实现，本示例采用的是于仕琪老师开源的YuFaceDetectNet人脸检测模型，最初也是采用Caffe框架实现的，从下面的commit对应的工程中可以下载到Caffe模型：https://github.com/ShiqiYu/libfacedetection/commit/54b8e036b299b4763afa6a74af2502a8b13eb0ad，模型在libfacedetection/models/caffe目录下，该目录下同时提供了训练和部署的模型结构，本示例采用了yufacedetectnet-open-v2模型。
+
+
+
+## 模型转换
+
+由于MIGraphX不支持YuFaceDetectNet模型中的Permute，PriorBox和DetectionOutput这几个层，所以需要对模型做一些修改，基本的思路就是让MIGraphX不支持的层在CPU上运行。
+
+![image-20221214191602193](../Images/SSD_01.png)
+
+图中黄色部分为MIGraphX不支持的层，导出onnx模型的时候需要删除这些层，将这些层都放到CPU上执行。  修改Resource/Models/Detector/SSD/yufacedetectnet-open-v2.prototxt文件的时候，直接删除不支持的层即可，修改后的文件为Resource/Models/Detector/SSD/yufacedetectnet-open-v2_onnx.prototxt文件，可以使用比较工具查看修改的部分，使用yufacedetectnet-open-v2_onnx.prototxt和yufacedetectnet-open-v2.caffemodel通过caffe-onnx(https://github.com/htshinichi/caffe-onnx)这个转换工具就可以将Caffe模型转换为onnx模型了。
+
+注意：使用Caffe训练SSD模型的时候，需要去掉Normalize层，否则使用caffe-onnx工具转换模型的时候会失败，本示例中直接将yufacedetectnet-open-v2.prototxt中的Normalize层去掉了。
+
+
+
+## SSD参数设置
+
+在运行模型前，需要设置SSD模型的参数，Resource/Configuration.xml文件中的DetectorSSD节点对应了本示例使用的YuFaceDetectNet检测器的参数，下面看一下是如何根据yufacedetectnet-open-v2.prototxt设置Configuration.xml中的参数的，可以使用netscope (http://ethereon.github.io/netscope/#/editor ) 可视化.prototxt文件，方便观察模型结构，在yufacedetectnet-open-v2.prototxt中一共有4个priorbox层，分别为conv3_3_norm_mbox_priorbox，conv4_3_norm_mbox_priorbox，conv5_3_norm_mbox_priorbox，conv6_3_norm_mbox_priorbox，以conv3_3_norm_mbox_priorbox为例，其prototxt文件中的代码如下：
+
+```
+layer {
+  name: "conv3_3_norm_mbox_priorbox"
+  type: "PriorBox"
+  bottom: "conv3_3_norm"
+  bottom: "data"
+  top: "conv3_3_norm_mbox_priorbox"
+  prior_box_param {
+    min_size: 10.0
+    min_size: 16.0
+    min_size: 24.0
+    clip: false
+    variance: 0.10000000149
+    variance: 0.10000000149
+    variance: 0.20000000298
+    variance: 0.20000000298
+    step: 8.0
+    offset: 0.5
+  }
+}
+```
+
+一共有3个min_size：10,16,24，同时clip为fase且step为8，该层没有设置flip参数，所以采用默认值true（注：如果该层只有一个宽高比为1的anchor，则flip参数可以设置为false），由于该priorbox层没有设置其他宽高比，只包含一个宽高比为1的anchor，所以Configuration.xml中不需要设置宽高比，所以配置文件中对应的参数为：
+
+```
+<MinSize11>10</MinSize11>
+<MinSize12>16</MinSize12>
+<MinSize13>24</MinSize13>
+
+<Flip1>0</Flip1>
+
+<Clip1>0</Clip1>
+
+<PriorBoxStepWidth1>8</PriorBoxStepWidth1>
+
+<PriorBoxStepHeight1>8</PriorBoxStepHeight1>
+```
+
+如果你需要添加其他宽高比的anchor，在设置priorbox层参数的时候需要注意：Configuration.xml中AspectRatio参数设置的时候不需要包含1，因为程序中默认已经添加1了，同时需要忽略flip参数，比如现在有4个priorbox层，每一层的宽高比设置为0.3333和0.25且flip为true，则每一层只需要写0.3333和0.25即可，xml代码如下：
+
+```
+<AspectRatio11>0.3333</AspectRatio11>
+<AspectRatio12>0.25</AspectRatio12>
+<AspectRatio21>0.3333</AspectRatio21>
+<AspectRatio22>0.25</AspectRatio22>
+<AspectRatio31>0.3333</AspectRatio31>
+<AspectRatio32>0.25</AspectRatio32>
+<AspectRatio41>0.3333</AspectRatio41>
+<AspectRatio42>0.25</AspectRatio42>
+```
+
+其他priorbox层参数的设置与conv3_3_norm_mbox_priorbox类似，这里需要注意：**Configuration.xml中priorbox层的顺序要与onnx文件中的输出节点顺序保持一致**，通过netron (https://netron.app/) 查看到onnx文件的输出顺序如下：
+
+![image-20221214202259180](../Images/SSD_02.png)
+
+所以Configuration.xml中priorbox层的顺序为conv3_3_norm_mbox_priorbox，conv4_3_norm_mbox_priorbox，conv5_3_norm_mbox_priorbox，conv6_3_norm_mbox_priorbox，所以Configuration.xml中minisize参数设置如下：
+
+```
+<MinSize11>10</MinSize11> <!--conv3_3_norm_mbox_priorbox-->
+<MinSize12>16</MinSize12>
+<MinSize13>24</MinSize13>
+<MinSize21>32</MinSize21> <!--conv4_3_norm_mbox_priorbox-->
+<MinSize22>48</MinSize22>
+<MinSize31>64</MinSize31> <!--conv5_3_norm_mbox_priorbox-->
+<MinSize32>96</MinSize32>
+<MinSize41>128</MinSize41> <!--conv6_3_norm_mbox_priorbox-->
+<MinSize42>192</MinSize42>
+<MinSize43>256</MinSize43>
+```
+
+设置好priorbox参数后，还需要设置DetectionOutput层的参数，由于本示例模型是一个人脸检测模型，所以只有两类目标（背景和人脸），所以ClassNumber为2，DetectionOutput层的其他参数可以根据实际情况做微调，本示例中采用如下设置：
+
+```
+<TopK>400</TopK>
+<KeepTopK>200</KeepTopK>
+<NMSThreshold>0.3</NMSThreshold>
+<ConfidenceThreshold>0.9</ConfidenceThreshold>
+```
+
+
+
+## 预处理
+
+在将数据输入到模型之前，需要对图像做如下预处理操作：
+
+1. 减去均值，本示例使用的模型不需要减均值
+2. 转换数据排布为NCHW
+
+本示例代码采用了OpenCV的cv::dnn::blobFromImage()函数实现了预处理操作：
+
+```
+ErrorCode DetectorSSD::Detect(const cv::Mat &srcImage,std::vector<ResultOfDetection> &resultsOfDetection)
+{
+	...
+
+    // 预处理并转换为NCHW
+    cv::Mat inputBlob;
+    blobFromImage(srcImage,   // 输入数据
+                    inputBlob, // 输出数据
+                    scale, // 1
+                    inputSize, // SSD输入大小，本示例为640x480
+                    meanValue,// 本示例不需要减均值，这里设置为0
+                    swapRB, // false
+                    false);
+    
+    ...
+ }
+```
+
+
+
+## 推理
+
+模型转换成功并且设置好SSD参数之后就可以执行推理了，对于MIGraphX不支持的SSD层，需要在CPU上实现，示例代码Src/Detector/DetectorSSD.h中的PermuteLayer(),PriorBoxLayer(),DetectionOutputLayer()分别实现了对应的层。
+
+```
+ErrorCode DetectorSSD::Detect(const cv::Mat &srcImage,std::vector<ResultOfDetection> &resultsOfDetection)
+{
+
+    ...
+ 
+    // 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> inferenceResults=net.eval(inputData);
+    vector<vector<float>> regressions;
+    vector<vector<float>> classifications;
+    for(int i=0;i<ssdParameter.numberOfPriorBoxLayer;++i) // 执行Permute操作
+    {
+        int numberOfPriorBox=ssdParameter.detectInputChn[i]/(4*(ssdParameter.priorBoxHeight[i] * ssdParameter.priorBoxWidth[i]));
+
+        // 回归
+        std::vector<float> regression;
+        migraphx::argument result0  = inferenceResults[2*i]; 
+        result0.visit([&](auto output) { regression.assign(output.begin(), output.end()); });
+        regression=PermuteLayer(regression,ssdParameter.priorBoxWidth[i],ssdParameter.priorBoxHeight[i],numberOfPriorBox*4);
+        regressions.push_back(regression);
+        
+        // 分类
+        std::vector<float> classification;
+        migraphx::argument result1  = inferenceResults[2*i+1]; 
+        result1.visit([&](auto output) { classification.assign(output.begin(), output.end()); });
+        classification=PermuteLayer(classification,ssdParameter.priorBoxWidth[i],ssdParameter.priorBoxHeight[i],numberOfPriorBox*ssdParameter.classNum);
+        classifications.push_back(classification);
+    }
+
+    // 对推理结果进行处理，得到最后SSD检测的结果
+    GetResult(classifications,regressions,resultsOfDetection);
+
+    // 转换到原图坐标
+    for(int i=0;i<resultsOfDetection.size();++i)
+    {
+        float ratioOfWidth=(1.0*srcImage.cols)/inputSize.width;
+        float ratioOfHeight=(1.0*srcImage.rows)/inputSize.height;
+
+        resultsOfDetection[i].boundingBox.x*=ratioOfWidth;
+        resultsOfDetection[i].boundingBox.width*=ratioOfWidth;
+        resultsOfDetection[i].boundingBox.y*=ratioOfHeight;
+        resultsOfDetection[i].boundingBox.height*=ratioOfHeight;
+    }
+
+    // 按照置信度排序
+    sort(resultsOfDetection.begin(), resultsOfDetection.end(),CompareConfidence);
+
+    return SUCCESS;
+
+}
+```
+
+1. net.eval(inputData)返回推理结果，顺序与onnx输出保持一致，可以通过netron查看输出节点顺序，其中inferenceResults[2 * i]表示每个检测层的回归节点的输出，inferenceResults [2 * i + 1]表示每个检测层的分类节点的输出。
+
+1. 经过PermuteLayer层处理之后的所有检测层数据通过GetResult()得到最后的输出结果，注意这里的输出结果还不是最后的检测结果，最后需要转换到原图坐标才能够得到最终的检测结果。
+
+
+
+
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```
+./MIGraphX_Samples 1
+```
+
+会在当前目录生成检测结果图像Result.jpg
+
+![image-20221214203849188](../Images/SSD_03.png)
\ No newline at end of file

Doc/Tutorial_Cpp/Super_Resolution.md

+# 超分辨率重建
+
+## 模型简介
+
+图像超分辨率重建技术是指设计并采用某种算法，使得可以通过观测到的低分辨率（Low Resolution, LR）图像重建出近似真实高分辨率（High Resolution , HR）图像的方法。本次部署的超分辨率模型是2016提出的ESPCN网络，主要通过一系列卷积层不断提取图像特征，最后通过sub-pixel亚像素卷积层提高图像分辨率，从而实现图像超分辨率的方法。ESPCN网络结构如下图所示
+![Superresolution_01](../Images/Superresolution_01.png)
+
+本示例采用onnx官方提供的ESPCN模型示例：https://github.com/onnx/models/tree/main/vision/super_resolution/sub_pixel_cnn_2016，将super.onnx文件保存在Resource\Models\Super_Resolution文件夹下。
+
+## 参数设置
+
+samples工程中的Resource/Configuration.xml文件的Espcn节点表示超分辨率模型Espcn的参数，主要包括模型存放路径。
+
+```xml
+<!--超分辨率重建-->
+<Espcn>
+	<ModelPath>"../Resource/Models/Super_Resolution/super.onnx"</ModelPath>
+</Espcn>
+```
+
+## 模型初始化
+
+首先，通过parse_onnx()函数加载图像超分辨率ESPCN的onnx模型，并可以通过program的get_parameter_shapes()函数获取网络的输入属性。完成模型加载之后需要使用compile()方法编译模型，编译模式使用migraphx::gpu::target{}设为GPU模式，编译过程主要基于MIGraphX IR完成各种优化。
+
+```C++
+ErrorCode Espcn::Initialize(InitializationParameterOfSuperresolution initParamOfSuperresolutionESPCN)
+{
+    
+    ...  
+        
+    // 加载模型
+    net = migraphx::parse_onnx(modelPath);       // 根据提供的模型地址，去加载模型文件
+    LOG_INFO(logFile,"succeed to load model: %s\n",GetFileName(modelPath).c_str());
+
+    // 获取模型输入属性
+    std::pair<std::string, migraphx::shape> inputAttribute=*(net.get_parameter_shapes().begin());
+    inputName=inputAttribute.first;
+    inputShape=inputAttribute.second;
+    inputSize=cv::Size(inputShape.lens()[3],inputShape.lens()[2]);     
+
+    // 设置模型为GPU模式
+    migraphx::target gpuTarget = migraphx::gpu::target{};
+
+    // 编译模型
+    migraphx::compile_options options;
+    options.device_id=0;                          // 设置GPU设备，默认为0号设备(>=1.2版本中支持)
+    options.offload_copy=true;                    // 设置offload_copy
+    net.compile(gpuTarget,options);               
+    LOG_INFO(logFile,"succeed to compile model: %s\n",GetFileName(modelPath).c_str());
+    
+    ...
+        
+}
+```
+
+## 预处理
+
+完成模型初始化之后，需要将输入数据进行如下预处理：
+
+​      1.分离图像通道，变为B、G、R三个通道图像；
+
+​      2.BGR格式通过公式转换为YCbCr格式，得到Y、Cb、Cr三通道图像；
+
+​      3.Y通道图像resize到224x224，变为浮点型数据，并转换数据排布为NCHW；
+
+本示例代码主要采用如下方式完成预处理操作：
+
+```c++
+ErrorCode Espcn::Super(const cv::Mat &srcImage, cv::Mat &superImage)
+{
+    ...
+        
+    // 图像预处理(分离图像通道，只处理Y通道的图像，进行模型推理)
+    // 分离图像通道
+    std::vector<cv::Mat> channels;
+    cv::split(srcImage, channels);     // B通道=channels[0]，G通道=channels[1]，R通道=channels[2]
+
+    // 将BGR格式转换为YCbCr格式，采用opencv官方转换公式
+    cv::Mat Y_channels = 0.299*channels[2] + 0.587*channels[1] + 0.114*channels[0];
+    cv::Mat Cb_channels = (channels[0]-Y_channels) * 0.564 + 128;
+    cv::Mat Cr_channels = (channels[2]-Y_channels) * 0.713 + 128;
+
+    // 将Y通道图像resize为224x224，变为浮点型数据，并转换数据排布为NCHW
+    cv::Mat inputBlob;
+    cv::dnn::blobFromImage(Y_channels,    // 输入数据，支持多张图像
+                    inputBlob,            // 输出数据
+                    1/255.0,              // 缩放系数
+                    inputSize,            // 模型输入大小，这里为672x672
+                    Scalar(0, 0, 0),      // 均值，这里不需要减均值，所以设置为0
+                    false,                // 通道转换，因为只处理Y通道数据，不需要通道转换，所以设置为false
+                    false);
+    
+     ...
+         
+}
+```
+
+1.在预处理过程中，重要的是BGR格式转换为YCbCr格式，主要是因为相较于色差，人类视觉对亮度变化更为敏感。因此，在处理的过程中感兴趣的不是颜色变化(存储在 CbCr 通道中的信息)，而只是其亮度(Y 通道)，所以需要将BGR转换为YCbCr，转换公式采用的是opencv官方提供的公式，链接：https://docs.opencv.org/3.4.11/de/d25/imgproc_color_conversions.html。
+
+2.得到Y通道图像后，需要resize为固定尺寸并转换为NCHW，主要采用cv::dnn::blobFromImage()函数。首先将输入图像resize到inputSize，然后减去均值，其次乘以缩放系数1/255.0并转换为NCHW，最终将转换好的数据保存到inputBlob作为输入数据执行推理。
+
+## 推理
+
+完成图像预处理后，就可以执行推理，得到推理结果。
+
+```C++
+ErrorCode Espcn::Super(const cv::Mat &srcImage, cv::Mat &superImage)
+{
+    
+    ...
+        
+    // 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> results = net.eval(inputData);
+
+    // 获取输出节点的属性
+    migraphx::argument result = results[0];                 // 获取第一个输出节点的数据
+    migraphx::shape outputShape=result.get_shape();         // 输出节点的shape
+    std::vector<std::size_t> outputSize=outputShape.lens(); // 每一维大小，维度顺序为(N,C,H,W) 
+    int numberOfOutput=outputShape.elements();              // 输出节点元素的个数
+    float *data = (float *)result.data();                   // 输出节点数据指针
+
+    // 获取推理结果，是重建后每个像素点的像素值，创建一个cv::Mat，依次在对应位置处赋予像素值。
+    cv::Mat output_Y = cv::Mat_<float>(Size(outputShape.lens()[3], outputShape.lens()[2]), CV_32F);   //规定尺寸大小
+    for(int i=0;i<outputShape.lens()[2];++i)
+    {
+        for(int j=0;j<outputShape.lens()[3];++j){
+            output_Y.at<float>(i,j)=data[672*i+j];   // 其中，672代表了outputShape.lens()[3]的值
+        }
+    }
+
+    // 将32F格式的数据变为8U格式的数据
+    cv::Mat output_Y8;
+    output_Y.convertTo(output_Y8, CV_8U, 255.0);      // 转换为无符号8位像素数据类型，0-255是大多数图像和视频格式的正常范围
+
+    ...
+    
+    // 将YCbCr转换为BGR
+    cv::Mat B_output = output_Y8 + 1.773 * (Cb_output - 128);
+    cv::Mat G_output = output_Y8 - 0.714 * (Cr_output - 128) - 0.344 * (Cb_output - 128);
+    cv::Mat R_output = output_Y8 + 1.403 * (Cr_output - 128);
+
+    // 将BGR三通道图像合并到一起
+    std::vector<cv::Mat> channels2;
+    channels2.push_back(B_output);
+    channels2.push_back(G_output);
+    channels2.push_back(R_output);
+    cv::merge(channels2, superImage);
+    
+    return SUCCESS;
+}
+```
+
+1.inputData表示MIGraphX的输入数据，这里表示为Y通道图像数据，inputName表示输入节点名，migraphx::argument{inputShape, (float*)inputBlob.data}表示该节点名对应的数据，这里通过前面的预处理数据inputBlob来创建的，第一个参数表示数据的shape，第二个参数表示数据指针。
+
+2.net.eval(inputData)返回模型的推理结果，由于这里只有一个输出节点，所以std::vector中只有一个数据，results[0]表示第一个输出节点，获取输出数据之后，就可以对输出数据执行相关后处理操作。
+
+3.推理结果为重建后的图像像素点值，创建一个cv::Mat，尺寸为672x672，通过output_Y.at<float>(i,j)=data[672*i+j]按行赋相应像素值。最后，将YCbCr转换为BGR，并将三通道合并到一起,得到最终的重建图像。
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```Python
+./ MIGraphX_Samples 7
+```
+
+会在当前目录中生成检测结果图像Result.jpg。
+结果如下，左图为原图，有图为重建过后的图像，分辨率提高了三倍。
+![Superresolutin_02](../Images/Superresolution_02.png)

Doc/Tutorial_Cpp/Unet.md

+# 图像分割
+
+本示例采用了经典的Unet模型进行图像分割，模型下载地址：https://www.dropbox.com/s/3ntkhyk30x05uuv/unet_13_256.onnx，将unet_13_256.onnx文件保存在Resource\Models\Segmentation文件夹下。模型结构如下图所示（可以通过netron工具（https://netron.app/）查看具体的模型结构），该模型的输入shape为[batch_size,3,256,256]，输出shape为[batch_size,1,256,256]，数据排布为NCHW。
+
+![Unet_Image_1](../Images/Unet_Image_1.png)
+
+## 参数设置
+
+samples工程中的Resource/Configuration.xml文件的Unet节点表示图像分割模型Unet的参数，主要包括模型存放路径。
+
+```xml
+<!--Unet-->
+<Unet>
+	<ModelPath>"../Resource/Models/Segmentation/unet_13_256.onnx"</ModelPath>
+</Unet>
+```
+
+## 模型初始化
+
+首先，通过parse_onnx()函数加载图像分割Unet的onnx模型，并可以通过program的get_parameter_shapes()函数获取网络的输入属性。完成模型加载之后需要使用compile()方法编译模型，编译模式使用migraphx::gpu::target{}设为GPU模式，编译过程主要基于MIGraphX IR完成各种优化。
+
+```C++
+ErrorCode Unet::Initialize(InitializationParameterOfSegmentation initParamOfSegmentationUnet)
+{
+    
+    ...
+
+    // 加载模型
+    net = migraphx::parse_onnx(modelPath);       // 根据提供的模型地址，去加载模型文件
+    LOG_INFO(logFile,"succeed to load model: %s\n",GetFileName(modelPath).c_str());
+
+    // 获取模型输入属性
+    std::pair<std::string, migraphx::shape> inputAttribute=*(net.get_parameter_shapes().begin());
+    inputName=inputAttribute.first;
+    inputShape=inputAttribute.second;
+    inputSize=cv::Size(inputShape.lens()[3],inputShape.lens()[2]);
+
+    // 设置模型为GPU模式
+    migraphx::target gpuTarget = migraphx::gpu::target{};
+
+    // 编译模型
+    migraphx::compile_options options;
+    options.device_id=0;                          // 设置GPU设备，默认为0号设备(>=1.2版本中支持)
+    options.offload_copy=true;                    // 设置offload_copy
+    net.compile(gpuTarget,options);               
+    LOG_INFO(logFile,"succeed to compile model: %s\n",GetFileName(modelPath).c_str());
+
+    ...
+    
+}
+```
+
+## 预处理
+
+完成模型初始化之后，需要将输入数据进行如下预处理：
+
+​        1.尺度变换，将图像resize到256x256大小
+
+​        2.归一化，将数据归一化到[0.0, 1.0]之间
+
+​        3.数据排布，将数据从HWC转换为NCHW
+
+本示例代码主要通过opencv实现预处理操作：
+
+```C++
+ErrorCode Unet::Segmentation(const cv::Mat &srcImage, cv::Mat &maskImage)
+{
+    
+    ...
+        
+    // 图像预处理,将图像resize到（256x256）大小，并转换为NCHW
+    cv::Mat inputBlob;
+    cv::dnn::blobFromImage(srcImage,    // 输入数据，支持多张图像
+                    inputBlob,          // 输出数据
+                    1 / 255.0,          // 缩放系数
+                    inputSize,          // 模型输入大小，这里为256x256
+                    Scalar(0, 0, 0),    // 均值，这里不需要减均值，所以设置为0
+                    true,               // 通道转换，B通道与R通道互换，所以为true
+                    false);
+    ...
+        
+}
+```
+
+1.cv::dnn::blobFromImage()函数支持多个输入图像，首先将输入图像resize到inputSize大小，然后减去均值，其次乘以缩放系数1/255.0并转换为NCHW，最终将转换好的数据保存到inputBlob作为输入数据执行推理。
+
+## 推理
+
+完成图像预处理后，就可以执行推理，得到推理结果。
+
+```c++
+ErrorCode Unet::Segmentation(const cv::Mat &srcImage, cv::Mat &maskImage)
+{
+    ...
+        
+    // 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> results = net.eval(inputData);
+
+    // 获取输出节点的属性
+    migraphx::argument result = results[0];                 // 获取第一个输出节点的数据
+    migraphx::shape outputShape=result.get_shape();         // 输出节点的shape
+    std::vector<std::size_t> outputSize=outputShape.lens(); // 每一维大小，维度顺序为(N,C,H,W) 
+    int numberOfOutput=outputShape.elements();              // 输出节点元素的个数
+    float *data = (float *)result.data();                   // 输出节点数据指针
+
+    // 计算sigmoid值，并且当大于0.996时，值为1,当小于0.996时，值为0，存储在value_mask[]数组中
+    int value_mask[numberOfOutput];
+    for(int i=0; i<numberOfOutput; ++i)
+    {
+        float num  = Sigmoid(data[i]);
+        if (num > 0.996)
+        {
+            value_mask[i] = 1;
+        }
+        else
+        {
+            value_mask[i] = 0;
+        }
+    }
+
+    // 将对应的value_mask[]数组中的值依次赋值到outputImage对应位置处
+    cv::Mat outputImage = cv::Mat_<int>(Size(outputShape.lens()[3], outputShape.lens()[2]), CV_32S);
+    for(int i=0;i<outputShape.lens()[2];++i)
+    {
+        for(int j=0;j<outputShape.lens()[3];++j){
+            outputImage.at<int>(i,j)=value_mask[256*i+j];  // 其中，256代表了outputShape.lens()[3]的值
+        }
+    }
+    // 将32S格式的数据转换为8U格式的数据
+    outputImage.convertTo(maskImage, CV_8U, 255.0);
+    ...
+}
+```
+
+1.inputData表示MIGraphX的输入数据，这里表示为图像数据，inputName表示输入节点名，migraphx::argument{inputShape, (float*)inputBlob.data}表示该节点名对应的数据，这里是通过前面预处理的数据inputBlob来创建的，第一个参数表示数据的shape，第二个参数表示数据指针。
+
+2.net.eval(inputData)返回模型的推理结果，由于这里只有一个输出节点，所以std::vector中只有一个数据，results[0]表示第一个输出节点，获取输出数据之后，就可以对输出数据执行相关后处理操作。
+
+3.模型得到的推理结果并不能直接作为分割结果。首先，对推理结果计算sigmoid值，当计算值大于0.996时值为1，小于等于0.996时值为0，保存在数组value_mask中。其次，创建一个cv::Mat将value_mask数组中的值按行依次赋值到对应的位置。最后，将32S格式的数据转换为8U格式的数据，对应位置乘以255，得到最终的分割图像。
+
+注：本次采用的模型权重onnx文件是通过使用具有普通背景的汽车图像来训练的。因此，“现实世界“图像的分割结果不完美是意料之中的。为了获得更好的结果，建议对现实世界示例数据集上的模型进行微调。
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```c++
+./ MIGraphX_Samples 8
+```
+
+会在当前目录中生成分割结果图像Result.jpg
+
+输出结果为：
+
+![Unet_output_python](../Images/Unet_output_c++.jpg)
+

Doc/Tutorial_Cpp/YOLOV3.md

+# YOLOV3检测器
+
+## 模型简介
+
+YOLOV3是由Joseph Redmon和Ali Farhadi在《YOLOv3: An Incremental Improvement》论文中提出的单阶段检测模型，算法首先通过特征提取网络对输入提取特征，backbone部分由YOLOV2时期的Darknet19进化至Darknet53加深了网络层数，引入了Resnet中的跨层加和操作；然后结合不同卷积层的特征实现多尺度训练，一共有13x13、26x26、52x52三种分辨率，分别用来预测大、中、小的物体；每种分辨率的特征图将输入图像分成不同数量的格子，每个格子预测B个bounding box，每个bounding box预测内容包括: Location(x, y, w, h)、Confidence Score和C个类别的概率，因此YOLOv3输出层的channel数为B*(5 + C)。YOLOv3的loss函数也有三部分组成：Location误差，Confidence误差和分类误差。
+
+<img src="../Images/YOLOV3_02.jpg" alt="YOLOV3_02" style="zoom:;" />
+
+本示例采用如下的开源实现：https://github.com/ultralytics/yolov3, 作者在V9.6.0版本中提供多种不同的YOLOV3预训练模型，其中包括yolov3、yolov3-fixed、yolov3-spp、yolov3-tiny四个版本。本示例选择yolov3-tiny.pt预训练模型进行构建MIGraphX推理，下载YOLOV3的预训练模型yolov3-tiny.pt保存在Pytorch_YOLOV3工程的weights目录。
+
+## 模型转换
+
+官方提供的YOLOV3源码中包含导出onnx模型的程序，通过下面的步骤可以将yolov3-tiny.pt转换成onnx格式：
+
+```
+# 进入Pytorch_YOLOV3工程根目录
+cd <path_to_Pytorch_YOLOV3>
+
+# 环境配置，torch、torchvision手动安装
+pip install -r requirements.txt
+
+# 导出onnx模型
+python export.py --weights yolov3.pt --imgsz 416 416 --include onnx
+```
+
+注意：官方源码提供的模型转换的程序中包含更多的功能，例如动态shape模型的导出，可根据需要进行添加相关参数。
+
+## 检测器参数设置
+
+samples工程中的Resource/Configuration.xml文件的DetectorYOLOV3节点表示YOLOV3检测器的参数，相关参数主要依据官方推理示例进行设置。各个参数含义如下：
+
+- ModelPath：yolov3模型存放路径
+- ClassNameFile：coco数据集类别文件存放路径
+- UseFP16：是否使用FP16推理模式
+- NumberOfClasses：检测类别数量
+- ConfidenceThreshold：置信度阈值，用于判断anchor内的物体是否为正样本
+- NMSThreshold：非极大值抑制阈值，用于消除重复框
+- ObjectThreshold：用于判断anchor内部是否有物体
+
+```
+<ModelPath>"../Resource/Models/Detector/YOLOV3/yolov3-tiny.onnx"</ModelPath>
+<ClassNameFile>"../Resource/Models/Detector/YOLOV3/coco.names"</ClassNameFile>
+<UseFP16>0</UseFP16><!--是否使用FP16-->
+<NumberOfClasses>80</NumberOfClasses><!--类别数(不包括背景类)，COCO:80,VOC:20-->
+<ConfidenceThreshold>0.2</ConfidenceThreshold>
+<NMSThreshold>0.4</NMSThreshold>
+<ObjectThreshold>0.4</ObjectThreshold>
+```
+
+## 模型初始化
+
+模型初始化首先通过parse_onnx()函数加载YOLOV3的onnx模型，并可以通过program的get_parameter_shapes()函数获取网络的输入属性。完成模型加载之后需要使用compile()方法编译模型，编译模式使用migraphx::gpu::target{}设为GPU模式，编译过程主要基于MIGraphX IR完成各种优化。同时如果需要使用低精度量化进行推理，可以使用quantize_fp16()函数实现。
+
+```
+ErrorCode DetectorYOLOV3::Initialize(InitializationParameterOfDetector initializationParameterOfDetector)
+{
+    ...
+    
+    //模型加载
+    net = migraphx::parse_onnx(modelPath);
+    LOG_INFO(logFile,"succeed to load model: %s\n",GetFileName(modelPath).c_str());
+
+    // 获取模型输入属性
+    std::pair<std::string, migraphx::shape> inputAttribute=*(net.get_parameter_shapes().begin());
+    inputName=inputAttribute.first;
+    inputShape=inputAttribute.second;
+    inputSize=cv::Size(inputShape.lens()[3],inputShape.lens()[2]);// NCHW
+
+    // 设置模型为GPU模式
+    migraphx::target gpuTarget = migraphx::gpu::target{};
+
+    // 量化    
+    if(useFP16)
+    {
+        migraphx::quantize_fp16(net);
+    }
+
+    // 编译模型
+    migraphx::compile_options options;
+    options.device_id=0; // 设置GPU设备，默认为0号设备(>=1.2版本中支持)
+    options.offload_copy=true; // 设置offload_copy
+    net.compile(gpuTarget,options);
+    LOG_INFO(logFile,"succeed to compile model: %s\n",GetFileName(modelPath).c_str());
+
+    ...
+}
+```
+
+## 模型推理
+
+### 预处理
+
+在将数据输入到模型之前，需要对图像做如下预处理操作：
+
+- 转换数据排布为NCHW
+- 归一化[0.0, 1.0]
+- 将输入数据的尺寸变换到YOLOV3输入大小（1，3，416，416）
+
+```
+ErrorCode DetectorYOLOV3::Detect(const cv::Mat &srcImage, std::vector<ResultOfDetection> &resultsOfDetection)
+{
+   ...
+
+    // 预处理并转换为NCHW
+    cv::Mat inputBlob;
+    blobFromImage(srcImage,   // 输入数据
+                    inputBlob,  // 输出数据
+                    1 / 255.0,  //归一化
+                    inputSize,  //YOLOV3输入尺寸，本示例为416x416
+                    Scalar(0, 0, 0),  //未减去均值
+                    true,  //转换RB通道
+                    false);
+                    
+    ...
+}
+```
+
+### 前向推理
+
+完成图像预处理以及YOLOV3目标检测相关参数设置之后开始执行推理，利用migraphx推理计算得到YOLOV3模型的输出数据。
+
+```
+ErrorCode DetectorYOLOV3::Detect(const cv::Mat &srcImage, std::vector<ResultOfDetection> &resultsOfDetection)
+{
+
+	...
+    // 输入数据
+    migraphx::parameter_map inputData;
+    inputData[inputName]= migraphx::argument{inputShape, (float*)inputBlob.data};
+
+    // 推理
+    std::vector<migraphx::argument> inferenceResults = net.eval(inputData);
+
+    // 获取推理结果
+    std::vector<cv::Mat> outs;
+    migraphx::argument result = inferenceResults[0]; 
+
+    // 转换为cv::Mat
+    migraphx::shape outputShape = result.get_shape();
+    int shape[]={outputShape.lens()[0],outputShape.lens()[1],outputShape.lens()[2]};
+    cv::Mat out(3,shape,CV_32F);
+    memcpy(out.data,result.data(),sizeof(float)*outputShape.elements());
+    outs.push_back(out);
+    
+    ...
+}
+```
+
+YOLOV3的MIGraphX推理结果inferenceResults是一个std::vector< migraphx::argument >类型，YOLOV3的onnx模型包含一个输出，所以result等于inferenceResults[0]，result包含三个维度：outputShape.lens()[0]=1表示batch信息，outputShape.lens()[1]=10647表示生成anchor数量，outputShape.lens()[2]=85表示对每个anchor的预测信息。同时可将85拆分为4+1+80，前4个参数用于判断每一个特征点的回归参数，回归参数调整后可以获得预测框，第5个参数用于判断每一个特征点是否包含物体，最后80个参数用于判断每一个特征点所包含的物体种类。获取上述信息之后进行anchors筛选，筛选过程分为两个步骤：
+
+- 第一步根据objectThreshold阈值进行筛选，大于该阈值则判断当前anchor内包含物体，小于该阈值则判断无物体；
+
+- 第二步根据confidenceThreshold阈值进行筛选，当满足第一步阈值anchor的最大置信度得分maxClassScore大于该阈值，则进一步获取当前anchor的坐标信息和预测物体类别信息，小于该阈值则不做处理。
+
+```
+ErrorCode DetectorYOLOV3::Detect(const cv::Mat &srcImage, std::vector<ResultOfDetection> &resultsOfDetection)
+{
+    ...
+    
+    //获取先验框的个数numProposal=10647
+    int numProposal = outs[0].size[1];
+    //获取每个anchor的预测信息数量numOut=85
+    int numOut = outs[0].size[2];
+    //变换输出的维度
+    outs[0] = outs[0].reshape(0, numProposal);
+
+    //生成先验框
+    std::vector<float> confidences;
+    std::vector<cv::Rect> boxes;
+    std::vector<int> classIds;
+    //原图尺寸与模型输入尺寸的缩放比例
+    float ratioh = (float)srcImage.rows / inputSize.height, ratiow = (float)srcImage.cols / inputSize.width;
+
+    //计算cx,cy,w,h,box_sore,class_sore
+    int n = 0, rowInd = 0;
+    float* pdata = (float*)outs[0].data;
+    for (n = 0; n < numProposal; n++)
+    {
+        //获取当前anchor是否包含物体的概率值
+        float boxScores = pdata[4];
+        //第一次筛选，判断anchor内是否包含物体
+        if (boxScores > yolov3Parameter.objectThreshold)
+        {
+            //获取每个anchor内部预测的80个类别概率信息
+            cv::Mat scores = outs[0].row(rowInd).colRange(5, numOut);
+            cv::Point classIdPoint;
+            double maxClassScore;
+            /获取80个类别中最大概率值和对应的类别ID
+            cv::minMaxLoc(scores, 0, &maxClassScore, 0, &classIdPoint);
+            maxClassScore *= boxScores;
+            //第二次筛选，判断当前anchor的最大置信度得分是否满足阈值
+            if (maxClassScore > yolov3Parameter.confidenceThreshold)
+            {
+                const int classIdx = classIdPoint.x;
+                //将每个anchor坐标按缩放比例映射到原图
+                float cx = pdata[0] * ratiow;
+                float cy = pdata[1] * ratioh;
+                float w = pdata[2] * ratiow;
+                float h = pdata[3] * ratioh;
+                //获取anchor的左上角坐标
+                int left = int(cx - 0.5 * w);
+                int top = int(cy - 0.5 * h);
+
+                confidences.push_back((float)maxClassScore);
+                boxes.push_back(cv::Rect(left, top, (int)(w), (int)(h)));
+                classIds.push_back(classIdx);
+            }
+        }
+        rowInd++;
+        pdata += numOut;
+    }
+
+    ...
+}
+```
+
+为了消除重叠锚框，输出最终的YOLOV3目标检测结果，执行非极大值抑制对筛选之后的anchor进行处理，最后保存检测结果到resultsOfDetection中。
+
+```
+ErrorCode DetectorYOLOV3::Detect(const cv::Mat &srcImage, std::vector<ResultOfDetection> &resultsOfDetection)
+{    
+    ...
+    //执行non maximum suppression消除冗余重叠boxes
+    std::vector<int> indices;
+    dnn::NMSBoxes(boxes, confidences, yolov3Parameter.confidenceThreshold, yolov3Parameter.nmsThreshold, indices);
+    for (size_t i = 0; i < indices.size(); ++i)
+    {
+        int idx = indices[i];
+        int classID=classIds[idx];
+        string className=classNames[classID];
+        float confidence=confidences[idx];
+        cv::Rect box = boxes[idx];、
+        //保存每个最终预测anchor的坐标值、置信度分数、类别ID
+        ResultOfDetection result;
+        result.boundingBox=box;
+        result.confidence=confidence;// confidence
+        result.classID=classID; // label
+        result.className=className;
+        resultsOfDetection.push_back(result);
+    }
+    ...
+}
+```
+
+## 运行示例
+
+根据samples工程中的README.md构建成功C++ samples后，在build目录下输入如下命令运行该示例：
+
+```
+./MIGraphX_Samples 4
+```
+
+会在当前目录生成检测结果图像Result.jpg。
+
+![YOLOV3_01](../Images/YOLOV3_01.jpg)