MindStudio Insight安装指南

下载 MindStudio Insight Windows 版本

下载 MindStudio Insight Linux 版本 (x86_64)

下载 MindStudio Insight Linux 版本 (aarch64)

下载 MindStudio Insight macOS 版本 (arm64 Apple Silicon)

下载 MindStudio Insight macOS 版本 (x86_64 Intel Chip)

下载 MindStudio Insight JupyterLab 扩展 (x86_64)

下载 MindStudio Insight JupyterLab 扩展 (aarch64)

安装操作（Windows）

准备环境

MindStudio Insight工具的安装与可视化呈现对Windows系统及设备配置有一定要求，请参见表 1 系统配置要求。

表 1 系统配置要求

安装步骤

1. 双击MindStudio-Insight_{version}_win.exe软件包，开始安装MindStudio Insight。

2. 进入MindStudio Insight Setup界面，单击“Next”，如图 1 Setup所示。

   图 1 Setup
   

3. 进入许可协议界面，单击“I Agree”，如图 2 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中，勾选了“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报错弹窗解决。

安装操作（Linux）

概述

在Linux环境下，MindStudio Insight工具可通过本地方式和转发方式进行使用。

• 本地方式

  本地安装Linux操作系统的服务器直接外接显示器，将工具界面直接展示在操作系统桌面上，跟日常本地Windows主机接显示器类似，此场景无工具界面的延迟。

• 转发方式

  当本地无Linux服务器时，可通过连接远端的Linux服务器，使用X11、VNC、XRDP等方式将远端Linux服务器中的桌面或软件界面转发到本地显示，例如，本地Windows桌面显示Linux服务器上的应用程序界面。MindStudio Insight可通过转发能力，在Linux服务器上实现界面转发，便于开发者使用。不过与本地方式相比，转发方式受网络性能影响，可能存在网络延时，会造成工具安装使用过程中出现卡顿问题。

本文档主要介绍X11和VNC两种转发方式，开发者可根据实际情况选择其中一种转发方式，可参见表 1 转发方式说明进行选择。通过转发方式安装使用MindStudio Insight，首先需要安装转发方式和软件依赖，安装操作请参见安装依赖章节。

表 1 转发方式说明

准备环境

在Linux系统中，MindStudio Insight安装环境要求如表 2 MindStudio Insight安装环境要求所示。

表 2 MindStudio Insight安装环境要求

安装依赖

依赖列表

在Linux环境下，安装MindStudio Insight前需要安装相关依赖，请参见表 1 依赖列表安装对应依赖。

表 1 依赖列表

安装依赖

1. 执行以下命令，安装Python相关依赖。

   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
   

   若打印以下信息，表示安装依赖成功，{python_dependencies}为具体依赖名称。

   Successfully installed {python_dependencies}
   

2. 安装MindStudio Insight软件包所需的转发方式和依赖，推荐安装VNC和X11转发方式。

安装VNC转发方式

如果通过VNC转发方式启动MindStudio Insight，可获得更为流畅的体验，所以推荐使用VNC转发方式使用MindStudio Insight工具。

安装依赖

1. 执行以下命令，安装MindStudio Insight显示运行依赖的库文件。

   • Ubuntu等以apt作为包管理软件类型的操作系统

     sudo apt install -y libwebkit2gtk-4.0-dev
     

   • CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

     1. 执行以下命令，查询webkit2gtk库文件。

        sudo yum search 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
        

     2. 根据回显信息，执行以下命令，安装webkit2gtk库文件。

        sudo yum install -y ${dependency_name}
        

        其中dependency_name为依赖文件名称，可参考回显信息确定。例如，如上回显信息所示，如果回显信息中存在webkit2gtk3-devel，则此处的依赖文件名称为webkit2gtk3-devel；如果回显信息中不存在webkit2gtk3-devel，则需要找到webkit2gtk3，此处的依赖文件名称为webkit2gtk3。

     Note

     EulerOS 2.12操作系统是基于OpenEuler 22.03 LTS SP1开发，需要先配置OpenEuler 22.03 LTS SP1的源，再执行安装命令。配置OpenEuler的源具体操作请参见OpenEuler软件源配置。

2. 使用root用户，执行以下命令，安装MindStudio Insight通过VNC转发的桌面依赖。

   • Ubuntu等以apt作为包管理软件类型的操作系统

     apt-get install -y xfce4 xfce4-goodies
     

   • CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

     1. 执行以下命令，查询是否存在xfce。

        yum search xfce
        

        如果回显中包含xfce相关信息，执行以下命令，安装xfce。

        yum install -y xfce4*
        

        如果回显为“未找到匹配项”，则执行2。

     2. 执行以下命令，查询是否存在gnome。

        yum search gnome
        

        如果回显中包含gnome相关信息，执行以下命令，安装gnome。

        yum install -y gnome* 
        

