MindStudio Insight Installation Guide

Installation Description

MindStudio Insight is a visualization tuning tool designed for developers. It displays profile data in easy-to-understand charts, such as timeline charts and heatmaps, helping developers quickly identify performance bottlenecks and optimize performance. This document describes how to install MindStudio Insight.

MindStudio Insight can be installed and used on Windows, Linux, and macOS, and can be installed and used through the JupyterLab plugin.

Preparing the Software Package

Downloading the Software Package

Click here to obtain the software package. After confirming the version information, obtain the software package listed in Table 1 Software package list.

Once you download the software, you agree to the terms and conditions of Huawei Enterprise End User License Agreement (EULA).

Table 1 Software package list

Software Package	Description
MindStudio-Insight_{version}_win.exe	MindStudio Insight software package applicable to the Windows OS, containing the GUI-based integrated development environment.
MindStudio-Insight_{version}_linux-aarch64.zip	MindStudio Insight software package applicable to the Linux OS (AArch64 architecture).
MindStudio-Insight_{version}_linux-x86_64.zip	MindStudio Insight software package for Linux (x86_64).
MindStudio-Insight_{version}_darwin-{arch}.dmg	MindStudio Insight software package for macOS, containing the GUI-based integrated development environment.
mindstudio_insight_jupyterlab-{version}-py3-none-{platform}.whl	Software package installed based on JupyterLab.

Verifying Software Package Integrity

To prevent a software package from being maliciously tampered with during transmission or storage, download the corresponding .sha256 file for integrity check while downloading the software package.

Click digital signature file to obtain the .sha256 file of the corresponding software package and verify the integrity of the downloaded software package. If the verification fails, do not use the package. Visit the support website to get help from the community or submit a service ticket. The verification method is as follows:

Calculate the SHA256 value of the software package on the local PC.

In Windows, run the following command to obtain the SHA256 value of the corresponding software package:
```
certutil -hashfile software_package_name SHA256
```
In macOS, run the following command to obtain the SHA256 value of the corresponding software package:
```
shasum -a 256 software_package_name
```
In Linux, run the following command to obtain the SHA256 value of the corresponding software package:
```
sha256sum software_package_name
```
Compare the obtained value with the value (case-insensitive) in the .sha256 file provided by the official website. If they are the same, the software package is not tampered with.

Installing MindStudio Insight

Installation (Windows)

Preparing the Environment

The installation and GUI of MindStudio Insight require specific Windows system and device configurations. For details, see Table 1 System configuration requirements.

Table 1 System configuration requirements

Type	Requirement	Description
System	Windows 10 64-bit	-
Memory configuration	16 GB or more recommended	In the foundation model cluster scenario, a large amount of data is loaded.
Disk space	30 GB or more available space recommended	The space is used to store database files generated during profile data loading.

Procedure

Double-click the MindStudio-Insight_{version}_win.exe software package.
On the MindStudio Insight Setup page, click Next, as shown in Figure 1 Setup.

Figure 1 Setup
On the license agreement page, click I Agree, as shown in Figure 2 License Agreement.

Figure 2 License Agreement
Select the installation path of MindStudio Insight and click Next, as shown in Figure 3 Selecting an installation path.

Figure 3 Selecting an installation path

NOTE
The default installation directory is C:\Program Files (x86)\MindStudio Insight. If you select another directory, right-click the directory and choose Properties > Security from the shortcut menu. On the Security tab page, modify the user permission to prevent other users from modifying the running file.
Select MindStudio Insight and click Install, as shown in Figure 4 Selecting components to be installed.

Figure 4 Selecting components to be installed
After MindStudio Insight is installed, click Finish, as shown in Figure 5 Installation completed.

Figure 5 Installation completed
Start MindStudio Insight.
- If you select Run MindStudio Insight in step 6, MindStudio Insight will be automatically started after you click Finish.
- If Run MindStudio Insight is not selected, you can double-click the MindStudio Insight shortcut icon on the desktop or MindStudio-Insight.exe in the installation directory to start MindStudio Insight after the installation is complete.
NOTE
If the "Missing Dependencies" error message is displayed when you run MindStudio Insight after the installation is complete, see Error Message "Missing Dependencies" Is Displayed When MindStudio Insight Is Running.

