[docs] add use_sdk_on_windows.md into quick_start (#304)

* [docs] add use_sdk_on_windows.md into quick_start

* [docs] add use_sdk_on_windows.md into quick_start
This commit is contained in:
DefTruth
2022-09-29 09:29:24 +08:00
committed by GitHub
parent 77bc670d05
commit 6e4c213f17
2 changed files with 509 additions and 21 deletions

View File

@@ -11,13 +11,19 @@
- [方式一:命令行方式使用 C++ SDK](#CommandLine)
- [步骤一:在 Windows 命令行终端 上编译 example](#CommandLine)
- [步骤二:运行可执行文件获得推理结果](#CommandLine)
- [方式二Visual Studio 2019 IDE 方式使用 C++ SDK](#VisualStudio2019)
- [方式二Visual Studio 2019 创建sln工程使用 C++ SDK](#VisualStudio2019Sln)
- [步骤一Visual Studio 2019 创建 sln 工程项目](#VisualStudio2019Sln1)
- [步骤二从examples中拷贝infer_ppyoloe.cc的代码到工程](#VisualStudio2019Sln2)
- [步骤三:将工程配置设置成"Release x64"配置](#VisualStudio2019Sln3)
- [步骤四配置头文件include路径](#VisualStudio2019Sln4)
- [步骤五配置lib路径和添加库文件](#VisualStudio2019Sln5)
- [步骤六:编译工程并运行获取结果](#VisualStudio2019Sln6)
- [方式三Visual Studio 2019 创建CMake工程使用 C++ SDK](#VisualStudio2019)
- [步骤一Visual Studio 2019 创建CMake工程项目](#VisualStudio20191)
- [步骤二在CMakeLists中配置 FastDeploy C++ SDK](#VisualStudio20192)
- [步骤三生成工程缓存并修改CMakeSetting.json配置](#VisualStudio20193)
- [步骤四:生成可执行文件,运行获取结果](#VisualStudio20194)
- [方式CLion IDE 方式使用 C++ SDK](#CLion)
- [方式四Visual Studio Code IDE 方式使用 C++ SDK](#VisualStudioCode)
- [方式CLion IDE 方式使用 C++ SDK](#VisualStudioCode)
- [多种方法配置exe运行时所需的依赖库](#CommandLineDeps1)
- [方式一修改CMakeLists.txt一行命令配置推荐](#CommandLineDeps1)
- [方式二:命令行设置环境变量](#CommandLineDeps2)
@@ -31,7 +37,6 @@
- Visual Studio 16 2019
- cuda >= 11.2 (当WITH_GPU=ON)
- cudnn >= 8.0 (当WITH_GPU=ON)
- TensorRT >= 8.4 (当ENABLE_TRT_BACKEND=ON)
## 2. 下载 FastDeploy Windows 10 C++ SDK
<div id="Download"></div>
@@ -53,7 +58,7 @@ https://gitee.com/paddlepaddle/PaddleDetection/raw/release/2.4/demo/000000014439
### 4.1 在 Windows 上编译 PPYOLOE
Windows菜单打开`x64 Native Tools Command Prompt for VS 2019`命令工具cd到ppyoloe的demo路径
```bat
cd fastdeploy-win-x64-gpu-0.2.0\examples\vision\detection\paddledetection\cpp
cd fastdeploy-win-x64-gpu-0.2.1\examples\vision\detection\paddledetection\cpp
```
```bat
mkdir build && cd build
@@ -74,11 +79,109 @@ infer_ppyoloe_demo.exe ppyoloe_crn_l_300e_coco 000000014439.jpg 2 # GPU + Tenso
特别说明exe运行时所需要的依赖库配置方法请参考章节: [多种方法配置exe运行时所需的依赖库](#CommandLineDeps)
## 5. SDK使用方式二Visual Studio 2019 创建 sln 工程使用 C++ SDK
## 5. SDK使用方式二Visual Studio 2019 IDE 方式使用 C++ SDK
本章节针对非CMake用户介绍如何在Visual Studio 2019 中创建 sln 工程使用 FastDeploy C++ SDK. CMake用户请直接看下一章节。另外本章节内容特别感谢“梦醒南天”同学关于FastDeploy使用的文档教程[如何在 Windows 上使用 FastDeploy C++ 部署 PaddleDetection 目标检测模型](https://www.bilibili.com/read/cv18807232)
<div id="VisualStudio2019Sln"></div>
### 5.1 步骤一Visual Studio 2019 创建 sln 工程项目
<div id="VisualStudio2019Sln1"></div>
1 打开Visual Studio 2019点击"创建新项目"->点击"控制台程序"从而创建新的sln工程项目.
![image](https://user-images.githubusercontent.com/31974251/192813386-cf9a93e0-ee42-42b3-b8bf-d03ae7171d4e.png)
![image](https://user-images.githubusercontent.com/31974251/192816516-a4965b9c-21c9-4a01-bbb2-c648a8256fc9.png)
2点击“创建”便创建了一个空的sln工程。我们直接从examples里面拷贝infer_ppyoloe的代码这里。
![image](https://user-images.githubusercontent.com/31974251/192817382-643c8ca2-1f2a-412e-954e-576c22b4ea62.png)
### 5.2 步骤二从examples中拷贝infer_ppyoloe.cc的代码到工程
<div id="VisualStudio2019Sln2"></div>
1从examples中拷贝infer_ppyoloe.cc的代码到工程直接替换即可拷贝代码的路径为
```bat
fastdeploy-win-x64-gpu-0.2.1\examples\vision\detection\paddledetection\cpp
```
![image](https://user-images.githubusercontent.com/31974251/192818456-21ca846c-ab52-4001-96d2-77c8174bff6b.png)
### 5.3 步骤三:将工程配置设置成"Release x64"配置
<div id="VisualStudio2019Sln3"></div>
![image](https://user-images.githubusercontent.com/31974251/192818918-98d7a54c-4a60-4760-a3cb-ecacc38b7e7a.png)
### 5.4 步骤四配置头文件include路径
<div id="VisualStudio2019Sln4"></div>
1配置头文件include路径鼠标选择项目然后单击右键即可弹出下来菜单在其中单击“属性”。
![image](https://user-images.githubusercontent.com/31974251/192820573-23096aea-046c-4bb4-9929-c412718805cb.png)
2在弹出来的属性页中选择C/C++ —> 常规 —> 附加包含目录,然后在添加 fastdeploy 和 opencv 的头文件路径。如:
```bat
D:\qiuyanjun\fastdeploy_build\built\fastdeploy-win-x64-gpu-0.2.1\include
D:\qiuyanjun\fastdeploy_build\built\fastdeploy-win-x64-gpu-0.2.1\third_libs\install\opencv-win-x64-3.4.16\build\include
```
![image](https://user-images.githubusercontent.com/31974251/192824445-978c06ed-cc14-4d6a-8ccf-d4594ca11533.png)
用户需要根据自己实际的sdk路径稍作修改。
### 5.5 步骤五配置lib路径和添加库文件
<div id="VisualStudio2019Sln5"></div>
1属性页中选择链接器—>常规—> 附加库目录,然后在添加 fastdeploy 和 opencv 的lib路径。如
```bat
D:\qiuyanjun\fastdeploy_build\built\fastdeploy-win-x64-gpu-0.2.1\lib
D:\qiuyanjun\fastdeploy_build\built\fastdeploy-win-x64-gpu-0.2.1\third_libs\install\opencv-win-x64-3.4.16\build\x64\vc15\lib
```
![image](https://user-images.githubusercontent.com/31974251/192826130-fe28791f-317c-4e66-a6a5-133e60b726f0.png)
2添加库文件只需要 fastdeploy.lib 和 opencv_world3416.lib
![image](https://user-images.githubusercontent.com/31974251/192826884-44fc84a1-c57a-45f1-8ee2-30b7eaa3dce9.png)
### 5.6 步骤六:编译工程并运行获取结果
<div id="VisualStudio2019Sln6"></div>
1点击菜单栏“生成”->“生成解决方案”
![image](https://user-images.githubusercontent.com/31974251/192827608-beb53685-2f94-44dc-aa28-49b09a4ab864.png)
![image](https://user-images.githubusercontent.com/31974251/192827842-1f05d435-8a3e-492b-a3b7-d5e88f85f814.png)
编译成功可以看到exe保存在
```bat
D:\qiuyanjun\fastdeploy_test\infer_ppyoloe\x64\Release\infer_ppyoloe.exe
```
2执行可执行文件获得推理结果。 首先需要拷贝所有的dll到exe所在的目录下。同时也需要把ppyoloe的模型文件和测试图片下载解压缩后拷贝到exe所在的目录。 特别说明exe运行时所需要的依赖库配置方法请参考章节: [多种方法配置exe运行时所需的依赖库](#CommandLineDeps)
![image](https://user-images.githubusercontent.com/31974251/192829545-3ea36bfc-9a54-492b-984b-2d5d39094d47.png)
## 6. SDK使用方式三Visual Studio 2019 创建 CMake 工程使用 C++ SDK
<div id="VisualStudio2019"></div>
### 5.1 步骤一:Visual Studio 2019 创建CMake工程项目
本章节针对CMake用户介绍如何在Visual Studio 2019 创建 CMake 工程使用 FastDeploy C++ SDK.
### 6.1 步骤一Visual Studio 2019 创建“CMake”工程项目
<div id="VisualStudio20191"></div>
@@ -95,7 +198,7 @@ infer_ppyoloe_demo.exe ppyoloe_crn_l_300e_coco 000000014439.jpg 2 # GPU + Tenso
![image](https://user-images.githubusercontent.com/31974251/192143930-db1655c2-66ee-448c-82cb-0103ca1ca2a0.png)
### 5.2 步骤二在CMakeLists中配置 FastDeploy C++ SDK
### 6.2 步骤二在CMakeLists中配置 FastDeploy C++ SDK
<div id="VisualStudio20192"></div>
@@ -134,7 +237,7 @@ target_link_libraries(infer_ppyoloe_demo ${FASTDEPLOY_LIBS})
install_fastdeploy_libraries(${CMAKE_CURRENT_BINARY_DIR}/Release)
```
### 5.3 步骤三生成工程缓存并修改CMakeSetting.json配置
### 6.3 步骤三生成工程缓存并修改CMakeSetting.json配置
<div id="VisualStudio20193"></div>
@@ -165,7 +268,7 @@ install_fastdeploy_libraries(${CMAKE_CURRENT_BINARY_DIR}/Release)
![image](https://user-images.githubusercontent.com/31974251/192146239-a1eacd9e-034d-4373-a262-65b18ce25b87.png)
### 5.4 步骤四:生成可执行文件,运行获取结果。
### 6.4 步骤四:生成可执行文件,运行获取结果。
<div id="VisualStudio20194"></div>
@@ -207,10 +310,10 @@ Visualized result saved in ./vis_result.jpg
特别说明exe运行时所需要的依赖库配置方法请参考章节: [多种方法配置exe运行时所需的依赖库](#CommandLineDeps)
## 6. 多种方法配置exe运行时所需的依赖库
## 7. 多种方法配置exe运行时所需的依赖库
<div id="CommandLineDeps"></div>
### 6.1 方式一修改CMakeLists.txt一行命令配置(推荐)
### 7.1 方式一修改CMakeLists.txt一行命令配置(推荐)
<div id="CommandLineDeps1"></div>
考虑到Windows下C++开发的特殊性如经常需要拷贝所有的lib或dll文件到某个指定的目录FastDeploy提供了`install_fastdeploy_libraries`的cmake函数方便用户快速配置所有的dll。修改ppyoloe的CMakeLists.txt添加
@@ -218,7 +321,7 @@ Visualized result saved in ./vis_result.jpg
install_fastdeploy_libraries(${CMAKE_CURRENT_BINARY_DIR}/Release)
```
### 6.2 方式二:命令行设置环境变量
### 7.2 方式二:命令行设置环境变量
<div id="CommandLineDeps2"></div>
编译好的exe保存在Release目录下在运行demo前需要将模型和测试图片拷贝至该目录。另外需要在终端指定DLL的搜索路径。请在build目录下执行以下命令。
@@ -252,7 +355,7 @@ C:\Windows\System32\onnxruntime.dll # windows自带的onnxruntime.dll
setup_fastdeploy_dll.bat
```
### 6.3 方式三手动拷贝依赖库到exe的目录下
### 7.3 方式三手动拷贝依赖库到exe的目录下
<div id="CommandLineDeps3"></div>
@@ -282,13 +385,7 @@ copy_fastdeploy_dll.bat
## 7. CLion 2022 IDE 方式使用 C++ SDK
## 8. CLion 2022 IDE 方式使用 C++ SDK
<div id="CLion"></div>
- TODO
## 8. Visual Studio Code IDE 方式使用 C++ SDK
<div id="VisualStudioCode"></div>
- TODO