3. 执行以下命令，安装VNC Server。

   • Ubuntu等以apt作为包管理软件类型的操作系统

     apt-get install -y tightvncserver
     

   • CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

     yum install -y tigervnc-server
     

设置VNC Server

1. 执行以下命令，设置VNC首次连接时的密码。

   vncserver
   

2. 回显如下，按照提示输入密码。

   You will require a password to access your desktops.
   Password:请输入密码
   Verify:请再次输入密码
   

3. 输入密码后，回显如下。

   Would you like to enter a view-only password (y/n)? 
   

   按照提示输入n，回显如下，创建启动脚本、默认配置等，首行中的x值根据实际情况显示，表示显示序号。

   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
   

4. 执行以下命令，停止已启用的VNC Server。

   vncserver -kill :x
   

   Note

   此处的x值与3中首行回显的x值一致。

5. 执行vi ~/.vnc/xstartup，打开xstartup启动脚本，并在脚本最后新增一行文本，配置脚本，需要增加的文本内容请参见表 1 文本内容。

   表 1 文本内容

   已安装依赖	文本内容
   xfce	startxfce4 &
   gnome	gnome-session &

6. 执行:wq!命令，保存脚本并退出。

启动VNC Server

执行以下命令，启动VNC Server。

vncserver -localhost -geometry 1920x1080

端口转发

通过SSH通道安全的将Linux本地主机服务转发至Windows本地端口。

1. 打开远程登录工具，选择“Tools > MobaSSHTunnel (port forwarding)”。此处以MobaXterm工具为例。

2. 单击“New SSH Tunnel”，新建一个SSH配置。

   图 1 新建SSH配置
   

3. 选择“Local port forwarding”，按照表 2 配置Local port forwarding页面信息配置页面信息。

   图 2 Local port forwarding
   

   表 2 配置Local port forwarding页面信息

   参数	说明	示例
   Remote server	Linux服务器的地址。	127.0.0.1
   Remote port	Linux服务器的端口，值为5900加设置VNC Server中的x（显示序号）值。	5901
   SSH server	SSH连接时的IP或URL地址。	192.168.25.38
   SSH login	SSH登录的用户名/密码对。	-
   SSH port	SSH登录时使用的端口，一般为22。	22
   Forwarded port	端口转发到本地Windows对应的端口，可以与Remote port一致。	5901

4. 单击“Save”，完成SSH配置。

5. 在MobaSSHTunnel弹窗中，选择已配置好的SSH Tunnel，单击，即可开启端口转发。

   如果SSH配置中的“SSH login”参数，填写的是用户名，首次启动SSH Tunnel的时候会弹出一个对话框，输入用户对应的密码即可启动SSH Tunnel。

本地连接VNC Server

1. 在MobaXterm工具首页，单击“Session”，进入Session settings页面。

2. 单击“VNC”，根据实际情况配置“Remote hostname or IP address”和“Port”。

   Note

   • 如果使用了端口转发功能，“Remote hostname or IP address”为127.0.0.1，“Port”为端口转发中的Forwarded port。
   • 如果未使用端口转发，“Remote hostname or IP address”为实际远端Linux的IP，“Port”为5900加设置VNC Server中的x（显示序号）值。

   图 3 配置VNC
   

3. 配置完成后，单击“OK”，在弹窗中输入VNC的密码后，将桌面转发至本地进行后续操作。

   图 4 桌面
   

安装X11转发方式

前提条件

确保源可用。可在root用户下执行如下命令检查源是否可用。

• Ubuntu等以apt作为包管理软件类型的操作系统

  apt-get update
  

• CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

  yum makecache
  

操作步骤

1. 执行以下命令，安装MindStudio Insight显示运行依赖的库文件。

   • Ubuntu等以apt作为包管理软件类型的操作系统

     sudo apt install -y libwebkit2gtk-4.0-dev
     

   • CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

     1. 执行以下命令，查询webkit2gtk库文件。

        sudo yum search 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
        

     2. 根据回显信息，执行以下命令，安装webkit2gtk库文件。

        sudo yum install -y ${dependency_name}
        

        其中dependency_name为依赖文件名称，可参考回显信息确定。例如，如上回显信息所示，如果回显信息中存在webkit2gtk3-devel，则此处的依赖文件名称为webkit2gtk3-devel；如果回显信息中不存在webkit2gtk3-devel，则需要找到webkit2gtk3，此处的依赖文件名称为webkit2gtk3。

     Note

     EulerOS 2.12操作系统是基于OpenEuler 22.03 LTS SP1开发，需要先配置OpenEuler 22.03 LTS SP1的源，再执行安装命令。配置OpenEuler的源具体操作请参见OpenEuler软件源配置。