Installation (Linux)

Overview

In the Linux environment, MindStudio Insight can be used in local mode or forwarding mode.

Local mode

In local mode, the server running the Linux OS is directly connected to an external monitor. The tool GUI is displayed on the OS desktop, which is similar to the scenario where a local Windows host is connected to a monitor. In this scenario, there is no delay of the tool GUI.
Forwarding mode

If no Linux server is available locally, you can connect to a remote Linux server and use X11, VNC, or xRDP to forward the desktop or software GUI on the remote Linux server to the local PC. For example, the application GUI on the Linux server is displayed on the local Windows desktop. You can use the forwarding capability of MindStudio Insight to implement GUI forwarding on the Linux server, which is convenient for developers. However, compared with the local mode, the forwarding mode is affected by network performance and may cause network delay. As a result, suspension may occur during tool installation and use.

This document describes the X11 and VNC forwarding modes. Developers can select one forwarding mode according to the actual situation. For details, see Table 1 Forwarding modes. To install and use MindStudio Insight in forwarding mode, install the forwarding mode and software dependencies first. For details, see Installing Dependencies.

NOTE

The VNC forwarding mode is recommended, which provides a smoother experience.

Table 1 Forwarding modes

Forwarding Mode	Network Delay	Security	Remarks
X11	Relatively high	The underlying layer is based on the SSH.	It is mostly used in local area networks with good network conditions.
VNC	Relatively low	By default, the TCP protocol is used. You can use SSH to ensure secure access.	It is more widely used and can be used on cross-city networks and VPN networks.

Preparing the Environment

Table 2 Environment requirements for installing MindStudio Insight describes the environment requirements for installing MindStudio Insight in the Linux OS.

Table 2 Environment requirements for installing MindStudio Insight

Type	Limitation
Hardware	- Memory: at least 4 GB (8 GB or above recommended) - Minimum disk space: 6 GB
System requirement	- The glibc version must be 2.27 or later. - The OS provides a built-in GUI desktop or supports X11 or VNC forwarding.
Supported OSs	OSs that use APT as the package management software: - 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 OSs that use Yum or DNF as the package management software: - 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 - kernel version 5.4 - BClinux 21.10 U4 - TencentOS Server 4.4_x86

NOTE

When installing and using MindStudio Insight on a passthrough VM running the veLinux 5.15 system, you are advised to use the JupyterLab plugin to install MindStudio Insight. For details about how to install the JupyterLab plugin, see section "Installation (JupyterLab Plugin)".

Installing Dependencies

Dependency List

In the Linux environment, install related dependencies before installing MindStudio Insight. For details, see Table 1 Dependency list.

NOTE

If the profile data in the multi-card scenario is imported to MindStudio Insight, run the pip install pandas command to install the Python pandas library.

Table 1 Dependency list

Dependency	Description
libwebkit2gtk-4.0-dev	In the Ubuntu OS, this dependency is mandatory and indicates the library on which MindStudio Insight depends.
gtk3-devel webkit2gtk4.1-devel	In the CentOS, this dependency is mandatory and indicates the library on which MindStudio Insight depends.
gtk3-devel webkit2gtk3-devel	In the EulerOS and openEuler, this dependency is mandatory and indicates the library on which MindStudio Insight depends.
xterm	Dependency file used by MindStudio Insight for X11 forwarding. This dependency is mandatory for all systems when X11 forwarding is selected.
x11-apps	Dependency file used by MindStudio Insight for X11 forwarding in the Ubuntu OS. This dependency is mandatory when X11 forwarding is selected.
xorg-x11-xauth	Dependency file used by MindStudio Insight to forward data through X11 in CentOS, EulerOS, and openEuler. This dependency is mandatory when X11 forwarding is selected.
xfce4	Dependency file used by MindStudio Insight to forward data through VNC in Ubuntu, CentOS, and openEuler. This dependency is mandatory when VNC forwarding is selected.
gnome-desktop	Dependency file used by MindStudio Insight to forward data through VNC in EulerOS. This dependency is mandatory when VNC forwarding is selected.
click	Dependencies required for compiling and installing Python. The version requirements are as follows: xlsxwriter>=3.0.6 numpy<=1.26.4
tabulate
networkx
jinja2
PyYaml
tqdm
prettytable
ijson
xlsxwriter
sqlalchemy
numpy
pandas
psutil

