diff --git a/install/mindspore_ascend310_install_binary_en.md b/install/mindspore_ascend310_install_binary_en.md index 078e6fe9eb3150b55d4f4cd962ecbd261b369f57..9d564d9274703ff520a76f1e04d48dba979663c2 100644 --- a/install/mindspore_ascend310_install_binary_en.md +++ b/install/mindspore_ascend310_install_binary_en.md @@ -23,6 +23,7 @@ The following describes how to quickly install MindSpore by pip on Linux in the - Ensure that [GMP 6.1.2](https://gmplib.org/download/gmp/gmp-6.1.2.tar.xz) is installed. - Ensure that [CMake 3.18.3 or later](https://cmake.org/download/) is installed. + - After installation, add the path of CMake to the system environment variables. - Ensure that Python 3.7.5 or 3.9.0 is installed. If not installed, download and install Python from: @@ -31,7 +32,7 @@ The following describes how to quickly install MindSpore by pip on Linux in the - Ensure that the Ascend AI processor software package (Ascend Data Center Solution 21.0.4) are installed, please refer to the [Installation Guide](https://support.huawei.com/enterprise/zh/doc/EDOC1100235797?section=j003). - - Ensure that you have permissions to access the installation path `/usr/local/Ascend` of the Ascend AI Processor software package. If not, ask the user root to add you to a user group to which `/usr/local/Ascend` belongs. For details about the configuration, see the description document in the software package. + - Ensure that you have permissions to access the installation path `/usr/local/Ascend` of the Ascend AI Processor software package. If not, ask the root user to add you to a user group to which `/usr/local/Ascend` belongs. - Install the .whl package provided with the Ascend AI Processor software package. The .whl package is released with the software package. After the software package is upgraded, you need to reinstall the .whl package. ```bash @@ -51,12 +52,12 @@ tar -zxf mindspore_ascend-{version}-linux_{arch}.tar.gz In the preceding information: -- `{version}` specifies the MindSpore version number. For example, when installing MindSpore 1.5.0, set `{version}` to 1.5.0, when installing MindSpore 1.5.0-rc1, the first `{version}` which represents download path should be written as 1.5.0-rc1, and the second `{version}` which represents file name should be 1.5.0rc1. -- `{arch}` specifies the system architecture. For example, if a Linux OS architecture is x86_64, set `{arch}` to `x86_64`. If the system architecture is ARM64, set `{arch}` to `aarch64`. +- `{version}` specifies the MindSpore version number. For example, when installing MindSpore 1.5.0, set `{version}` to 1.5.0. When installing MindSpore 1.5.0-rc1, the first `{version}` which represents download path should be written as 1.5.0-rc1, and the second `{version}` which represents version number should be 1.5.0rc1. +- `{arch}` specifies the system architecture. For example, if a Linux OS architecture is x86_64, set `{arch}` to `x86_64`. If the system architecture is ARM_64, set `{arch}` to `aarch64`. ## Configuring Environment Variables -After MindSpore is installed, export runtime environment variables. In the following command, `/usr/local/Ascend` in `LOCAL_ASCEND=/usr/local/Ascend` indicates the installation path of the software package. Change it to the actual installation path. +After MindSpore is installed, export runtime environment variables. In the following command, `/usr/local/Ascend` in `LOCAL_ASCEND=/usr/local/Ascend` indicates the installation path of the software package, and you need to replace it as the actual installation path of the software package. ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, 4-CRITICAL, default level is WARNING. @@ -87,9 +88,8 @@ In the preceding information: Create a directory to store the sample code project, for example, `/home/HwHiAiUser/Ascend/ascend-toolkit/20.0.RC1/acllib_linux.arm64/sample/acl_execute_model/ascend310_single_op_sample`. You can obtain the code from the [official website](https://obs.dualstack.cn-north-4.myhuaweicloud.com/mindspore-website/sample_resources/ascend310_single_op_sample.zip). A simple example of adding `[1, 2, 3, 4]` to `[2, 3, 4, 5]` is used and the code project directory structure is as follows: ```text - └─ascend310_single_op_sample - ├── CMakeLists.txt // Build script + ├── CMakeLists.txt // Compile script ├── README.md // Usage description ├── main.cc // Main function └── tensor_add.mindir // MindIR model file @@ -101,7 +101,7 @@ Go to the directory of the sample project and change the path based on the actua cd /home/HwHiAiUser/Ascend/ascend-toolkit/20.0.RC1/acllib_linux.arm64/sample/acl_execute_model/ascend310_single_op_sample ``` -Build a project by referring to `README.md`, modify`{mindspore_path}`which specifies the absolute path to MindSpore. +Build a project by referring to `README.md`, where `{mindspore_path}` represents the absolute path to the location where the MindSpore binary package is located, and is replaced according to the actual situation. ```bash cmake . -DMINDSPORE_PATH={mindspore_path} @@ -123,4 +123,4 @@ The following information is displayed: 9 ``` -The preceding information indicates that MindSpore is successfully installed. +It is indicated that MindSpore is successfully installed. diff --git a/install/mindspore_ascend_install_conda_en.md b/install/mindspore_ascend_install_conda_en.md index e4516d9d4eea718f63fd4afecb0a15e9c64eee70..d0ae193ea8d8410fc2be2787285afdf6b07f9d41 100644 --- a/install/mindspore_ascend_install_conda_en.md +++ b/install/mindspore_ascend_install_conda_en.md @@ -31,7 +31,7 @@ This document describes how to quickly install MindSpore in a Linux system with wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-conda.sh # install Python 3.7 and the latest MindSpore by default bash -i ./euleros-ascend-conda.sh - # to specify Python and MindSpore version, e.g. Python 3.9 and MindSpore 1.5.0 + # to specify Python and MindSpore version, taking Python 3.9 and MindSpore 1.5.0 as examples, use the following manners # PYTHON_VERSION=3.9 MINDSPORE_VERSION=1.5.0 bash -i ./euleros-ascend-conda.sh ``` @@ -46,7 +46,7 @@ This document describes how to quickly install MindSpore in a Linux system with For more usage, see the script header description. -- If some dependencies, such as Python and GCC, have been installed in your system, you are advised to perform the following steps to manually install MindSpore. +- If some dependencies, such as CUDA, Conda and GCC, have been installed in your system, you are advised to perform the following steps to manually install MindSpore. ## Installing Environment Dependencies @@ -96,6 +96,8 @@ cd - conda init bash ``` +After the installation is complete, you can set up Tsinghua Source to accelerate the download for Conda, and refer to [Here](https://mirrors.tuna.tsinghua.edu.cn/help/anaconda/). + ### Installing GCC - On Ubuntu 18.04, run the following commands to install. @@ -188,7 +190,7 @@ pip uninstall te topi hccl -y ## Installing MindSpore -Ensure that you are in the Conda virtual environment and run the following command to install the latest MindSpore. To install other versions, please refer to [Version List](https://www.mindspore.cn/versions) and specify the version after `mindspore-ascend=`. +Ensure that you are in the Conda virtual environment and run the following command to install the latest MindSpore. To install other versions, please refer to the specified the version of [Version List](https://www.mindspore.cn/versions) after `mindspore-ascend=`. ```bash conda install mindspore-ascend -c mindspore -c conda-forge @@ -198,7 +200,7 @@ When the network is connected, dependencies of MindSpore are automatically downl ## Configuring Environment Variables -**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, please replace it as your actual installation path. +**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export Runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, and you need to replace it as the actual installation path of the software package. ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, 4-CRITICAL, default level is WARNING. @@ -272,7 +274,7 @@ It means MindSpore has been installed successfully. ## Version Update -Using the following command if you need to update the MindSpore version: +Use the following command if you need to update the MindSpore version: ```bash conda update mindspore-ascend -c mindspore -c conda-forge diff --git a/install/mindspore_ascend_install_docker_en.md b/install/mindspore_ascend_install_docker_en.md index 05d13f8886445f77760be3e2f08b14f93bfacba8..1c26e2316262efa8185edbb81feae23ee217244c 100644 --- a/install/mindspore_ascend_install_docker_en.md +++ b/install/mindspore_ascend_install_docker_en.md @@ -13,7 +13,7 @@ -[Docker](https://docs.docker.com/get-docker/) is an open source application container engine, developers can package their applications and dependencies into a lightweight, portable container. By using Docker, MindSpore can be rapidly deployed and separated from the system environment. +[Docker](https://docs.docker.com/get-docker/) is an open source application container engine, and developers can package their applications and dependencies into a lightweight, portable container. By using Docker, MindSpore can be rapidly deployed and separated from the system environment. This document describes how to quickly install MindSpore in a Linux system with an Ascend 910 environment by Docker. @@ -40,7 +40,7 @@ The current support for containerized build options is as follows: ## Obtaining MindSpore Image -1. Log in to [Ascend Hub Image Center](https://ascend.huawei.com/ascendhub/#/home), register and activate an account, get login instructions and download instructions. +1. Log in to [Ascend Hub Image Center](https://ascend.huawei.com/ascendhub/#/home), and register and activate an account. Get login instructions and download instructions. 2. After obtaining the download permission, enter the [MindSpore image download page](https://ascendhub.huawei.com/#/detail/mindspore-modelzoo). Get login and download commands and execute: ```bash @@ -121,7 +121,7 @@ MindSpore version: __version__ The result of multiplication calculation is correct, MindSpore has been installed successfully! ``` -It means MindSpore has been installed by docker successfully. +So far, it means MindSpore Ascend 910 has been installed by Docker successfully. ii: @@ -153,7 +153,7 @@ The outputs should be the same as: [2. 2. 2. 2.]]]] ``` -It means MindSpore has been installed by docker successfully. +So far, it means MindSpore Ascend 910 has been installed by Docker successfully. If you need to verify the MindInsight installation: @@ -163,8 +163,8 @@ Enter ```mindinsight start --port 8080```, if it prompts that the startup status When you need to update the MindSpore version: -- update Ascend AI processor software package according to MindSpore package version of which you wish to update. -- log in to [Ascend Hub Image Center](https://ascend.huawei.com/ascendhub/#/home) again to obtain the download command of the latest docker version and execute: +- update corresponding Ascend AI processor software package according to MindSpore package version of which you wish to update. +- log in to [Ascend Hub Image Center](https://ascend.huawei.com/ascendhub/#/home) again to obtain the download command of the latest Docker and execute: ```bash docker pull ascendhub.huawei.com/public-ascendhub/mindspore-modelzoo:{tag} diff --git a/install/mindspore_ascend_install_pip_en.md b/install/mindspore_ascend_install_pip_en.md index 970d9c237524a6e76cc31de5ab1c319b3f54bc69..62940865d30c7f35ee7df3aff65ca62581d504f7 100644 --- a/install/mindspore_ascend_install_pip_en.md +++ b/install/mindspore_ascend_install_pip_en.md @@ -20,7 +20,7 @@ This document describes how to quickly install MindSpore in a Linux system with an Ascend 910 environment by pip. -- If you want to install MindSpore by pip on a EulerOS 2.8 with Ascend AI processor software package installed, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-pip.sh) for one-click installation. The automatic installation script will install the dependencies required to compile MindSpore. +- If you want to install MindSpore by pip on an EulerOS 2.8 with the configured Ascend AI processor software package, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-pip.sh) for one-click installation. The automatic installation script will install MindSpore and its required dependencies. Run the following command to obtain and run the automatic installation script: @@ -28,7 +28,7 @@ This document describes how to quickly install MindSpore in a Linux system with wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-pip.sh # install Python 3.7 and MindSpore 1.6.0 by default bash -i ./euleros-ascend-pip.sh - # to specify Python and MindSpore version, e.g. Python 3.9 and MindSpore 1.5.0 + # to specify Python and MindSpore version, taking Python 3.9 and MindSpore 1.5.0 as examples, use the following manners # PYTHON_VERSION=3.9 MINDSPORE_VERSION=1.5.0 bash -i ./euleros-ascend-pip.sh ``` @@ -64,7 +64,7 @@ The following describes how to install the third-party dependencies. For detailed installation guide, please refer to [Ascend Data Center Solution 21.0.4 Installation Guide](https://support.huawei.com/enterprise/zh/doc/EDOC1100235797?section=j003). -The default installation path of the installation package is `/usr/local/Ascend`. Ensure that the current user has the right to access the installation path `/usr/local/Ascend` of Ascend AI processor software package, If not, the root user needs to add the current user to the user group where `/usr/local/Ascend` is located. +The default installation path of the installation package is `/usr/local/Ascend`. Ensure that the current user has the right to access the installation path of Ascend AI processor software package, If not, the root user needs to add the current user to the user group where `/usr/local/Ascend` is located. Install the .whl packages provided in Ascend AI processor software package. The .whl packages are released with the software package. If the .whl packages have been installed before, you need to uninstall the packages by the following command. @@ -95,6 +95,8 @@ cd - conda init bash ``` +After the installation is complete, you can set up Tsinghua source acceleration download for Conda, and see [here](https://mirrors.tuna.tsinghua.edu.cn/help/anaconda/). + Create a Python 3.7.5 environment: ```bash @@ -115,7 +117,7 @@ Run the following command to check the Python version. python --version ``` -If you are using a ARM architecture system, please ensure that pip installed for current Python has a version >= 19.3. If not, upgrade pip with the following command. +If you are using an ARM architecture system, please ensure that pip installed for current Python has a version >= 19.3. If not, upgrade pip with the following command. ```bash python -m pip install -U pip @@ -181,7 +183,7 @@ cd - ## Installing MindSpore -First, refer to [Version List](https://www.mindspore.cn/versions) to select the version of MindSpore you want to install, and perform SHA-256 integrity check. Take version 1.6.0 as an example, execute the following commands. +First, refer to [Version List](https://www.mindspore.cn/versions) to select the version of MindSpore you want to install, and perform SHA-256 integrity check. Taking version 1.6.0 as an example, execute the following commands. ```bash export MS_VERSION=1.6.0 @@ -204,7 +206,7 @@ When the network is connected, dependencies of MindSpore are automatically downl ## Configuring Environment Variables -**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, please replace it as your actual installation path. +**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, and you need to replace it as the actual installation path of the software package. ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, 4-CRITICAL, default level is WARNING. @@ -278,7 +280,7 @@ It means MindSpore has been installed successfully. ## Version Update -Using the following command if you need to update the MindSpore version: +Use the following command if you need to update the MindSpore version: ```bash pip install --upgrade mindspore-ascend=={version} @@ -286,4 +288,4 @@ pip install --upgrade mindspore-ascend=={version} Of which, -- When updating to a release candidate (rc) version, `{version}` should be specified, e.g. 1.5.0rc1; When updating to a standard release, `=={version}` could be removed. +- When updating to a release candidate (rc) version, `{version}` should be specified manually as the rc version number, e.g. 1.5.0rc1; When updating to a standard release, `=={version}` could be removed. diff --git a/install/mindspore_ascend_install_source_en.md b/install/mindspore_ascend_install_source_en.md index 7764350f3276a42d295ea9b4723d5454776e37ca..3e2ae402f1a549dc74489d209927ad84e181729e 100644 --- a/install/mindspore_ascend_install_source_en.md +++ b/install/mindspore_ascend_install_source_en.md @@ -23,11 +23,11 @@ -This document describes how to quickly install MindSpore in a Linux system with an Ascend 910 environment by source code. +This document describes how to quickly install MindSpore in a Linux system with an Ascend 910 environment by source code compilation. ## Environment Preparation -- If you want to configure an environment that can compile MindSpore on a EulerOS 2.8 with Ascend AI processor software package installed, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-source.sh) for one-click configuration. The automatic installation script will install the dependencies required to compile MindSpore. +- If you want to configure an environment that can compile MindSpore on an EulerOS 2.8 with Ascend AI processor software package installed, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-source.sh) for one-click configuration. The automatic installation script will install the dependencies required to compile MindSpore. Run the following command to obtain and run the automatic installation script: @@ -35,7 +35,7 @@ This document describes how to quickly install MindSpore in a Linux system with wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend-source.sh # install Python 3.7 by default bash -i ./euleros-ascend-source.sh - # to install Python 3.9 and optional dependencies Open MPI + # to specify the Python 3.9 installation and install the optional dependencies Open MPI, use the following manner # PYTHON_VERSION=3.9 OPENMPI=on bash -i ./euleros-ascend-source.sh ``` @@ -59,15 +59,15 @@ The following table lists the system environment and third-party dependencies re |[wheel](#installing-wheel-and-setuptools)|0.32.0 or later|Python packaging tool used by MindSpore| |[setuptools](#installing-wheel-and-setuptools)|44.0 or later|Python package management tool used by MindSpore| |[GCC](#installing-gcc)|7.3.0|C++ compiler for compiling MindSpore| -|[git](#installing-git-gmp-tclsh-patch-numa-and-flex)|-|Source code management tools used by MindSpore| -|[git-lfs](#installing-git-lfs)|-|Source code management tools used by MindSpore| -|[CMake](#installing-cmake)|3.18.3 or later|Build tools for MindSpore| +|[git](#installing-git-gmp-tclsh-patch-numa-and-flex)|-|Source code management tool used by MindSpore| +|[git-lfs](#installing-git-lfs)|-|Source code management tool used by MindSpore| +|[CMake](#installing-cmake)|3.18.3 or later|Build tool for MindSpore| |[gmp](#installing-git-gmp-tclsh-patch-numa-and-flex)|6.1.2|Multiple precision arithmetic library used by MindSpore| |[Flex](#installing-git-gmp-tclsh-patch-numa-and-flex)|2.5.35 or later|lexical analyzer used by MindSpore| |[tclsh](#installing-git-gmp-tclsh-patch-numa-and-flex)|-|MindSpore SQLite build dependency| |[patch](#installing-git-gmp-tclsh-patch-numa-and-flex)|2.5 or later|Source code patching tool used by MindSpore| -|[NUMA](#installing-git-gmp-tclsh-patch-numa-and-flex)|2.0.11 or later|non-uniform memory access library used by MindSpore| -|[Open MPI](#installing-open-mpi-optional)|4.0.3|high performance message passing library used by MindSpore (optional, required for single-node/multi-GPU and multi-node/multi-GPU training)| +|[NUMA](#installing-git-gmp-tclsh-patch-numa-and-flex)|2.0.11 or later|Non-uniform memory access library used by MindSpore| +|[Open MPI](#installing-open-mpi-optional)|4.0.3|High performance message passing library used by MindSpore (optional, required for single-node/multi-GPU and multi-node/multi-GPU training)| The following describes how to install the third-party dependencies. @@ -83,7 +83,7 @@ Install the .whl packages provided in Ascend AI processor software package. The pip uninstall te topi hccl -y ``` -Run the following command to install the .whl packages if the Ascend AI package has been installed in default path. If the installation path is not the default path, you need to replace the path in the command with the installation path. +Run the following command to install the .whl packages in the default path. If the installation path is not the default path, you need to replace the path in the command with the installation path. ```bash pip install /usr/local/Ascend/ascend-toolkit/latest/fwkacllib/lib64/topi-*-py3-none-any.whl @@ -106,6 +106,8 @@ cd - conda init bash ``` +After the installation is complete, you can set up Tsinghua source acceleration download for Conda, and see [here](https://mirrors.tuna.tsinghua.edu.cn/help/anaconda/). + Create a Python 3.7.5 environment: ```bash @@ -214,7 +216,7 @@ pip install -U setuptools - Other Linux systems can be installed with the following commands. - Choose one download link based on the system architecture. + Choose different download links based on the system architecture. ```bash # x86 run @@ -223,14 +225,14 @@ pip install -U setuptools curl -O https://cmake.org/files/v3.19/cmake-3.19.8-Linux-aarch64.sh ``` - run the script to install CMake, which is installed in the `/usr/local` by default. + Run the script to install CMake, which is installed in the `/usr/local` by default. ```bash sudo mkdir /usr/local/cmake-3.19.8 sudo bash cmake-3.19.8-Linux-*.sh --prefix=/usr/local/cmake-3.19.8 --exclude-subdir ``` - Finally, add CMake to the `PATH` environment variable. Run the following commands if it is installed in the default path, other installation path need to be modified accordingly. + Finally, add CMake to the `PATH` environment variable. Run the following commands if it is installed in the default path, other installation paths need to be modified accordingly. ```bash echo -e "export PATH=/usr/local/cmake-3.19.8/bin:\$PATH" >> ~/.bashrc @@ -271,8 +273,8 @@ bash build.sh -e ascend -S on Where: -- 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`. -- By default, the dependent source code is downloaded from GitHub. When `-S` is set to `on`, the source code is downloaded from the corresponding Gitee image. +- 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`. +- By default, the dependent source code is downloaded from gitHub. When -S is set to `on`, the source code is downloaded from the corresponding gitee image. - For details about how to use `build.sh`, see the script header description. ## Installing MindSpore @@ -285,7 +287,7 @@ When the network is connected, dependencies of MindSpore are automatically downl ## Configuring Environment Variables -**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, please replace it as your actual installation path. +**If Ascend AI processor software is installed in a non-default path**, after MindSpore is installed, export Runtime-related environment variables. `/usr/local/Ascend` in the following command `LOCAL_ASCEND=/usr/local/Ascend` denotes the installation path of the software package, and you need to replace it as the actual installation path of the software package. ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, 4-CRITICAL, default level is WARNING. @@ -359,9 +361,9 @@ It means MindSpore has been installed successfully. ## Version Update -Using the following command if you need to update the MindSpore version. +Use the following command if you need to update the MindSpore version. -- Update Online +- Update Online directly ```bash pip install --upgrade mindspore-ascend @@ -369,7 +371,7 @@ Using the following command if you need to update the MindSpore version. - Update after source code compilation - After successfully executing the compile script `build.sh` in the root path of the source code, find the whl package in path `output`, use the following command to update your version. + After successfully executing the compile script `build.sh` in the root path of the source code, find the whl package in path `output`, and use the following command to update your version. ```bash pip install --upgrade mindspore_ascend-*.whl