安装操作

前提条件

请参见准备环境和软件包章节，完成安装MindStudio Insight工具前的准备工作。

安装步骤

1. 安装MindStudio Insight插件包。

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

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

   jupyter labextension list

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

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

3. 启用JupyterLab服务并打开MindStudio Insight工具。
   • 如果是非root用户，请执行以下命令。

     jupyter lab

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

     jupyter lab --allow-root

   

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

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

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

   jupyter server extension list 

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

     1 2 3

     mindstudio_insight_jupyterlab enabled - Validating mindstudio_insight_jupyterlab... mindstudio_insight_jupyterlab OK

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

     jupyter server extension enable 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后，使用时的安全风险，具体可参见安全加固建议。