Installing Dependencies

Run the following commands to install Python dependencies:

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
pip3 install sqlalchemy
pip3 install numpy
pip3 install pandas
pip3 install psutil

Configure the forwarding method and install dependencies required by the MindStudio Insight software package. You are advised to configure VNC and X11 for forwarding.

Configuring VNC for Forwarding

Starting MindStudio Insight through VNC forwarding provides a smoother experience. Therefore, you are advised to use the VNC forwarding to use MindStudio Insight.

NOTE

MindStudio Insight cannot be started through VNC in EulerOS 2.12.
This section is for reference only. For details about how to install VNC, see the official VNC documentation.

Installing Dependencies

Run the following command to install the libraries required for running MindStudio Insight:
- For Ubuntu and other OSs that use APT as the package management software
```
sudo apt install -y libwebkit2gtk-4.0-dev
```
- For CentOS, EulerOS, openEuler, and other OSs that use Yum or DNF as the package management software
  1. Run the following command to query the webkit2gtk library file:
```
sudo yum search webkit2gtk
```
    The command output is as follows:
```
= Name and Summary match: 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 match: webkit2gtk ===========================================================================================
webkit2gtk3.aarch64 : GTK+ Web content engine library
========================================================================================= Summary match: webkit2gtk =========================================================================================
libproxy-webkitgtk4.aarch64 : plugin for webkit2gtk3
```
  2. Run the following command to install the webkit2gtk library based on the command output:
```
sudo yum install -y ${dependency_name}
```
    In the preceding command, dependency_name indicates the name of the dependency file. You can determine the name by referring to the command output. For example, if webkit2gtk3-devel is displayed in the command output, the dependency file name is webkit2gtk3-devel. If webkit2gtk3-devel is not displayed in the command output, webkit2gtk3 needs to be found, and the dependency file name is webkit2gtk3.
  NOTE
  EulerOS 2.12 is developed based on openEuler 22.03 LTS SP1. You need to configure the openEuler 22.03 LTS SP1 source and then run the installation command. For details about how to configure the openEuler source, see openEuler source configuration.
Run the following command as the root user to install the desktop dependencies forwarded by MindStudio Insight through VNC:
- For Ubuntu and other OSs that use APT as the package management software
```
apt-get install -y xfce4 xfce4-goodies
```
- For CentOS, EulerOS, openEuler, and other OSs that use YUM or DNF as the package management software
  1. Run the following command to check whether xfce exists:
```
yum search xfce
```
    If the command output contains xfce information, run the following command to install xfce:
```
yum install -y xfce4*
```
    If the command output is "No matches found", go to 2.
  2. Run the following command to check whether gnome exists:
```
yum search gnome
```
    If the command output contains gnome information, run the following command to install gnome:
```
yum install -y gnome* 
```
Run the following command to install the VNC server:
- For Ubuntu and other OSs that use APT as the package management software
```
apt-get install -y tightvncserver
```
- For CentOS, EulerOS, openEuler, and other OSs that use Yum or DNF as the package management software
```
yum install -y tigervnc-server
```

Setting the VNC Server

Run the following command to set the password for the first VNC connection:
```
vncserver
```

If the following information is displayed, enter the password as prompted:

You will require a password to access your desktops.
Password: Enter the password.
Verify: Enter the password again.

After the password is entered, the following information is displayed:

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

Enter n as prompted. If the following information is displayed, the startup script and default configuration are created. The value of x in the first line indicates the display sequence number.

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

Run the following command to stop the enabled VNC server:
```
vncserver -kill :x
```
NOTE
The value of x here is the same as that in the first line of the command output in 3.
Run the vi ~/.vnc/xstartup command to open the xstartup startup script and add a line of text to the end of the script. For details about the text to be added, see Table 1 Text content.

