MindSpore Installation Guide

This document describes how to quickly install MindSpore in an Ascend AI processor environment.

• MindSpore Installation Guide
  • Environment Requirements
    • Hardware Requirements
    • System Requirements and Software Dependencies
    • (Optional) Installing Conda
    • Configuring software package Dependencies
  • Installation Guide
    • Installing Using Executable Files
    • Installing Using the Source Code
  • Configuring Environment Variables
  • Installation Verification
• Installing MindInsight
• Installing MindArmour
• Installing MindSpore Hub

Environment Requirements

Hardware Requirements

• Ascend 910 AI processor

  • Reserve at least 32 GB memory for each card.

System Requirements and Software Dependencies

• Confirm that the current user has the right to access the installation path /usr/local/Ascendof Ascend 910 AI processor software package(Version:Atlas Data Center Solution V100R020C10T500: A800-9000 1.0T112, CANN V100R020C10T100). If not, the root user needs to add the current user to the user group where /usr/local/Ascend is located. For the specific configuration, please refer to the software package instruction document.
• GCC 7.3.0 can be installed by using apt command.
• When the network is connected, dependency items in the requirements.txt file are automatically downloaded during .whl package installation. In other cases, you need to manually install dependency items.

(Optional) Installing Conda

1. Download the Conda installation package from the following path:

   • X86 Anaconda or X86 Miniconda
   • ARM Anaconda

2. Create and activate the Python environment.

   conda create -n {your_env_name} python=3.7.5
   conda activate {your_env_name}
   Copy

Conda is a powerful Python environment management tool. Beginers are adviced to check related information on the Internet.

Configuring software package Dependencies

• Install the .whl package provided in Ascend 910 AI processor software package(Version:Atlas Data Center Solution V100R020C10T500: A800-9000 1.0T112, CANN V100R020C10T100). The .whl package is released with the software package. After software package is upgraded, reinstall the .whl package.

  pip install /usr/local/Ascend/fwkacllib/lib64/topi-{version}-py3-none-any.whl
  pip install /usr/local/Ascend/fwkacllib/lib64/te-{version}-py3-none-any.whl
  pip install /usr/local/Ascend/fwkacllib/lib64/hccl-{version}-py3-none-any.whl
  Copy

Installation Guide

Installing Using Executable Files

• Download the .whl package from the MindSpore website. It is recommended to perform SHA-256 integrity verification first and run the following command to install MindSpore:

  pip install mindspore_ascend-{version}-cp37-cp37m-linux_{arch}.whl
  Copy

Installing Using the Source Code

The compilation and installation must be performed on the Ascend 910 AI processor environment.

1. Download the source code from the code repository.

   git clone https://gitee.com/mindspore/mindspore.git -b r1.0
   Copy

2. Run the following command in the root directory of the source code to compile MindSpore:

   bash build.sh -e ascend
   Copy

   • Before running the preceding command, ensure that the paths where the executable files cmake and patch store have been added to the environment variable PATH.
   • In the build.sh script, the git clone command will be executed to obtain the code in the third-party dependency database. Ensure that the network settings of Git are correct.
   • In the build.sh script, the default number of compilation threads is 8. If the compiler performance is poor, compilation errors may occur. You can add -j{Number of threads} in to script to reduce the number of threads. For example, bash build.sh -e ascend -j4.

3. Run the following command to install MindSpore:

   chmod +x build/package/mindspore_ascend-{version}-cp37-cp37m-linux_{arch}.whl
   pip install build/package/mindspore_ascend-{version}-cp37-cp37m-linux_{arch}.whl
   Copy

Configuring Environment Variables

