msPTI工具安装指南¶

安装说明¶

本文档主要介绍msPTI工具的安装方式：使用CANN包安装、和使用run包安装。

msPTI工具完整功能集成在CANN包中，且msPTI依赖CANN包，因此使用msPTI工具需要先安装CANN包，若需要升级安装本工具代码仓中的最新功能，可以通过源码编译安装，在已安装CANN包的环境下覆盖安装msPTI包。

使用CANN包安装¶

msPTI工具完整功能已集成在CANN包中发布，可通过以下方式完成安装：

方式一：依据CANN官方文档安装

请参见《CANN安装官方文档》，按文档逐步完成安装与配置。

方式二：使用CANN官方容器镜像

请访问《CANN官方镜像仓库》，按仓库中的指引完成镜像拉取及容器启动。

（可选）使用run包安装¶

如需使用最新代码的功能，可下载本仓库代码，自行编译、打包并完成安装。

[!note] 说明

编译出的msPTI run包需要在已安装CANN的环境中进行覆盖安装才能使用。

获取run包¶

支持两种方式获取run包：

方式一：从releases页面下载run包。
方式二：基于源码构建run包。

方式一：releases页面下载¶

run包发布地址：msPTI releases

下载后建议先进行完整性校验（MD5）后再安装。示例如下：

wget https://gitcode.com/Ascend/mspti/releases/download/<tag>/mindstudio-profiler-tools-interface_<version>_<arch>.run
md5sum mindstudio-profiler-tools-interface_<version>_<arch>.run
echo "<expected_md5> mindstudio-profiler-tools-interface_<version>_<arch>.run" | md5sum -c -

<expected_md5>请以release页面同版本安装包对应的MD5值为准。
各版本安装包MD5清单请参见版本说明。

MD5sum 校验不一致处理建议：

若md5sum -c -输出FAILED，请勿继续安装。
请先删除当前文件并重新下载，再次执行MD5校验。
仍无法通过校验时，请在releases页面核对文件名与版本是否一致，并通过Issues反馈问题。

方式二：源码编译¶

执行如下命令编译run包：

git clone https://gitcode.com/Ascend/mspti.git
cd mspti
bash scripts/build.sh [<version>]

编译完成后，会在mspti/output目录下生成msPTI工具的run包，run包名称格式为mindstudio-profiler-tools-interface_<version>_<arch>.run。

上述编译命令中的version参数即为软件包名称中的version，表示该run包的版本号。

run包中的arch表示系统架构，根据实际运行系统自动适配。

安装run包¶

增加对run包的可执行权限。

chmod +x mindstudio-profiler-tools-interface_<version>_<arch>.run

安装run包。
```
./mindstudio-profiler-tools-interface_<version>_<arch>.run --install
```
安装命令支持--install-path=<path>等参数，具体使用方式请参见参数说明。

执行安装命令时，会自动执行--check参数，校验软件包的一致性和完整性，出现如下回显信息，表示软件包校验成功。
```
Verifying archive integrity...  100%   SHA256 checksums are OK. All good.
```
安装完成后，若显示如下信息，则说明软件安装成功：
```
MindStudio-Profiler-Tools-Interface package install success.
```

附录¶

参数说明¶

msPTI工具run包的安装命令可配置如下参数：

参数	可选/必选	说明
--install	可选	安装软件包。可配置--install-path参数指定软件的安装路径；不配置--install-path参数时，则直接安装到默认路径下。
--uninstall	可选	卸载软件包。可配置--install-path参数指定软件安装时的路径；不配置--install-path参数时，则直接卸载默认路径下的mspti。
--install-path	可选	安装路径，必须指定到cann层目录，比如/usr/local/Ascend/cann-9.0.0。如果用户未指定安装路径，则软件会安装到默认路径下，默认安装路径如下： • root用户：“/usr/local/Ascend/cann”。 • 非root用户：“${HOME}/Ascend/cann”，${HOME}为当前用户的家目录。
--install-for-all	可选	安装时，允许其他用户具有安装用户组的权限。当安装携带该参数时，支持其他用户使用msPTI运行业务，但该参数存在安全风险，请谨慎使用。

安装run包还可指定其他参数，具体可通过./xxx.run --help命令查看。