Table 1 Text content

Dependencies Installed Text

xfce startxfce4 &

gnome gnome-session &
Run the :wq! command to save the script and exit.

Dependencies Installed	Text
xfce	startxfce4 &
gnome	gnome-session &

Starting the VNC Server

Run the following command to start the VNC server:

vncserver -localhost -geometry 1920x1080

NOTE

localhost: starts the VNC service on the local host. This parameter must be used together with Port Forwarding. If the network environment is secure, you can directly perform the step of Connecting to the VNC Server Locally without using localhost or port forwarding. (This method is not recommended.)
geometry 1920 × 1080: sets the VNC desktop resolution to 1920 × 1080 pixels. The resolution can be adjusted based on the resolution of the monitor.

Port Forwarding

Forward the Linux local host service to the Windows local port through the SSH channel.

Start the remote login tool and choose Tools > MobaSSHTunnel (port forwarding). MobaXterm is used as an example.
Click New SSH Tunnel to create SSH configuration.

Figure 1 Creating SSH configuration

Select Local port forwarding and configure the information on the page by referring to Table 2 Configuring the Local port forwarding page information.

Figure 2 Local port forwarding

Table 2 Configuring the Local port forwarding page information

Parameter	Description	Example
Remote server	Address of the Linux server.	127.0.0.1
Remote port	Port of the Linux server. The value is 5900 plus the value of x (display sequence number) in the VNC server.	5901
SSH server	IP address or URL used for SSH connection.	192.168.25.38
SSH login	Username/password pair for SSH login.	-
SSH port	Port used for SSH login, which is 22 in most cases.	22
Forwarded port	Port forwarded to the local Windows. The value can be the same as that of the remote port.	5901

Click Save. The SSH configuration is complete.
In the MobaSSHTunnel dialog box, select the configured SSH tunnel and click to enable port forwarding.

If the SSH login parameter in the SSH configuration is set to a username, a dialog box is displayed when the SSH tunnel is started for the first time. Enter the password of the user to start the SSH tunnel.

Connecting to the VNC Server Locally

On the MobaXterm home page, click Session. The Session settings page is displayed.
Click VNC and set Remote hostname or IP address and Port based on the actual situation.
NOTE
- If port forwarding is used, Remote hostname or IP address is 127.0.0.1 and Port is Forwarded port.
- If port forwarding is not used, Remote hostname or IP address is the actual IP address of the remote Linux OS, and Port is 5900 plus the value of x (display sequence number) in the VNC server settings.
Figure 3 Configuring the VNC
After the configuration is complete, click OK. In the dialog box that is displayed, enter the VNC password to forward the desktop to the local PC for subsequent operations.

Figure 4 Desktop

Installing X11 for Forwarding

Prerequisites

Ensure that the source is available. Run the following command as the root user to check whether the source is valid:

For Ubuntu and other OSs that use APT as the package management software
```
apt-get update
```
For CentOS, EulerOS, openEuler, and other OSs that use Yum or DNF as the package management software
```
yum makecache
```

NOTE

If a message is displayed during the installation of openEuler and its derivative OSs, indicating that the required dependencies cannot be found, the possible cause is that the dependencies are missing in the configured source. In this case, you can configure a new source by referring to here and reinstall the dependencies.

Procedure

Run the following command to install the libraries required for running MindStudio Insight:
- For Ubuntu and other OSs that use APT as the package management software
```
sudo apt install -y libwebkit2gtk-4.0-dev
```
- For CentOS, EulerOS, openEuler, and other OSs that use Yum or DNF as the package management software
  1. Run the following command to query the webkit2gtk library:
```
sudo yum search webkit2gtk
```
    The command output is as follows:
```
= Name and Summary match: 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 match: webkit2gtk ===========================================================================================
webkit2gtk3.aarch64 : GTK+ Web content engine library
========================================================================================= Summary match: webkit2gtk =========================================================================================
libproxy-webkitgtk4.aarch64 : plugin for webkit2gtk3
```
  2. Run the following command to install the webkit2gtk library based on the command output:
```
sudo yum install -y ${dependency_name}
```
    dependency_name indicates the name of the dependency file. You can determine the name based on the command output. For example, if webkit2gtk3-devel is displayed in the command output, the dependency file name is webkit2gtk3-devel. If webkit2gtk3-devel is not displayed in the command output, webkit2gtk3 needs to be found, and the dependency file name is webkit2gtk3.
  NOTE
  EulerOS 2.12 is developed based on openEuler 22.03 LTS SP1. You need to configure the openEuler 22.03 LTS SP1 source and then run the installation command. For details about how to configure the openEuler source, see openEuler source configuration.
Run the following command to install the dependency files required by MindStudio Insight to use X11 forwarding:
- For Ubuntu and other OSs that use APT as the package management software
```
sudo apt-get install -y xterm x11-apps
```
- For CentOS, EulerOS, openEuler, and other OSs that use Yum or DNF as the package management software
```
sudo yum install -y xterm xorg-x11-xauth
```

Install MindStudio Insight.

Upload the software package to the target environment as the MindStudio Insight installation user.
In the directory where the software package is stored, run the following command to decompress the MindStudio Insight software package:
- Software package for the AArch64 architecture
```
unzip MindStudio-Insight_{version}_linux-aarch64.zip
```
- Software package for the x86_64 architecture
```
unzip MindStudio-Insight_{version}_linux-x86_64.zip
```
Run the following command to start MindStudio Insight:
```
./MindStudio-Insight
```
NOTE
- If you are running MindStudio Insight on EulerOS and click on the toolbar in the upper left corner of the page, the dialog box for importing is not displayed, you can fix the issue by referring to "The Data Import Dialog Box Cannot Be Displayed When MindStudio Insight Is Running on EulerOS".
- When MindStudio Insight is running in X11 forwarding mode, if the pasted information in the text box is not as expected, the entered information may be incorrect. For details about the solution, see "The Information in the Text Box Is Incorrectly Pasted When MindStudio Insight Is Running in X11 Forwarding Mode".

Installation (macOS)

Preparing the Environment

Prepare macOS Ventura 13.5 or later.

Procedure

Double-click the MindStudio-Insight__{version}_darwin-{arch}_.dmg software package. In the displayed license agreement dialog box, click Agree, as shown in Figure 1 License agreement.

Figure 1 License agreement
In the displayed Installer dialog box, drag the MindStudio Insight application to the Applications folder, as shown in Figure 2 Dragging the application to the folder.

Figure 2 Dragging the application to the folder
Double-click the MindStudio Insight application to open MindStudio Insight.
NOTE
- The MindStudio Insight application applicable to the macOS may fail to be started on some macOS systems.
  If a dialog box indicating that MindStudio Insight cannot be started is displayed when MindStudio Insight is running, click OK in the dialog box. Then, choose System Settings > Privacy & Security > Security, select App Store & Known Developers, and click Open Anyway in the "MindStudio Insight" was blocked to protect your Mac dialog box to grant the execute permission, and double-click the MindStudio Insight application again. If the dialog box indicating that MindStudio Insight cannot be opened is displayed, click Done to open MindStudio Insight.
- To open multiple MindStudio Insight tools on macOS at the same time, run the open -n /Applications/MindStudio Insight.app command in the CLI. However, you are not advised to open the same data in two MindStudio Insight windows at the same time to avoid data parsing problems.

Installation (JupyterLab Plugin)

Introduction

In the Linux environment, MindStudio Insight can be integrated into JupyterLab as a plugin to provide a more intuitive and interactive user interface. Table 1 Advantages of the JupyterLab plugin describes the advantages of the JupyterLab plugin.

Table 1 Advantages of the JupyterLab plugin

Advantage	Description
Seamless integration	The MindStudio Insight tool can be directly run in the Jupyter environment without switching platforms or copying data from the server. This enables data to be used immediately after being collected.
Quick boot	The MindStudio Insight tool can be quickly started through the CLI or GUI of JupyterLab.
Smooth running	In Linux environments, launching MindStudio Insight through the JupyterLab interface effectively resolves runtime lag issues compared to packet-based communication, delivering a significantly improved operational experience.
Remote connection	You can remotely start MindStudio Insight and use a local browser to remotely connect to the service for visualized analysis, which alleviates the difficulties in uploading and downloading training or inference data of models.

