一、简要介绍

支持以插件扩展形式在JupyterLab上使用MindStudio insight

MindStudio Insight提供了PyTorch、MindSpore等性能数据的多种呈现形式，包括Timeline视图、通信分析、计算耗时等的可视化呈现，以便用户分析潜在的性能瓶颈，并指导如何采取措施消除或减少这些瓶颈。通过与 JupyterLab 的集成，MindStudio Insight 提供了一个更加直观、交互式的工作环境，使得大模型可视化调优变得更加高效和便捷。

JupyterLab插件主要特性：

1. 无缝集成：MindStudio Insight 扩展可以作为 JupyterLab 插件直接在 Jupyter 环境中运行，无需离开当前的开发环境即可调用强大的数据分析工具。

2. 简易操作：用户只需通过 JupyterLab 的命令面板或图形界面，便可启动 MindStudio Insight 服务，配置并查看模型分析结果。扩展与 JupyterLab 的交互设计保证了良好的用户体验。

3. 版本兼容：主要兼容linux版本使用（包括x86_64及arrch64架构），用户可以直接在训练或推理服务器上直接使用JupyterLab启动MindStudio Insight进行可视化分析，快速定位性能瓶颈。

4. 跨机访问：支持用户在远程训练或推理服务器上使用JupyterLab启动MindStudio Insight服务，本地浏览器远程连接服务直接进行可视化分析，有效解决了大模型训练或推理数据上传和下载困难问题。

二、安装指南

1. 环境准备

在Linux操作系统下安装MindStudio Insight扩展，需要确保jupyterlab>=4, <5，同时需要确保python>=3.8

# 1.使用pip安装jupyterlab（python版本大于等于3.8以上不指定版本安装jupyterlab，jupyterlab应会满足jupyterlab>=4,<5的条件）
pip install jupyterlab
# 2.使用pip安装指定版本jupyterlab，如jupyterlab-4.0.11
pip install jupyterlab==4.0.11

# 安装完成后查看jupyterlab版本
jupyter --version

此处建议使用conda进行环境管理，下载Miniconda后创建虚拟环境可参考如下

# 创建虚拟环境
conda create -n {your_env_name} python=3.9 jupyterlab=4.0.11
# 激活虚拟环境
conda activate {your_env_name}

2. 安装包准备

【8.2.T1 2025年8月版本】

https://support.huawei.com/enterprise/zh/ascend-computing/mindstudio-pid-251913966/software/266323721?idAbsPath=fixnode01|23710424|251366513|254884019|261408772|251913966

【8.0.T103 2025年4月版本】

https://ascend-package.obs.cn-north-4.myhuaweicloud.com:443/Ascend-Insight/8.0.T103/mindstudio_insight_jupyterlab-8.0.103-py3-none-linux_aarch64.whl

https://ascend-package.obs.cn-north-4.myhuaweicloud.com:443/Ascend-Insight/8.0.T103/mindstudio_insight_jupyterlab-8.0.103-py3-none-linux_x86_64.whl

3. 包安装及服务查看

whl安装包下载后，使用pip方式进行安装

# 安装mindstudio_insight_jupyterlab插件包
pip install mindstudio_insight_jupyterlab-{version}-py3-none-{platform}.whl # version为版本号，platform为兼容平台

# 安装后可查看是否安装成功
jupyter labextension list

出现如下即为安装成功

Tips：若安装后服务未启动，可使用jupyter服务命令进行查看及开启

# 查看服务
jupyter server extension list

若存在如下结果即为开启成功

若不存在则需要手动开启服务

# 开启服务
jupyter server extension enable mindstudio_insight_jupyterlab

4. 启动JupyterLab使用MindStudio Insight插件

# 启动jupyterlab（非root用户）
jupyter lab
#  启动jupyterlab（root用户）
jupyter lab --allow-root

使用浏览器（linux上如firefox）打开JupyterLab启动服务地址url后如下

点击该图标后，直接使用MindStudio Insight功能进行可视化分析，可参考MindStudio Insight用户指南

5. 集群分析功能

若要在JupyterLab环境下使用MindStudio Insight的集群分析功能（即“概览”“通信”页签），需安装mstt的集群分析工具cluster analyse。

安装命令参考（需安装在JupyterLab所在环境）：

pip install msprof-analyze

详情参见：mstt: 针对训练&大模型场景，提供端到端命令行&可视化调试调优工具，帮助用户快速提高模型开发效率 - Gitee.com。

6. 跨机访问配置

如果本机没有浏览器，或者大模型性能调优数据及JupyterLab存在于服务器上，想通过服务器上启用服务加载数据然后本地浏览器访问查看；那么你需要进行如下配置

Tips：此处为JupyterLab官方配置，与MindStudio Insight插件无关

# 1. 创建jupyterlab配置文件
jupyter lab --generate-config

查看用户目录下.jupyter/jupyter_lab_config.py文件中配置选项

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

配置完成后，重新启动JupyterLab服务

# 启动jupyterlab（非root用户）
jupyter lab
#  启动jupyterlab（root用户）
jupyter lab --allow-root

在本机浏览器上输入JupyterLab启动后url（命令启动后会打印在终端），参考如下

http://{your_server_ip}:8888/lab

点击上图所示图标启动后即可使用MindStudio Insight进行可视化分析

7. 云平台集成使用

针对用户使用云平台已经集成了JupyterLab，为保证在这一场景可以使用MindStudio Insight工具，需要用户云平台可以安装Jupyter代理服务插件jupyter-server-proxy，在无代理服务插件情况下，若云平台公网不开放9000端口则无法使用MindStudio Insight工具。其具体使用说明如下：

    1. 安装jupyter-server-proxy

pip install jupyter-server-proxy

    2. 重新启动JupyterLab服务

jupyter lab # 此处启动方式以各自云平台环境为准

    3. 在JupyterLab的Launcher界面找到MindStudio Insight图标，点击打开即可使用MIndStudio Insight工具

8. 安装包卸载

# 卸载插件扩展包
pip uninstall mindstudio_insight_jupyterlab