2. 执行以下命令，安装MindStudio Insight通过X11转发的依赖文件。

   • Ubuntu等以apt作为包管理软件类型的操作系统

     sudo apt-get install -y xterm x11-apps
     

   • CentOS/EulerOS/OpenEuler等以yum/dnf作为包管理软件类型的操作系统

     sudo yum install -y xterm xorg-x11-xauth
     

安装MindStudio Insight

1. 使用MindStudio Insight的安装用户上传软件包至待安装环境。

2. 在软件包所在目录下，执行以下命令，解压MindStudio Insight软件包。

   • aarch64架构的软件包

     unzip MindStudio-Insight_{version}_linux-aarch64.zip
     

   • x86_64架构的软件包

     unzip MindStudio-Insight_{version}_linux-x86_64.zip
     

3. 执行以下命令，启动MindStudio Insight。

   ./MindStudio-Insight
   

   Note

   • 如果在EulerOS系统上运行MindStudio Insight，单击界面左上方工具栏中的，无法弹出导入选择框，解决方法可参见EulerOS等系统上运行MindStudio Insight工具无法弹出数据导入选择框。
   • 在X11转发方式下运行MindStudio Insight时，如果出现输入框信息粘贴不符合预期，造成输入信息错误的情况，具体解决方法可参见通过X11转发方式运行MindStudio Insight工具时，输入框信息粘贴有误。

安装操作（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插件）

简介

在Linux环境下，MindStudio Insight工具通过集成JupyterLab插件，提供更直观和交互性强的操作界面。JupyterLab插件的优势如表 1 JupyterLab插件优势所示。

表 1 JupyterLab插件优势

准备环境

1. 执行以下命令，在Linux环境下安装JupyterLab环境，环境要求请参见表 2 环境要求。

   pip install jupyterlab
   

   表 2 环境要求

   类别	要求
   支持的系统	Linux系统
   依赖	版本要求：Python >= 3.8 如果需要打开集群场景数据，则需要参见安装依赖章节中的内容安装Python依赖。
   JupyterLab环境	版本要求：JupyterLab >= 4.0，且 < 5.0

2. 安装完成后，查看JupyterLab版本。

   jupyter --version
   

3. （可选）建议使用conda进行环境管理。

   执行以下命令，创建虚拟环境并激活。

   conda create -n {your_env_name} python={python version} jupyterlab={jupyterlab version}  
   conda activate {your_env_name}  # 激活虚拟环境
   

安装步骤

1. 安装MindStudio Insight插件包。

   pip install mindstudio_insight_jupyterlab-{version}-py3-none-{platform}.whl
   

   Note

   在安装插件包前，请先确认当前用户的umask设置，推荐设置为“0027”，具体建议请参见《安全声明》。

2. 查看MindStudio Insight是否安装成功。

   jupyter labextension list
   

   回显中包含如下内容，表示安装成功。

   mindstudio_insight_jupyterlab v{version} enabled  X (python, mindstudio_insight_jupyterlab)
   

3. 启用JupyterLab服务并打开MindStudio Insight工具。

   • 如果是非root用户，请执行以下命令。

     jupyter lab
     

   • 如果是root用户，请执行以下命令。

     jupyter lab --allow-root
     

   Note

   建议使用非root用户执行命令。如果实际需要使用root用户启动，请严格执行root用户的命令，否则会存在安全风险。

   启用后，使用浏览器，输入http://{your_server_ip}:{your_server_port}/lab地址，打开JupyterLab环境首页，如图 1 JupyterLab环境首页所示，单击MindStudio Insight图标，即可打开MindStudio Insight工具。

   图 1 JupyterLab环境首页
   

4. 如果打开JupyterLab环境首页后，未发现MindStudio Insight图标，可执行以下命令，查看MindStudio Insight插件是否开启。

   jupyter server extension list 
   

   • 回显如下，表示已开启。

     mindstudio_insight_jupyterlab enabled
         - Validating mindstudio_insight_jupyterlab...
           mindstudio_insight_jupyterlab  OK
     

   • 如果未开启，可执行以下命令，开启MindStudio Insight插件。

     jupyter server extension enable --py mindstudio_insight_jupyterlab
     