Preparing the Environment

Run the following command to install JupyterLab in the Linux OS. For details about the environment requirements, see Table 2 Environment requirements.

pip install jupyterlab

Table 2 Environment requirements

Type	Requirement
Supported OSs	Linux
Dependencies	Version: Python 3.8 or later To open cluster data, install the Python dependencies by referring to section "Installing Dependencies".
JupyterLab	Version: JupyterLab 4.0 or later, but earlier than 5.0

After the installation is complete, check the JupyterLab version.
```
jupyter --version
```

(Optional) Use conda to manage the environment.

Run the following commands to create and activate a virtual environment:

conda create -n {your_env_name} python={python version} jupyterlab={jupyterlab version}  
conda activate {your_env_name} # Activate the virtual environment.

Procedure

Install the MindStudio Insight plugin package.
```
pip install mindstudio_insight_jupyterlab-{version}-py3-none-{platform}.whl
```
NOTE
Before installing the plugin package, check the umask setting of the current user. The recommended setting is 0027. For details, see the Security Statement.
Check whether MindStudio Insight is successfully installed.
```
jupyter labextension list
```
If the following information is displayed, the installation is successful:
```
mindstudio_insight_jupyterlab v{version} enabled  X (python, mindstudio_insight_jupyterlab)
```
Enable the JupyterLab service and open the MindStudio Insight tool.
- If you are not the root user, run the following command:
```
jupyter lab
```
- If you are the root user, run the following command:
```
jupyter lab --allow-root
```
NOTE
You are advised to run commands as a non-root user. If you need to run commands as the root user, strictly follow the instructions for the root user. Otherwise, security risks may occur.

After the JupyterLab service is enabled, enter "http://{your_server_ip}:{your_server_port}/lab" in the address box of the browser to open the JupyterLab home page, as shown in Figure 1 JupyterLab home page. Click the MindStudio Insight icon to open the MindStudio Insight tool.

Figure 1 JupyterLab home page
If the MindStudio Insight icon is not displayed on the JupyterLab home page, run the following command to check whether the MindStudio Insight plugin is enabled:
```
jupyter server extension list 
```
- If the following information is displayed, the plugin has been enabled:
```
mindstudio_insight_jupyterlab enabled
    - Validating mindstudio_insight_jupyterlab...
      mindstudio_insight_jupyterlab  OK
```
- If the plugin is not enabled, run the following command to enable it:
```
jupyter server extension enable mindstudio_insight_jupyterlab
```
After the MindStudio Insight plugin is enabled, repeat step 3 to open the MindStudio Insight tool.

Precautions
- If the browser is not installed on the local PC or the foundation model performance tuning data and JupyterLab are stored on the server, enable the service and load the data on the server, and then use the local browser to access and view the data. To enable the JupyterLab service, perform the following steps:
  1. Create a JupyterLab configuration file. The configuration here is the official JupyterLab configuration, which is irrelevant to the MindStudio Insight plugin.
