diff --git a/install/mindspore_ascend310_install_conda_en.md b/install/mindspore_ascend310_install_conda_en.md index 511ff2858a369c080ac78feb2edf06d7d945c3f5..906c48ff24af68757a3744ddf47aee45bfc0bf13 100644 --- a/install/mindspore_ascend310_install_conda_en.md +++ b/install/mindspore_ascend310_install_conda_en.md @@ -21,7 +21,7 @@ The following describes how to quickly install MindSpore by Conda on Linux in the Ascend 310 environment, MindSpore in Ascend 310 only supports inference. -- If you want to install MindSpore by Conda 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-conda.sh) for one-click installation. The automatic installation script will install the dependencies required to compile MindSpore. +- If you want to install MindSpore by Conda 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-conda.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: @@ -29,7 +29,7 @@ The following describes how to quickly install MindSpore by Conda on Linux in th 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 ``` @@ -43,7 +43,7 @@ The following describes how to quickly install MindSpore by Conda on Linux in th 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 @@ -51,7 +51,7 @@ The following table lists the system environment and third-party dependencies re |software|version|description| |-|-|-| -|Ubuntu 18.04/CentOS 7.6/EulerOS 2.8|-|OS for running MindSpore| +|Ubuntu 18.04/CentOS 7.6/EulerOS 2.8|-|OS for compiling and running MindSpore| |[Ascend AI processor software package](#installing-ascend-ai-processor-software-package)|-|Ascend platform AI computing library used by MindSpore| |[Conda](#installing-conda)|Anaconda3 or Miniconda3|Python environment management tool| |[GCC](#installing-gcc)|7.3.0|C++ compiler for compiling MindSpore| @@ -63,7 +63,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. @@ -92,6 +92,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/). + ### Installing GCC - On Ubuntu 18.04, run the following commands to install. @@ -167,7 +169,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 version number of [Version List](https://www.mindspore.cn/versions) after `mindspore-ascend=`. ```bash conda install mindspore-ascend -c mindspore -c conda-forge @@ -177,7 +179,7 @@ When the network is connected, dependencies of MindSpore are automatically downl ## 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-related 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. @@ -210,7 +212,7 @@ Create a directory to store the sample code project, for example, `/home/HwHiAiU ```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 @@ -222,7 +224,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 `pip3` according to the actual situation. +Build a project by referring to `README.md`, and modify `pip3` according to the actual situation. ```bash cmake . -DMINDSPORE_PATH=`pip3 show mindspore-ascend | grep Location | awk '{print $2"/mindspore"}' | xargs realpath` @@ -248,7 +250,7 @@ The preceding information indicates that MindSpore is successfully installed. ## 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_ascend310_install_pip_en.md b/install/mindspore_ascend310_install_pip_en.md index 9c1c0bcf97a117118614d9d3f6ee07cb4bcee177..b18a231c623bcecf7b0d31ba2566b1620764b22e 100644 --- a/install/mindspore_ascend310_install_pip_en.md +++ b/install/mindspore_ascend310_install_pip_en.md @@ -19,7 +19,7 @@ The following describes how to quickly install MindSpore by pip on Linux in the Ascend 310 environment, MindSpore in Ascend 310 only supports inference. -- 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-ascend310-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 Ascend AI processor software package installed, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend310-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: @@ -27,14 +27,14 @@ The following describes how to quickly install MindSpore by pip on Linux in the wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/euleros-ascend310-pip.sh # install Python 3.7 and MindSpore 1.6.0 by default bash -i ./euleros-ascend310-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-ascend310-pip.sh ``` This script performs the following operations: - - Install the dependencies required by MindSpore, such as GCC, gmp. - - Install Python3 and pip3 and set them as default. + - Install the dependencies required by MindSpore, such as GCC and gmp. + - Install Python3 and pip3 by APT and set them as default. - Install MindSpore Ascend by pip. After the script is executed, please refer to the instructions in [Configuring Environment Variables](#configuring-environment-variables) to set relevant environment variables. @@ -49,12 +49,12 @@ The following table lists the system environment and third-party dependencies re |software|version|description| |-|-|-| -|Ubuntu 18.04/CentOS 7.6/EulerOS 2.8|-|OS for running MindSpore| +|Ubuntu 18.04/CentOS 7.6/EulerOS 2.8|-|OS for running and compiling MindSpore| |[Ascend AI processor software package](#installing-ascend-ai-processor-software-package)|-|Ascend platform AI computing library used by MindSpore| -|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment that MindSpore depends on| +|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment on which MindSpore depends| |[GCC](#installing-gcc)|7.3.0|C++ compiler for compiling MindSpore| |[gmp](#installing-gmp)|6.1.2|Multiple precision arithmetic library used by MindSpore| -|[CMake](#installing-cmake)|3.18.3 or later|Build tools for MindSpore| +|[CMake](#installing-cmake)|3.18.3 or later| Compilation tool that builds MindSpore | The following describes how to install the third-party dependencies. @@ -62,7 +62,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. @@ -93,6 +93,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 @@ -113,7 +115,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 @@ -172,7 +174,7 @@ python -m pip install -U pip - 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 @@ -181,14 +183,14 @@ python -m pip install -U pip 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, and other installation path need to be modified accordingly. ```bash echo -e "export PATH=/usr/local/cmake-3.19.8/bin:\$PATH" >> ~/.bashrc @@ -197,7 +199,7 @@ python -m pip install -U pip ## 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 @@ -265,7 +267,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 `pip3` according to the actual situation. +Build a project by referring to `README.md`, and modify `pip3` according to the actual situation. ```bash cmake . -DMINDSPORE_PATH=`pip3 show mindspore-ascend | grep Location | awk '{print $2"/mindspore"}' | xargs realpath` diff --git a/install/mindspore_ascend310_install_source_en.md b/install/mindspore_ascend310_install_source_en.md index efa1cd8d9f17f41827ce833c29374caf56feeb6e..1606fe1d33000cddfae5f46045120356134fc769 100644 --- a/install/mindspore_ascend310_install_source_en.md +++ b/install/mindspore_ascend310_install_source_en.md @@ -31,7 +31,7 @@ The following describes how to quickly install MindSpore by compiling the source 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 + # to specify Python 3.9 installation, use the following manner # PYTHON_VERSION=3.9 bash -i ./euleros-ascend-source.sh ``` @@ -44,19 +44,19 @@ The following describes how to quickly install MindSpore by compiling the source - 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. -The following table lists the system environment and third-party dependencies required for building and installing MindSpore. +The following table lists the system environment and third-party dependencies required for compiling and installing MindSpore. |software|version|description| |-|-|-| |Ubuntu 18.04/CentOS 7.6/EulerOS 2.8|-|OS for compiling and running MindSpore| |[Ascend AI processor software package](#installing-ascend-ai-processor-software-package)|-|Ascend platform AI computing library used by MindSpore| -|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment that MindSpore depends on| +|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment on which MindSpore depends| |[GCC](#installing-gcc)|7.3.0|C++ compiler for compiling MindSpore| |[git](#installing-git-gmp-tclsh-patch-and-flex)|-|Source code management tools used by MindSpore| -|[CMake](#installing-cmake)|3.18.3 or later|Build tools for MindSpore| +|[CMake](#installing-cmake)|3.18.3 or later|Compilation tool that builds MindSpore| |[gmp](#installing-git-gmp-tclsh-patch-and-flex)|6.1.2|Multiple precision arithmetic library used by MindSpore| |[Flex](#installing-git-gmp-tclsh-patch-and-flex)|2.5.35 or later|lexical analyzer used by MindSpore| -|[tclsh](#installing-git-gmp-tclsh-patch-and-flex)|-|MindSpore SQLite build dependency| +|[tclsh](#installing-git-gmp-tclsh-patch-and-flex)|-|MindSpore SQLite compiling dependency| |[patch](#installing-git-gmp-tclsh-patch-and-flex)|2.5 or later|Source code patching tool used by MindSpore| The following describes how to install the third-party dependencies. @@ -65,7 +65,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. @@ -96,6 +96,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 @@ -169,7 +171,7 @@ python --version - 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 @@ -185,7 +187,7 @@ python --version 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 @@ -198,9 +200,9 @@ python --version git clone https://gitee.com/mindspore/mindspore.git ``` -## Building MindSpore +## Compiling MindSpore -Go to the root directory of mindspore, then run the build script. +Go to the root directory of MindSpore, then run the compiling script. ```bash cd mindspore @@ -209,8 +211,8 @@ bash build.sh -e ascend -V 310 -S on Where: -- The default number of build threads is 8 in `build.sh`. If the compiler performance is poor, build errors may occur. You can add -j{Number of threads} to script to reduce the number of threads. For example, `bash build.sh -e ascend -V 310 -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. +- The default number of build threads is 8 in `build.sh`. If the compiler performance is poor, compiling errors may occur. You can add -j{Number of threads} to script to reduce the number of threads, for example, `bash build.sh -e ascend -V 310 -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 @@ -221,7 +223,7 @@ tar -zxf output/mindspore_ascend-*.tar.gz ## 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-related 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. @@ -249,7 +251,7 @@ export LD_LIBRARY_PATH={mindspore_path}:${LD_LIBRARY_PATH} Where: -- `{mindspore_path}` specifies the absolute path to which MindSpore package is extracted. +- `{mindspore_path}` specifies the absolute path to which MindSpore binary package is extracted. ## Verifying the Installation @@ -258,7 +260,7 @@ Create a directory to store the sample code project, for example, `/home/HwHiAiU ```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 @@ -270,7 +272,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`, and`{mindspore_path}` specifies the absolute path to which MindSpore binary package is extracted, and replaces according to the actual condition. ```bash cmake . -DMINDSPORE_PATH={mindspore_path} diff --git a/install/mindspore_cpu_install_conda_en.md b/install/mindspore_cpu_install_conda_en.md index 2543d4c3d153edebabd5f99ff0f941bf16a5cc56..1cfe5909b2f047d8fed713f92ae1daa0584fabf0 100644 --- a/install/mindspore_cpu_install_conda_en.md +++ b/install/mindspore_cpu_install_conda_en.md @@ -19,21 +19,21 @@ This document describes how to quickly install MindSpore by Conda in a Linux system with a CPU environment. The following takes Ubuntu 18.04 as an example to describe how to install MindSpore. -- If you want to install MindSpore by Conda on a fresh Ubuntu 18.04, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-conda.sh) for one-click installation. The automatic installation script will install MindSpore and its dependencies. +- If you want to install MindSpore by Conda on a fresh Ubuntu 18.04, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-conda.sh) for one-click installation. The automatic installation script will install MindSpore and its required dependencies. - The automatic installation script needs to replace the source list and install dependencies via APT, it will apply for root privileges during execution. Run the following command to obtain and run the automatic installation script: + The automatic installation script needs to replace the source list and install dependencies via APT, it will apply for root permissions during execution. Run the following command to obtain and run the automatic installation script: ```bash wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-conda.sh # install Python 3.7 and the latest MindSpore by default bash ./ubuntu-cpu-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 ./ubuntu-cpu-conda.sh ``` This script performs the following operations: - - Change the source list to HUAWEI CLOUD source. + - Change the software source configuration to a HUAWEI CLOUD source. - Install the dependencies required by MindSpore, such as GCC, gmp. - Install Conda and create a virtual environment for MindSpore. - Install MindSpore CPU by Conda. @@ -68,6 +68,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/). + ### Installing GCC and gmp Run the following commands to install GCC and gmp. @@ -111,7 +113,7 @@ conda activate mindspore_py39 ## 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-cpu=`. +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 version number of [Version List](https://www.mindspore.cn/versions) after `mindspore-ascend=`. ```bash conda install mindspore-cpu -c mindspore -c conda-forge @@ -136,7 +138,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-cpu -c mindspore -c conda-forge diff --git a/install/mindspore_cpu_install_docker_en.md b/install/mindspore_cpu_install_docker_en.md index 9d4e95f04343460765d2ebf5c12bf62611596423..27a0ce40fb51438f32d276faad9ee53b9db4f8e6 100644 --- a/install/mindspore_cpu_install_docker_en.md +++ b/install/mindspore_cpu_install_docker_en.md @@ -12,13 +12,13 @@ -[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 by Docker in a Linux system with a CPU environment. The Docker image of MindSpore is hosted on [Huawei SWR](https://support.huaweicloud.com/swr/index.html). -The current support for containerized build is as follows: +The current support for the containerization build option is as follows: | Hardware | Docker Image Hub | Label | Note | | :----- | :------------------------ | :----------------------- | :--------------------------------------- | @@ -26,11 +26,11 @@ The current support for containerized build is as follows: | | | `devel` | Provide a development environment to build MindSpore from the source (`CPU` backend). For installation details, please refer to . | | | | `runtime` | Provide runtime environment, MindSpore binary package (`CPU` backend) is not installed. | -> `x.y.z` corresponds to the MindSpore version number. For example, when installing MindSpore version 1.1.0, `x.y.z` should be written as 1.1.0. +> `x.y.z` corresponds to the MindSpore version number. For example, when MindSpore version 1.1.0 is installed, `x.y.z` should be written as 1.1.0. ## System Environment Information Confirmation -- Ensure that a 64-bit Linux operating system is installed, where Ubuntu 18.04 is verified. +- Ensure that a 64-bit Linux operating system with the x86 architecture is installed, where Ubuntu 18.04 is verified. - Ensure that [Docker 18.03 or later versioin](https://docs.docker.com/get-docker/) is installed. ## Obtaining MindSpore Image @@ -67,7 +67,7 @@ docker run -it --network host swr.cn-south-1.myhuaweicloud.com/mindspore/mindspo - If you are installing the container of the specified version `x.y.z`. - After entering the MindSpore container according to the above steps, to test whether the Docker container is working properly, please run the following Python code and check the output: + After entering the MindSpore container according to the above steps, to test whether the Docker is working properly, please run the following Python code and check the output: i: @@ -82,7 +82,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 CPU has been installed by Docker successfully. ii: @@ -99,7 +99,7 @@ y = Tensor(np.ones([1,3,3,4]).astype(np.float32)) print(ops.add(x, y)) ``` -The outputs should be the same as: +When the code is successfully run, the outputs should be the same as: ```text [[[[2. 2. 2. 2.] @@ -115,11 +115,11 @@ 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 CPU has been installed by Docker successfully. - If you need to verify the MindInsight installation: - Enter ```mindinsight start --port 8080```, if it prompts that the startup status is successful, it means MindInsight has been installed successfully. + Enter ```mindinsight start --port 8080```, and if it prompts that the startup status is successful, it means MindInsight has been installed successfully. - If you install a container with the label of `runtime`, you need to install MindSpore yourself. @@ -127,6 +127,6 @@ It means MindSpore has been installed by docker successfully. - If you install a container with the label of `devel`, you need to compile and install MindSpore yourself. - Go to [MindSpore Installation Guide Page](https://www.mindspore.cn/install/en), choose the CPU hardware platform, Linux-x86_64 operating system and pip installation method to get the installation guide. After running the container, download the MindSpore code repository and refer to the installation guide, install the MindSpore CPU version through source code compilation, and verify it. + Go to [MindSpore Installation Guide Page](https://www.mindspore.cn/install/en), and choose the CPU hardware platform, Linux-x86_64 operating system and pip installation method to get the installation guide. After running the container, download the MindSpore code repository and refer to the installation guide, install the MindSpore CPU version through source code compilation, and verify it. If you want to know more about the MindSpore Docker image building process, please check [docker repo](https://gitee.com/mindspore/mindspore/blob/master/scripts/docker/README.md) for details. diff --git a/install/mindspore_cpu_install_nightly_en.md b/install/mindspore_cpu_install_nightly_en.md index eeb4d704e225276d4f056df97ad97c8c53e3fee8..51afb649c622b4c0bdc82c014584fc4ce56a6ef3 100644 --- a/install/mindspore_cpu_install_nightly_en.md +++ b/install/mindspore_cpu_install_nightly_en.md @@ -12,20 +12,22 @@ -MindSpore Nightly is a preview version which includes latest features and bugfixes, not fully supported and tested. Install MindSpore Nightly version if you wish to try out the latest changes on MindSpore. +MindSpore Nightly is a preview version which includes latest features and bugfixes, not fully supported and tested. Install MindSpore Nightly version if you wish to try out the latest features or bug fixes can use this version. This document describes how to quickly install MindSpore Nightly by pip in a Linux system with a CPU environment. +In the process of confirming the system environment information, if you need to know how to install third-party dependent software, you can refer to the practice provided by the community - [Source code compilation and installation on Ubuntu (CPU) MindSpore](https://www.mindspore.cn/news/newschildren?id=365) in the third-party dependent software installation related section, hereby thank the community members [damon0626]( https://gitee.com/damon0626) sharing. + ## System Environment Information Confirmation - Ensure that the 64-bit operating system is installed and the [glibc](https://www.gnu.org/software/libc/)>=2.17, where Ubuntu 18.04 are verified. - Ensure that [GCC 7.3.0](https://ftp.gnu.org/gnu/gcc/gcc-7.3.0/gcc-7.3.0.tar.gz) is installed. - Ensure that [gmp 6.1.2](https://gmplib.org/download/gmp/gmp-6.1.2.tar.xz) is installed. -- Ensure that Python 3.7.5 or 3.9.0 is installed. If not installed, download and install Python from: +- Ensure that Python 3.7.5 or 3.9.0 is installed. If not installed or been installed Python in other versions, download and install Python from: - Python 3.7.5 (64-bit): [Python official website](https://www.python.org/ftp/python/3.7.5/Python-3.7.5.tgz) or [HUAWEI CLOUD](https://mirrors.huaweicloud.com/python/3.7.5/Python-3.7.5.tgz). - Python 3.9.0 (64-bit): [Python official website](https://www.python.org/ftp/python/3.9.0/Python-3.9.0.tgz) or [HUAWEI CLOUD](https://mirrors.huaweicloud.com/python/3.9.0/Python-3.9.0.tgz). -- If you are using a ARM architecture system, please ensure that pip installed for current Python has a version >= 19.3. +- If you are using an ARM architecture system, please ensure that pip installed for current Python has a version >= 19.3. ## Downloading and Installing MindSpore @@ -37,7 +39,7 @@ pip install mindspore-dev -i https://pypi.tuna.tsinghua.edu.cn/simple Of which, -- When the network is connected, dependency items are automatically downloaded during .whl package installation. (For details about the dependency, see required_package in [setup.py](https://gitee.com/mindspore/mindspore/blob/master/setup.py) .) In other cases, you need to install it by yourself. When running models, you need to install additional dependencies based on requirements.txt specified for different models in [ModelZoo](https://gitee.com/mindspore/models/tree/master/). For details about common dependencies, see [requirements.txt](https://gitee.com/mindspore/mindspore/blob/master/requirements.txt). +- When the network is connected, dependencies are automatically downloaded during .whl package installation. (For details about the dependencies, see required_package in [setup.py](https://gitee.com/mindspore/mindspore/blob/master/setup.py) .) In other cases, you need to install it by yourself. When running models, you need to install additional dependencies based on requirements.txt specified for different models in [ModelZoo](https://gitee.com/mindspore/models/tree/master/). For details about common dependencies, see [requirements.txt](https://gitee.com/mindspore/mindspore/blob/master/requirements.txt). - pip will be installing the latest version of MindSpore Nightly automatically. If you wish to specify the version to be installed, please refer to the instruction below regarding to version update, and specify version manually. ## Installation Verification @@ -65,4 +67,4 @@ pip install --upgrade mindspore-dev=={version} Of which, -- When updating to a release candidate (rc) version, `{version}` should be specified, e.g. 1.6.0rc1.dev20211125; When updating to a standard release, `=={version}` could be removed. +- When updating to a release candidate (rc) version, `{version}` should be specified as the rc version number, e.g. 1.6.0rc1.dev20211125; When updating to the latest version automatically, `=={version}` could be removed. diff --git a/install/mindspore_cpu_install_pip_en.md b/install/mindspore_cpu_install_pip_en.md index faecca34209e7d70d3b260b5b2b3646791f8f3b5..94b47eb1ed2871df100da2194b7cb9a71e484044 100644 --- a/install/mindspore_cpu_install_pip_en.md +++ b/install/mindspore_cpu_install_pip_en.md @@ -16,21 +16,21 @@ This document describes how to quickly install MindSpore by pip in a Linux system with a CPU environment. The following takes Ubuntu 18.04 as an example to describe how to install MindSpore. -- If you want to install MindSpore by pip on a fresh Ubuntu 18.04, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-pip.sh) for one-click installation. The automatic installation script will install MindSpore and its dependencies. +- If you want to install MindSpore by pip on a fresh Ubuntu 18.04, you may use [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-pip.sh) for one-click installation. The automatic installation script will install MindSpore and its required dependencies. - The root permission is required because the script will modify the source list and install dependencies via APT. Run the following command to obtain and run the automatic installation script: + The root permission is required because the script will modify the software source configuration and install dependencies via APT. Run the following command to obtain and run the automatic installation script: ```bash wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-pip.sh # install Python 3.7 and MindSpore 1.6.0 by default bash ./ubuntu-cpu-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 ./ubuntu-cpu-pip.sh ``` This script performs the following operations: - - Change the source list to HUAWEI CLOUD source. + - Change the software source configuration to a HUAWEI CLOUD source - Install the dependencies required by MindSpore, such as GCC, gmp. - Install Python3 and pip3 via APT and set them as default. - Install MindSpore in CPU by pip. @@ -46,7 +46,7 @@ The following table lists the system environment and third-party dependencies re |software|version|description| |-|-|-| |Ubuntu|18.04|OS for running MindSpore| -|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment that MindSpore depends on| +|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment on which MindSpore depends| |[GCC](#installing-gcc-and-gmp)|7.3.0~9.4.0|C++ compiler for compiling MindSpore| |[gmp](#installing-gcc-and-gmp)|6.1.2|Multiple precision arithmetic library used by MindSpore| @@ -69,6 +69,8 @@ The following describes how to install the third-party dependencies. 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 @@ -131,7 +133,7 @@ sudo apt-get install gcc-9 -y ## Downloading and 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 @@ -169,7 +171,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=={version} @@ -177,4 +179,4 @@ pip install --upgrade mindspore=={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 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_cpu_install_source_en.md b/install/mindspore_cpu_install_source_en.md index 009613647d2a785d89d6fb6271df564f6fac6a0f..b182a3ab9723bc34e3f26ec7685461115e21f76a 100644 --- a/install/mindspore_cpu_install_source_en.md +++ b/install/mindspore_cpu_install_source_en.md @@ -19,25 +19,25 @@ -This document describes how to quickly install MindSpore by source code in a Linux system in the CPU environment. The following takes Ubuntu 18.04 as an example to describe how to install MindSpore. +This document describes how to quickly install MindSpore by source code compilation in a Linux system in the CPU environment. The following takes Ubuntu 18.04 as an example to describe how to compile and install MindSpore. ## Environment Preparation -- If you need to configure an environment for building MindSpore on the Ubuntu 18.04 that never installed MindSpore and its dependencies, you may use the [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-source.sh) for one-click configuration. The script installs the dependencies required for building MindSpore. +- If you need to configure an environment for building MindSpore on the Ubuntu 18.04 that never installed MindSpore and its dependencies, you may use the [automatic installation script](https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-source.sh) for one-click configuration. The automatic installation script will install MindSpore and its required dependencies. - The root permission is required because the script will modify the source list and install dependencies via APT. Run the following command to obtain and run the automatic installation script: + The root permission is required because the script will modify the software source configuration and install dependencies via APT. Run the following command to obtain and run the automatic installation script. ```bash wget https://gitee.com/mindspore/mindspore/raw/master/scripts/install/ubuntu-cpu-source.sh # install Python 3.7 by default bash ./ubuntu-cpu-source.sh - # to specify Python version + # to specify Python version, taking Python 3.9 as an example, use the following manner # PYTHON_VERSION=3.9 bash ./ubuntu-cpu-source.sh ``` This script performs the following operations: - - Change the source list to HUAWEI CLOUD source. + - Change the software source configuration to a HUAWEI CLOUD source. - Install the compilation dependencies required by MindSpore, such as GCC, CMake, etc. - Install Python3 and pip3 via APT and set them as default. @@ -45,19 +45,17 @@ This document describes how to quickly install MindSpore by source code in a Lin - 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. -The following table lists the system environment and third-party dependencies required for building and installing MindSpore. - |software|version|description| |-|-|-| |Ubuntu|18.04|OS for compiling and running MindSpore| -|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment that MindSpore depends on| +|[Python](#installing-python)|3.7.5 or 3.9.0|Python environment on which MindSpore depends| |[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-git-gmp-tclsh-patch-and-numa)|7.3.0~9.4.0|C++ compiler for compiling MindSpore| |[git](#installing-gcc-git-gmp-tclsh-patch-and-numa)|-|Source code management tools used by MindSpore| -|[CMake](#installing-cmake)|3.18.3 or later|Build tools for MindSpore| +|[CMake](#installing-cmake)|3.18.3 or later|Compilation tool that builds MindSpore| |[gmp](#installing-gcc-git-gmp-tclsh-patch-and-numa)|6.1.2|Multiple precision arithmetic library used by MindSpore| -|[tclsh](#installing-gcc-git-gmp-tclsh-patch-and-numa)|-|MindSpore SQLite build dependency| +|[tclsh](#installing-gcc-git-gmp-tclsh-patch-and-numa)|-|MindSpore SQLite compilation dependency| |[patch](#installing-gcc-git-gmp-tclsh-patch-and-numa)|2.5 or later|Source code patching tool used by MindSpore| |[NUMA](#installing-gcc-git-gmp-tclsh-patch-and-numa)|2.0.11 or later|Non-uniform memory access library used by MindSpore| |[LLVM](#installing-llvm-optional)|12.0.1|Compiler framework used by MindSpore (optional, mandatory for graph kernel fusion and sparse computing)| @@ -81,6 +79,8 @@ The following describes how to install the third-party dependencies. 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 @@ -179,7 +179,7 @@ git clone https://gitee.com/mindspore/mindspore.git ## Compiling MindSpore -Go to the root directory of mindspore, then run the build script. +Go to the root directory of mindspore, then run the compilation script. ```bash cd mindspore @@ -189,7 +189,7 @@ bash build.sh -e cpu -j4 -S on Where: - If the compiler performance is good, add `-j{Number of threads}` to increase the number of threads. For example, `bash build.sh -e cpu -j12`. -- 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. +- 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 @@ -219,7 +219,7 @@ It means MindSpore has been installed successfully. Using the following command if you need to update the MindSpore version: -- Update online +- Update online directly ```bash pip install --upgrade mindspore @@ -227,7 +227,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 compilation 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-*.whl diff --git a/install/mindspore_cpu_mac_install_conda_en.md b/install/mindspore_cpu_mac_install_conda_en.md index 83da6cd026cc7ecd0682efdf43f1eacb3df78101..65890b6a09eb221b9c4fb24f73e1d71f23a96483 100644 --- a/install/mindspore_cpu_mac_install_conda_en.md +++ b/install/mindspore_cpu_mac_install_conda_en.md @@ -19,7 +19,7 @@ This document describes how to quickly install MindSpore by Conda in a macOS sys ## System Environment Information Confirmation -- According to your Macbook configuration(click `About This Mac` to get chip/arch info), choose the right Python and Conda version based on following table: +- According to the system and chip situation in the table below, determine the appropriate Python and Conda versions, and for the macOS version and chip information, click on the Apple logo in the upper left corner of the desktop - > `About this mac`: |Chip|Architecture|macOS Version|Supported Python Version|Supported Conda Version| |-|-|-|-|-| @@ -28,8 +28,8 @@ This document describes how to quickly install MindSpore by Conda in a macOS sys - Ensure that the Conda version is compatible with the current system and chip. - - If you prefer the complete capabilities provided by Conda. You may download [Anaconda3](https://repo.anaconda.com/archive/) or [Mambaforge](https://github.com/conda-forge/miniforge). - - If you want to save disk space or prefer custom Conda installation. You may download [Miniconda3](https://repo.anaconda.com/miniconda/) or [Miniforge](https://github.com/conda-forge/miniforge). + - If you prefer the complete capabilities provided by Conda, you may download [Anaconda3](https://repo.anaconda.com/archive/) or [Mambaforge](https://github.com/conda-forge/miniforge). + - If you want to save disk space or prefer customizing Conda installation package, you may download [Miniconda3](https://repo.anaconda.com/miniconda/) or [Miniforge](https://github.com/conda-forge/miniforge). ## Creating and Accessing the Conda Virtual Environment @@ -86,7 +86,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-cpu -c mindspore -c conda-forge diff --git a/install/mindspore_cpu_mac_install_pip_en.md b/install/mindspore_cpu_mac_install_pip_en.md index 172c59743aca082354f442d7de1742e324c32132..9ed620ec7ae03531faf5fe8d5b297788f496faf2 100644 --- a/install/mindspore_cpu_mac_install_pip_en.md +++ b/install/mindspore_cpu_mac_install_pip_en.md @@ -16,7 +16,7 @@ This document describes how to quickly install MindSpore on macOS by pip. ## System Environment Information Confirmation -- According to your Macbook configuration(click "About This Mac" to get chip/arch info),choose the right Python version based on following table: +- According to the system and chip situation in the table below to determine the appropriate Python version, macOS version and chip information can be found by clicking on the Apple logo in the upper left corner of the desktop - > `About this mac`: |Chip|Architecture|macOS Version|Supported Python Version| |-|-|-|-| @@ -40,11 +40,11 @@ pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/{version}/MindSp Of which, - When the network is connected, dependency items are automatically downloaded during .whl package installation. (For details about the dependency, see required_package in [setup.py](https://gitee.com/mindspore/mindspore/blob/master/setup.py) .) In other cases, you need to install it by yourself. When running models, you need to install additional dependencies based on requirements.txt specified for different models in [ModelZoo](https://gitee.com/mindspore/models/tree/master/). For details about common dependencies, see [requirements.txt](https://gitee.com/mindspore/mindspore/blob/master/requirements.txt). -- `{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}` denotes the architecture. For example, the macOS you are using is x86 architecture 64-bit, `{arch}` should be `x86_64`. If you use M1 chip, then it should be `aarch64`. -- `{python_version}` spcecifies the python version for which MindSpore is built. If you wish to use Python3.7.5,`{python_version}` should be `cp37-cp37m`. If Python3.9.0 is used, it should be `cp39-cp39`. +- `{version}` specifies the MindSpore version number. For example, when installing MindSpore 1.5.0, set `{version}` to 1.5.0; and 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}` denotes the architecture. For example, the macOS you are using is x86 architecture 64-bit, and `{arch}` should be `x86_64`. If you use M1 chip, it should be `aarch64`. +- `{python_version}` spcecifies the Python version of the user. If you wish to use Python3.7.5,`{python_version}` should be `cp37-cp37m`. If Python3.9.0 is used, it should be `cp39-cp39`. - `{platform_version}` specifies the macOS version number. If you use M1 chip, set `{platform_version}` to `11_0`, otherwise set `{platform_version}` to `10_15`. -- `{platform_arch}` denotes the system architecture. For example, the macOS you are using is x86 architecture 64-bit, `{platform_arch}` should be `x86_64`. If you use M1 chip, then it should be `arm64`. +- `{platform_arch}` denotes the system architecture. For example, the macOS you are using is x86 architecture 64-bit, and `{platform_arch}` should be `x86_64`. If you use M1 chip, it should be `arm64`. ## Installation Verification @@ -63,7 +63,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=={version} @@ -71,4 +71,4 @@ pip install --upgrade mindspore=={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, e.g. 1.5.0rc1; When updating to a standard release, `=={version}` could be removed.