MindStudio Insight安装指南¶
安装说明¶
MindStudio Insight是面向开发者的可视化调优工具,能够将性能数据以时序图、热力图等一些简单易懂的图表呈现,帮助开发者快速识别性能瓶颈,快速完成性能优化。本文主要介绍MindStudio Insight的安装方式。
MindStudio Insight支持在Windows、Linux和macOS系统上安装使用,并且支持通过JupyterLab插件方式安装使用。
准备软件包¶
软件包下载¶
MindStudio Insight 26.0.0 现已发布
您可以根据操作系统选择对应的软件包进行下载。下载本软件即表示您同意华为企业业务最终用户许可协议(EULA)的条款和条件。
根据平台获取软件包¶
下载 Windows 版
[下载 MindStudio Insight Windows 版本](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/MindStudio-Insight_26.0.0_win.exe)下载 Linux 版
[下载 MindStudio Insight Linux 版本 (x86_64)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/MindStudio-Insight_26.0.0_linux_x86_64.zip) [下载 MindStudio Insight Linux 版本 (aarch64)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/MindStudio-Insight_26.0.0_linux_aarch64.zip)下载 macOS 版
[下载 MindStudio Insight macOS 版本 (arm64 Apple Silicon)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/MindStudio-Insight_26.0.0_macos_aarch64.dmg) [下载 MindStudio Insight macOS 版本 (x86_64 Intel Chip)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/MindStudio-Insight_26.0.0_macos_x86_64.dmg)下载 JupyterLab 插件
[下载 MindStudio Insight JupyterLab 扩展 (x86_64)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/mindstudio_insight_jupyterlab-26.0.0-py3-none-linux_x86_64.whl) [下载 MindStudio Insight JupyterLab 扩展 (aarch64)](https://gitcode.host/Ascend/msinsight/releases/download/tag_MindStudio_26.0.0.B120_0012/mindstudio_insight_jupyterlab-26.0.0-py3-none-linux_aarch64.whl)详细软件包清单¶
单击MindStudio Insight Release,确认版本信息后获取如表 1 软件包清单所示软件包。
| 软件包 | 说明 |
|---|---|
| MindStudio-Insight_{version}_win.exe | 适用于Windows系统的MindStudio Insight软件包,含有GUI的集成开发环境。 |
| MindStudio-Insight_{version}_linux-{arch}.zip | 适用于Linux系统的MindStudio Insight软件包。 |
| MindStudio-Insight_{version}_macos-{arch}.dmg | 适用于macOS系统的MindStudio Insight软件包,含有GUI的集成开发环境。 |
| mindstudio_insight_jupyterlab-{version}-py3-none-{platform}.whl | 基于JupyterLab安装的软件包。 |
软件完整性验证¶
为了防止软件包在传递过程或存储期间被恶意篡改,下载软件包时需下载对应软件包的.sha256文件用于完整性验证。
单击MindStudio Insight Release获取对应软件包的哈希校验文件(.sha256),并对下载的软件包进行完整性校验。如果校验失败,请不要使用该软件包,需要支持与服务请在论坛求助或提交技术工单。
具体校验方法如下:
-
在本地获取软件包的sha256校验码
Windows系统,使用如下命令获取对应软件包的sha256校验码
MacOS系统,使用如下命令获取对应软件包的sha256校验码
Linux系统,使用如下命令获取对应软件包的sha256检验码
-
打开查看对应哈希校验文件中的校验码和获取到的校验码(不区分大小写)进行比较,如果一致,则说明软件包通过完整性校验。
安装MindStudio Insight¶
Windows 系统安装操作
安装操作(Windows)
**准备环境** MindStudio Insight工具的安装与可视化呈现对Windows系统及设备配置有一定要求,请参见[**表 1** 系统配置要求](#系统配置要求)。 **表 1** 系统配置要求 |类别|要求|说明| |--|--|--| |系统|Windows 10 64位操作系统|-| |内存配置|推荐16GB或以上|针对大模型集群场景,加载的数据量较大。| |磁盘空间|推荐可用空间30GB或以上|用于存放加载性能数据时生成的数据库文件。| **安装步骤** 1. 双击**MindStudio-Insight\__\{version\}_\_win.exe**软件包,开始安装MindStudio Insight。 2. 进入MindStudio Insight Setup界面,单击“Next”,如[**图 1** Setup](#Setup)所示。 **图 1** Setup  3. 进入许可协议界面,单击“I Agree”,如[**图 2** License-Agreement](#License-Agreement)所示。 **图 2** License-Agreement  4. 选择MindStudio Insight的安装路径,单击“Next”,如[**图 3** 选择安装路径](#选择安装路径)所示。 **图 3** 选择安装路径  > [!NOTE] 说明 > 默认安装目录为“C:\\Program Files \(x86\)\\MindStudio Insight”。如果选择安装到其他目录,为避免其他用户修改运行文件,需要取消普通用户的修改权限,可在所选文件夹右键选择“属性 \> 安全”,在“安全”页签下修改用户的权限。 5. 选择安装组件MindStudio Insight,单击“Install”,如[**图 4** 选择安装组件](#选择安装组件)所示。 **图 4** 选择安装组件  6. 完成MindStudio Insight安装,单击“Finish”,如[**图 5** 完成安装](#完成安装)所示。 **图 5** 完成安装  7. 启动MindStudio Insight。 - 如果在[6](#6)中,勾选了“Run MindStudio Insight”,单击“Finish”后会自动启动MindStudio Insight。 - 如果未勾选“Run MindStudio Insight”,安装完成后,双击桌面的“MindStudio Insight”快捷方式图标,或安装目录下的“MindStudio-Insight.exe”,即可启动MindStudio Insight工具。 > [!NOTE] 说明 > 安装完成后,运行MindStudio Insight工具时,如果出现Missing Dependencies报错弹窗,请参见[运行MindStudio Insight工具时出现Missing Dependencies报错弹窗](../support/faq.md#faq-missing-dependencies)解决。Linux 系统安装操作
安装操作(Linux)
概述
在Linux环境下,MindStudio Insight工具可通过本地方式和转发方式进行使用。 - 本地方式 本地安装Linux操作系统的服务器直接外接显示器,将工具界面直接展示在操作系统桌面上,跟日常本地Windows主机接显示器类似,此场景无工具界面的延迟。 - 转发方式 当本地无Linux服务器时,可通过连接远端的Linux服务器,使用X11、VNC、XRDP等方式将远端Linux服务器中的桌面或软件界面转发到本地显示,例如,本地Windows桌面显示Linux服务器上的应用程序界面。MindStudio Insight可通过转发能力,在Linux服务器上实现界面转发,便于开发者使用。不过与本地方式相比,转发方式受网络性能影响,可能存在网络延时,会造成工具安装使用过程中出现卡顿问题。 本文档主要介绍X11和VNC两种转发方式,开发者可根据实际情况选择其中一种转发方式,可参见[**表 1** 转发方式说明](#转发方式说明)进行选择。通过转发方式安装使用MindStudio Insight,首先需要安装转发方式和软件依赖,安装操作请参见[安装依赖](#安装依赖)章节。 > [!NOTE] 说明 > 推荐使用VNC转发方式,可获得更为流畅的使用体验。 **表 1** 转发方式说明 |转发方式|网络延迟|安全性|备注| |--|--|--|--| |X11|相对较高|底层基于SSH安全协议。|多用于网络良好的本地局域网中。| |VNC|相对较低|默认通过TCP方式,可借助SSH安全协议实现安全访问。|应用范围更广,可用在跨城网络、VPN网络等。| **准备环境** 在Linux系统中,MindStudio Insight安装环境要求如[**表 2** MindStudio Insight安装环境要求](#Insight安装环境要求)所示。 **表 2** MindStudio Insight安装环境要求 |类别|限制要求| |--|--| |硬件|- 内存:最小4GB,推荐8GB及以上- 磁盘空间:最小6GB| |系统要求|- glibc版本应大于或等于2.27
- 操作系统自带GUI桌面或具有X11或VNC转发功能| |支持的操作系统|以apt作为包管理软件类型的操作系统:
- Ubuntu 18.04-x86_64/aarch64
- Ubuntu 20.04-x86_64/aarch64
- Ubuntu 22.04-x86_64/aarch64
- CentOS 8.2-x86_64/aarch64
- Debian 10.0
- Debian 10.8
以yum/dnf作为包管理软件类型的操作系统:
- EulerOS 2.8-aarch64
- EulerOS 2.12-aarch64
- OpenEuler 20.03-x86_64/aarch64
- OpenEuler 22.03 LTS-x86_64/aarch64
- OpenEuler 22.03 LTS
- OpenEuler 22.03 LTS SP4
- HCE 2.0
- CUlinux 3.0
- Kylin V10 SP3
- Euler 2.13(ARM)
- HCE 2.0.2503(x86)
- Tlinux 3.1-内核版本5.4
- BClinux 21.10 U4
- TencentOS Server 4.4_x86| > [!NOTE] 说明 > 在直通虚拟机velinux 5.15系统上安装和使用MindStudio Insight工具时,推荐使用JupyterLab插件的安装方式使用MindStudio Insight工具,JupyterLab插件安装请参见[安装操作(JupyterLab插件)](#安装操作jupyterlab插件)章节进行操作。
安装依赖
**依赖列表** 在Linux环境下,安装MindStudio Insight前需要安装相关依赖,请参见[**表 1** 依赖列表](#依赖列表)安装对应依赖。 > [!NOTE] 说明 > 如果MindStudio Insight导入的是多卡场景的性能数据,则需要安装python的pandas库,执行命令`pip install pandas`进行安装。 **表 1** 依赖列表| 依赖名称 | 说明 |
|---|---|
| libwebkit2gtk-4.0-dev | Ubuntu系统中,MindStudio Insight显示运行依赖的库文件,必选。 |
| gtk3-devel webkit2gtk4.1-devel | CentOS系统中,MindStudio Insight显示运行依赖的库文件,必选。 |
| gtk3-devel webkit2gtk3-devel | EulerOS和OpenEuler系统中,MindStudio Insight显示运行依赖的库文件,必选。 |
| xterm | MindStudio Insight通过X11转发的依赖文件。当选择X11转发方式时,所有系统必选。 |
| x11-apps | Ubuntu系统中,MindStudio Insight通过X11转发的依赖文件。当选择X11转发方式时,必选。 |
| xorg-x11-xauth | CentOS、EulerOS和OpenEuler系统中,MindStudio Insight通过X11转发的依赖文件。当选择X11转发方式时,必选。 |
| xfce4 | Ubuntu、CentOS、OpenEuler系统中,MindStudio Insight通过VNC转发的依赖文件。当选择VNC转发方式时,必选。 |
| gnome-desktop | EulerOS系统中,MindStudio Insight通过VNC转发的依赖文件。当选择VNC转发方式时,必选。 |
| click | MindStudio Insight已集成msprof-analyze集群分析工具所依赖的Python库。 版本要求见msprof-analyze工具的build.txt文件。 |
| tabulate | |
| networkx | |
| jinja2 | |
| PyYaml | |
| tqdm | |
| prettytable | |
| ijson | |
| xlsxwriter | |
| sqlalchemy | |
| numpy | |
| pandas | |
| psutil |
pip3 install click
pip3 install tabulate
pip3 install networkx
pip3 install jinja2
pip3 install PyYaml
pip3 install tqdm
pip3 install prettytable
pip3 install ijson
pip3 install "xlsxwriter>=3.0.6"
pip3 install sqlalchemy
pip3 install "numpy<=1.26.4"
pip3 install "pandas<=2.3.2"
pip3 install psutil
安装VNC转发方式
如果通过VNC转发方式启动MindStudio Insight,可获得更为流畅的体验,所以推荐使用VNC转发方式使用MindStudio Insight工具。 > [!NOTE] 说明 > > - EulerOS 2.12系统不支持使用VNC方式启动MindStudio Insight工具。 > - 本章节内容仅供参考,VNC的具体安装步骤请参见[VNC官方文档](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/deployment_guide/chap-tigervnc#s2-starting-vncserver)。 **安装依赖** 1. 执行以下命令,安装MindStudio Insight显示运行依赖的库文件。 - Ubuntu等以apt作为包管理软件类型的操作系统 - CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统 1. 执行以下命令,查询webkit2gtk库文件。 回显信息如下= Name 和 Summary 匹配:webkit2gtk =====================================================================================
webkit2gtk3-devel.aarch64 : Development files for webkit2gtk3
webkit2gtk3-help.noarch : Documentation files for webkit2gtk3
webkit2gtk3-jsc.aarch64 : JavaScript engine from webkit2gtk3
webkit2gtk3-jsc-devel.aarch64 : Development files for JavaScript engine from webkit2gtk3
========================================================================================== Name 匹配:webkit2gtk ===========================================================================================
webkit2gtk3.aarch64 : GTK+ Web content engine library
========================================================================================= Summary 匹配:webkit2gtk =========================================================================================
libproxy-webkitgtk4.aarch64 : plugin for webkit2gtk3
New 'localhost.localdomain:x' desktop is localhost.localdomain:x
Creating default startup script /home/xxx/.vnc/xstartup
Creating default config /home/xxx/.vnc/config
Starting applications specified in /home/xxx/.vnc/xstartup
Log file is /home/xxx/.vnc/localhost.localdomain:3.log
安装X11转发方式
**前提条件** 确保源可用。可在root用户下执行如下命令检查源是否可用。 - Ubuntu等以apt作为包管理软件类型的操作系统 - CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统 > [!NOTE] 说明 > 如果OpenEuler及其衍生操作系统,在安装过程中提示找不到相关依赖,可能原因是系统配置的源没有相关依赖,可参见[链接](https://www.hiascend.com/forum/thread-02101178181671140059-1-1.html)配置新的源,并重新安装对应依赖。 **操作步骤** 1. 执行以下命令,安装MindStudio Insight显示运行依赖的库文件。 - Ubuntu等以apt作为包管理软件类型的操作系统 - CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统 1. 执行以下命令,查询webkit2gtk库文件。 回显信息如下= Name 和 Summary 匹配:webkit2gtk =====================================================================================
webkit2gtk3-devel.aarch64 : Development files for webkit2gtk3
webkit2gtk3-help.noarch : Documentation files for webkit2gtk3
webkit2gtk3-jsc.aarch64 : JavaScript engine from webkit2gtk3
webkit2gtk3-jsc-devel.aarch64 : Development files for JavaScript engine from webkit2gtk3
========================================================================================== Name 匹配:webkit2gtk ===========================================================================================
webkit2gtk3.aarch64 : GTK+ Web content engine library
========================================================================================= Summary 匹配:webkit2gtk =========================================================================================
libproxy-webkitgtk4.aarch64 : plugin for webkit2gtk3
安装MindStudio Insight
1. 使用MindStudio Insight的安装用户上传软件包至待安装环境。 2. 在软件包所在目录下,执行以下命令,解压MindStudio Insight软件包。 - aarch64架构的软件包 - x86\_64架构的软件包 3. 执行以下命令,启动MindStudio Insight。 > [!NOTE] 说明 > - 如果在EulerOS系统上运行MindStudio Insight,单击界面左上方工具栏中的,无法弹出导入选择框,解决方法可参见[EulerOS等系统上运行MindStudio Insight工具无法弹出数据导入选择框](../support/faq.md#faq-euleros-import-dialog)。 > - 在X11转发方式下运行MindStudio Insight时,如果出现输入框信息粘贴不符合预期,造成输入信息错误的情况,具体解决方法可参见[通过X11转发方式运行MindStudio Insight工具时,输入框信息粘贴有误](../support/faq.md#faq-x11-paste-error)。macOS 系统安装操作
安装操作(macOS)
**准备环境** 请准备macOS Ventura 13.5及以上版本macOS系统。 **安装步骤** 1. 鼠标双击“MindStudio-Insight\__\{version\}_\_macos-_\{arch\}_.dmg”软件包,进入许可协议界面,单击“Agree”,如[**图 1** 许可协议](#许可协议)所示。 **图 1** 许可协议  2. 弹出Installer弹窗,在Installer弹窗中,将MindStudio Insight应用拖拽至Applications文件夹中,如[**图 2** 拖拽应用至文件夹](#拖拽应用至文件夹)所示。 **图 2** 拖拽应用至文件夹  3. 在应用程序中双击MindStudio Insight应用,即可打开MindStudio Insight工具。 > [!NOTE] 说明 > - 当前适用于macOS系统的MindStudio Insight应用程序,在部分macOS系统上运行时,可能会出现无法打开“MindStudio Insight”的情况。当运行MindStudio Insight时,如果出现无法打开“MindStudio Insight”的弹窗,需单击弹窗信息中的“好”,然后在“系统设置 \> 隐私与安全性 \> 安全性”中选择“App Store和被认可的开发者”,在出现的“已阻止使用MindStudio Insight”信息中单击“仍要打开”,授予执行权限,再次双击MindStudio Insight应用,出现无法打开“MindStudio Insight”弹窗时,单击弹窗中的“打开”,即可正常打开MindStudio Insight工具。 > - 如果需要在macOS系统上同时打开多个MindStudio Insight工具,可在cmd窗口中,执行`open -n /Applications/MindStudio Insight.app`命令。但是不建议在两个MindStudio Insight窗口中同时打开同一份数据,以免出现数据解析问题。
JupyterLab 插件安装操作
安装操作(JupyterLab插件)
**简介** 在Linux环境下,MindStudio Insight工具通过集成JupyterLab插件,提供更直观和交互性强的操作界面。JupyterLab插件的优势如[**表 1** JupyterLab插件优势](#JupyterLab插件优势)所示。 **表 1** JupyterLab插件优势 |优势|说明| |--|--| |无缝集成|支持在Jupyter环境中直接运行MindStudio Insight工具,无需切换平台,无需拷贝服务器上的数据,实现数据即采即用。| |快速启动|通过JupyterLab的命令行或图形界面,可快速启动MindStudio Insight工具。| |运行流畅|在Linux环境下,通过JupyterLab环境启动MindStudio Insight,相较于整包通信,有效解决了运行卡顿问题,操作体验显著提升。| |远程连接|支持远程启动MindStudio Insight,可通过本地浏览器远程连接服务直接进行可视化分析,缓解了大模型训练或推理数据上传和下载的困难。| **准备环境** 1. 执行以下命令,在Linux环境下安装JupyterLab环境,环境要求请参见[**表 2** 环境要求](#环境要求)。 >[!NOTE] > >如果需要打开集群场景数据,则需要参见[安装依赖](#安装依赖)章节中的内容安装Python依赖。 **表 2** 环境要求 |类别|要求| |--|--| |系统|Linux系统| |Python版本|Python >= 3.8| |JupyterLab环境版本|JupyterLab >= 4.0,且 < 5.0| 2. 安装完成后,查看JupyterLab版本。 3. (可选)建议使用conda进行环境管理。 执行以下命令,创建虚拟环境并激活。
conda create -n {your_env_name} python={python version} jupyterlab={jupyterlab version}
conda activate {your_env_name} # 激活虚拟环境
mindstudio_insight_jupyterlab enabled
- Validating mindstudio_insight_jupyterlab...
mindstudio_insight_jupyterlab OK
如果云平台无法安装Jupyter代理服务插件,且公网未开放9000\~9099端口,则无法使用MindStudio Insight工具。 1. 安装Jupyter代理服务插件。 2. 参见[3](#jupyter_3)重新启动JupyterLab服务并打开MindStudio Insight工具。 - 在JupyterLab环境首页,可多次单击MindStudio Insight图标,打开多个MindStudio Insight页签,且可同时使用。 - 请关注使用JupyterLab插件方式安装MindStudio Insight后,使用时的安全风险,具体可参见[安全声明](../legal/security_statement.md)。
插件开发安装操作
安装操作(插件开发)
MindStudio Insight工具支持插件开发功能,为开发者提供自主开发能力,开发者可自主开发插件包,并安装插件包,实现自主开发功能使用。 **开发插件** 开发者可自主开发插件,具体操作可参见[插件开发指南](https://gitcode.com/ascend/mstt/blob/poc/plugins/mindstudio-insight-plugins/document/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md#%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97)。 插件包要求如下: 1. 插件包格式必须为zip压缩包。 2. 插件包中必须包含以下文件: - config.json配置文件。 - 前端产物:必须为zip压缩包,包含前端asset目录及其文件和index.html文件。 - 后端产物:必须为zip压缩包,包含对应平台及架构下的插件所需动态库和单个动态库文件。后端产物在config.json配置文件中的键值名为“backend\_\{_platform_\}\_\{_machine_\}”,其中platform为平台名称,machine为架构名称。例如,linux x86环境下后端产物键值名为backend\_linux\_x86\_64。 config.json配置文件格式要求如下: 其中platform为平台名称,machine为架构名称。 3. 插件包中包含的文件个数不能超过1000个,单个文件大小不能超过200M。 4. 插件包需具有当前用户属主,具有可读可写权限,不支持链接文件和包含链接的文件。 > [!NOTE] 说明 > MindStudio Insight工具支持通过".so"形式加载任何插件,请务必对所需插件包进行完整性校验,保证其来源安全可信,从而有效避免社区投毒、恶意代码注入等潜在安全风险。 **安装插件** 进入MindStudio Insight工具的安装目录,执行以下命令,安装已开发的插件包。其中**plugin package path**为插件包所在路径。 **使用插件** 安装完成后,打开MindStudio Insight工具,导入数据即可正常使用。 如果插件包使用的是自主开发的唤醒逻辑,则依据实际情况进行使用。升级MindStudio Insight¶
如果需要升级MindStudio Insight,需先卸载已安装的MindStudio Insight,再获取最新MindStudio Insight软件包重新安装。
请根据实际场景,参见卸载MindStudio Insight章节内容完成卸载操作,并重新安装最新MindStudio Insight软件包。