```
jupyter lab --generate-config
```
  2. Go to the jupyter directory and open the jupyter_lab_config.py configuration file.
  3. Modify the configuration file. Search for the keywords c.ServerApp.ip and c.ServerApp.open_browser, delete the comment tags (#) at the beginning of the lines where the keywords are located, modify the parameters in the configuration file, and save the file for the configuration file to take effect.
```
# Modify the parameters to make them take effect (remove the comments in the configuration file).
c.ServerApp.ip = '0.0.0.0'
c.ServerApp.open_browser = False
```
  4. After the configuration is complete, restart the JupyterLab service and open the MindStudio Insight tool by referring to 3.
- If the cloud platform you are using has integrated the JupyterLab service and you need to use MindStudio Insight on the cloud platform, you can install the Jupyter proxy service plugin jupyter-server-proxy on the cloud platform to use MindStudio Insight.
  If the Jupyter proxy service plugin cannot be installed on the cloud platform and ports 9000 to 9099 are not enabled on the public network, the MindStudio Insight tool cannot be used.
  1. Install the Jupyter proxy service plugin.
```
pip install jupyter-server-proxy
```
  2. Restart the JupyterLab service and open the MindStudio Insight tool by referring to 3.
- On the JupyterLab home page, you can click the MindStudio Insight icon for multiple times to open multiple MindStudio Insight tab pages, which can be used at the same time.
- Pay attention to the security risks when using the MindStudio Insight tool installed using the JupyterLab plugin. For details, see Security Statement.

Installation (Plugin Development)

MindStudio Insight supports plugin development. Developers can develop and install plugin packages to implement independent development functions.

Developing a Plugin

Developers can develop plugins. For details, see Plugin Development Guide.

The plugin package must meet the following requirements:

The plugin package must be a ZIP package.
The plugin package must contain the following files:
- config.json configuration file
- Frontend product: The file must be a ZIP package, which contains the frontend asset directory and its files, and the index.html file.
- Backend product: The file must be a ZIP package, which contains the dynamic libraries required by the plugin and a single dynamic library file of the corresponding platform and architecture. The key value of the backend product in the config.json configuration file is "backend_{platform}_{machine}", where platform indicates the platform name and machine indicates the architecture name. For example, in the Linux x86 environment, the key value of the backend product is backend_linux_x86_64.
The config.json configuration file must meet the following requirements:
```
{
    "pluginName": "*Plugin Name*",
    "frontend":"Frontend product name",                      # ZIP package
    "backend_{platform}_{machine}":"Backend product name",  # ZIP package or dynamic library
}
```
In the command, platform indicates the platform name, and machine indicates the architecture name.
The number of files in the plugin package cannot exceed 1000, and the size of a single file cannot exceed 200 MB.
The plugin package must be owned by the current user and have the read and write permissions. Link files and files containing links are not supported.

NOTE

MindStudio Insight supports the loading of any plugin in the .so format. You must verify the integrity of the required plugin package to ensure that the package is from a secure and reliable source, thereby avoiding potential security risks such as community poisoning and malicious code injection.

Installing a Plugin

Go to the installation directory of MindStudio Insight and run the following command to install the developed plugin package. plugin package path indicates the path of the plugin package.

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

Using a Plugin

After the installation is complete, open MindStudio Insight and import data.

If the wakeup logic is developed independently, use the plugin package based on the actual situation.

Upgrading MindStudio Insight

To upgrade MindStudio Insight, uninstall the existing one, obtain the latest MindStudio Insight software package, and install it.

Uninstall MindStudio Insight by referring to Uninstalling MindStudio Insight and install the latest MindStudio Insight software package.

Uninstalling MindStudio Insight

Uninstallation (Windows)

Go to the MindStudio Insight installation directory and double-click Uninstall.exe. The uninstallation page is displayed. Click Uninstall, as shown in Figure 1 MindStudio Insight uninstallation page.

Figure 1 MindStudio Insight uninstallation page
Click Next.

Figure 2 Uninstallation
Select Remove cache data to clear cache data and click Uninstall.

Figure 3 Clearing cache data
The uninstallation is complete.

Figure 4 Uninstallation completed

Uninstallation (Linux)

In the Linux OS, you can uninstall MindStudio Insight in either of the following ways:

Method 1: Directly delete the decompressed MindStudio Insight software package. This operation does not delete log files.
Method 2: Use the command line to uninstall MindStudio Insight.
1. Run the following command to uninstall MindStudio Insight:
```
rm -rf MindStudio-Insight resources
```
2. Run the following command to delete the log files of MindStudio Insight:
```
rm -rf ${HOME}/.mindstudio_insight
```

Uninstallation (macOS)

Access the Applications and find MindStudio Insight.
Right-click the MindStudio Insight application. The menu bar is displayed.
Click Move to Trash to uninstall the application.

Uninstallation (JupyterLab Plugin)

Uninstall the MindStudio Insight plugin package.

pip uninstall mindstudio_insight_jupyterlab