• If Ascend 910 AI processor software is installed in a non-default path, after MindSpore is installed, export runtime-related environment variables.

  # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, default level is WARNING.
  export GLOG_v=2
  
  # Set Soc Version, if this environment variable is not set, the program will read the default value from the system.
  export SOC_VERSION=Ascend910
  
  # Conda environmental options
  LOCAL_ASCEND=/usr/local/Ascend # the root directory of run package
  
  # lib libraries that the run package depends on
  export LD_LIBRARY_PATH=${LOCAL_ASCEND}/add-ons/:${LOCAL_ASCEND}/ascend-toolkit/latest/fwkacllib/lib64:${LOCAL_ASCEND}/driver/lib64:${LD_LIBRARY_PATH}
  
  # Environment variables that must be configured
  export TBE_IMPL_PATH=${LOCAL_ASCEND}/ascend-toolkit/latest/opp/op_impl/built-in/ai_core/tbe            # TBE operator implementation tool path
  export ASCEND_OPP_PATH=${LOCAL_ASCEND}/ascend-toolkit/latest/opp                                       # OPP path
  export PATH=${LOCAL_ASCEND}/ascend-toolkit/latest/fwkacllib/ccec_compiler/bin/:${PATH}                 # TBE operator compilation tool path
  export PYTHONPATH=${TBE_IMPL_PATH}:${PYTHONPATH}                                                # Python library that TBE implementation depends on
  
  Copy

Installation Verification

• After configuring the environment variables, execute the following Python script：

  import numpy as np
  from mindspore import Tensor
  from mindspore.ops import functional as F
  import mindspore.context as context
  
  context.set_context(device_target="Ascend")
  x = Tensor(np.ones([1,3,3,4]).astype(np.float32))
  y = Tensor(np.ones([1,3,3,4]).astype(np.float32))
  print(F.tensor_add(x, y))
  Copy

• The outputs should be the same as:

  [[[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]],
  
   [[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]],
  
   [[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]]]
  Copy

Installing MindInsight

If you need to analyze information such as model scalars, graphs, and model traceback, you can install MindInsight.

Environment Requirements

System Requirements and Software Dependencies

• When the network is connected, dependency items in the requirements.txt file are automatically downloaded during .whl package installation. In other cases, you need to manually install dependency items.

Installation Guide

Installing Using Executable Files

1. Download the .whl package from the MindSpore website. It is recommended to perform SHA-256 integrity verification first and run the following command to install MindInsight:

   pip install mindinsight-{version}-cp37-cp37m-linux_{arch}.whl
   Copy

2. Run the following command. If web address: http://127.0.0.1:8080 is displayed, the installation is successful.

   mindinsight start
   Copy

Installing Using the Source Code

1. Download the source code from the code repository.

   git clone https://gitee.com/mindspore/mindinsight.git -b r1.0
   Copy

   You are not supposed to obtain the source code from the zip package downloaded from the repository homepage.

2. Install MindInsight by using either of the following installation methods:

   (1) Access the root directory of the source code and run the following installation command:

   cd mindinsight
   pip install -r requirements.txt
   python setup.py install
   Copy

   (2) Create a .whl package to install MindInsight.

   Access the root directory of the source code. First run the MindInsight compilation script under the build directory of the source code. Then run the command to install the .whl package generated in the output directory of the source code.

   cd mindinsight
   bash build/build.sh
   pip install output/mindinsight-{version}-cp37-cp37m-linux_{arch}.whl
   Copy

3. Run the following command. If web address: http://127.0.0.1:8080 is displayed, the installation is successful.

   mindinsight start
   Copy

Installing MindArmour

If you need to conduct AI model security research or enhance the security of the model in you applications, you can install MindArmour.

Environment Requirements

System Requirements and Software Dependencies

• When the network is connected, dependency items in the setup.py file are automatically downloaded during .whl package installation. In other cases, you need to manually install dependency items.

Installation Guide

Installing Using Executable Files

1. Download the .whl package from the MindSpore website. It is recommended to perform SHA-256 integrity verification first and run the following command to install MindArmour:

   pip install mindarmour-{version}-cp37-cp37m-linux_{arch}.whl
   Copy

2. Run the following command. If no loading error message such as No module named 'mindarmour' is displayed, the installation is successful.

   python -c 'import mindarmour'
   Copy

Installing Using the Source Code

1. Download the source code from the code repository.

   git clone https://gitee.com/mindspore/mindarmour.git -b r1.0
   Copy

2. Run the following command in the root directory of the source code to compile and install MindArmour:

   cd mindarmour
   python setup.py install
   Copy

3. Run the following command. If no loading error message such as No module named 'mindarmour' is displayed, the installation is successful.

   python -c 'import mindarmour'
   Copy

Installing MindSpore Hub

If you need to access and experience MindSpore pre-trained models quickly, you can install MindSpore Hub.

For details about install steps, see MindSpore Hub.