5. 开启MindStudio Insight插件后，重复操作3，打开MindStudio Insight工具。

   注意事项

   • 如果本机未安装浏览器，或者大模型性能调优数据及JupyterLab存在于服务器上，需要在服务器上启用服务并加载数据，然后使用本地浏览器访问查看。启用JupyterLab服务的具体操作可参考以下步骤。

     1. 创建JupyterLab配置文件。此处的配置为JupyterLab官方配置，与MindStudio Insight插件无关。

        jupyter lab --generate-config
        

     2. 进入jupyter目录，打开jupyter_lab_config.py配置文件。

     3. 修改配置文件。搜索关键字“c.ServerApp.ip”和“c.ServerApp.open_browser”，删除所在行前面的注释符号，并修改为如下配置后保存，使配置文件生效。

        # 修数使其生效（去掉配置文件注释）
        c.ServerApp.ip = '0.0.0.0'
        c.ServerApp.open_browser = False
        

     4. 配置完成后，参见3重新启动JupyterLab服务并打开MindStudio Insight工具。

   • 如果您当前使用的云平台已经集成了JupyterLab服务，且需要在云平台上使用MindStudio Insight工具，那么可在云平台上安装Jupyter代理服务插件jupyter-server-proxy，即可正常使用MindStudio Insight工具。
     如果云平台无法安装Jupyter代理服务插件，且公网未开放9000~9099端口，则无法使用MindStudio Insight工具。

     1. 安装Jupyter代理服务插件。

        pip install jupyter-server-proxy
        

     2. 参见3重新启动JupyterLab服务并打开MindStudio Insight工具。

   • 在JupyterLab环境首页，可多次单击MindStudio Insight图标，打开多个MindStudio Insight页签，且可同时使用。

   • 请关注使用JupyterLab插件方式安装MindStudio Insight后，使用时的安全风险，具体可参见《安全声明》。

安装操作（插件开发）

MindStudio Insight工具支持插件开发功能，为开发者提供自主开发能力，开发者可自主开发插件包，并安装插件包，实现自主开发功能使用。

开发插件

开发者可自主开发插件，具体操作可参见《插件开发指南》。

插件包要求如下：

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配置文件格式要求如下：

   {
       "pluginName":"插件名称",
       "frontend":"前端产物名称",                      # zip压缩包
       "backend_{platform}_{machine}":"后端产物名称",  # zip或动态库
   }
   

   其中platform为平台名称，machine为架构名称。

3. 插件包中包含的文件个数不能超过1000个，单个文件大小不能超过200M。

4. 插件包需具有当前用户属主，具有可读可写权限，不支持链接文件和包含链接的文件。

安装插件

进入MindStudio Insight工具的安装目录，执行以下命令，安装已开发的插件包。其中plugin package path为插件包所在路径。

python resources/profiler/plugin_install.py install --path="plugin package path"

使用插件

安装完成后，打开MindStudio Insight工具，导入数据即可正常使用。

如果插件包使用的是自主开发的唤醒逻辑，则依据实际情况进行使用。

卸载操作（Windows）

1. 进入MindStudio Insight安装目录，双击Uninstall.exe，弹出卸载界面，单击“Uninstall”后进行卸载，如图 1 MindStudio Insight卸载界面所示。

   图 1 MindStudio Insight卸载界面
   

2. 单击“Next”。

   图 2 卸载
   

3. 勾选“Remove cache data”清理缓存数据，单击“Uninstall”卸载。

   图 3 清理缓存数据
   

4. 完成卸载。

   图 4 卸载完成
   

卸载操作（Linux）

在Linux系统中，卸载MindStudio Insight工具有2种方式可选。

• 方式一：通过直接删除MindStudio Insight解压后的软件包进行卸载。该操作不会删除日志文件。
• 方式二：使用命令行方式进行卸载。

  1. 执行以下命令，卸载MindStudio Insight。

     rm -rf MindStudio-Insight resources
     

  2. 执行以下命令，删除MindStudio Insight的日志文件。

     rm -rf ${HOME}/.mindstudio_insight
     

卸载操作（macOS）

1. 进入应用程序中，找到MindStudio Insight。
2. 鼠标右键单击MindStudio Insight应用，弹出菜单栏。
3. 单击“移到废纸篓”即可卸载。

卸载操作（JupyterLab插件）

卸载MindStudio Insight插件包。

pip uninstall mindstudio_insight_jupyterlab