diff --git a/tutorials/source_en/advanced_use/mindspore_cpu_win_install_en.md b/tutorials/source_en/advanced_use/mindspore_cpu_win_install_en.md new file mode 100644 index 0000000000000000000000000000000000000000..6050e61fdc80b5dad18eb4d83955fb9c44055887 --- /dev/null +++ b/tutorials/source_en/advanced_use/mindspore_cpu_win_install_en.md @@ -0,0 +1,90 @@ +# MindSpore Installation Guide on Windows + +This document describes how to quickly install MindSpore on a Windows system with a CPU environment. + + + +- [MindSpore Installation Guide on Windows](#mindspore-installation-guide-on-windows) + - [Environment Requirements](#environment-requirements) + - [System Requirements and Software Dependencies](#system-requirements-and-software-dependencies) + - [(Optional) Installing Conda](#optional-installing-conda) + - [Installation Guide](#installation-guide) + - [Installing Using Executable Files](#installing-using-executable-files) + - [Installing Using the Source Code](#installing-using-the-source-code) + + + +## Environment Requirements + +### System Requirements and Software Dependencies + +| Version | Operating System | Executable File Installation Dependencies | Source Code Compilation and Installation Dependencies | +| ---- | :--- | :--- | :--- | +| MindSpore master | Windows 10 x64 | - [Python](https://www.python.org/downloads/) 3.7.5
- For details about other dependency items, see [requirements.txt](https://gitee.com/mindspore/mindspore/blob/master/requirements.txt). | **Compilation dependencies:**
- [Python](https://www.python.org/downloads/) 3.7.5
- [MinGW-W64](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/7.3.0/threads-posix/sjlj/x86_64-7.3.0-release-posix-sjlj-rt_v5-rev0.7z) GCC-7.3.0
- [ActivePerl](http://downloads.activestate.com/ActivePerl/releases/5.24.3.2404/ActivePerl-5.24.3.2404-MSWin32-x64-404865.exe) 5.24.3.2404
- [CMake](https://cmake.org/download/) 3.14.1
- [wheel](https://pypi.org/project/wheel/) >= 0.32.0
**Installation dependencies:**
same as the executable file installation 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. + +### (Optional) Installing Conda + +1. Download the Conda installation package from the following path: + + - [X86 Anaconda](https://www.anaconda.com/distribution/) or [X86 Miniconda](https://docs.conda.io/en/latest/miniconda.html) + +2. Open Anaconda Prompt from the Windows start menu after installation. +3. Create and activate the Python environment. + + ```bash + conda create -n {your_env_name} python=3.7.5 + conda activate {your_env_name} + ``` + +> Conda is a powerful Python environment management tool. It is recommended that a beginner read related information on the Internet first. + +## Installation Guide + +### Installing Using Executable Files + +1. Download the Windows .whl package of daily version from the [MindSpore repository](https://repo.mindspore.cn/mindspore/). Run the following command to install MindSpore: + + ```bash + pip install mindspore-{version}-cp37-cp37m-win_{arch}.whl + ``` + +2. Run the following command. If no loading error message such as `No module named 'mindspore'` is displayed, the installation is successful. + + ```bash + python + import mindspore + ``` + > - Before running the preceding command, ensure that [Visual C ++ Redistributable for Visual Studio 2015](https://www.microsoft.com/zh-CN/download/details.aspx?id=48145) is installed. + +### Installing Using the Source Code + +1. Download the source code from the code repository. + + ```bash + git clone https://gitee.com/mindspore/mindspore.git + ``` + +2. Run the following command in the root directory of the source code to compile MindSpore: + + ```bash + call build.bat + ``` + > - Before running the preceding command, ensure that the paths of mingw64\bin\ and the executable files cmake 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. + > - If the compiler performance is strong, you can add -j{Number of threads} in to script to increase the number of threads(Default -j6). For example, `call build.bat -j12`. + +3. Run the following command to install MindSpore: + + ```bash + pip install build/package/mindspore-{version}-cp37-cp37m-win_{arch}.whl + ``` + +4. Run the following command. If no loading error message such as `No module named 'mindspore'` is displayed, the installation is successful. + + ```bash + python + import mindspore + ``` + > - Before running the preceding command, ensure that [Visual C ++ Redistributable for Visual Studio 2015](https://www.microsoft.com/zh-CN/download/details.aspx?id=48145) is installed. diff --git a/tutorials/source_en/index.rst b/tutorials/source_en/index.rst index 59856551c64513dd91f8350b6cf3a5c86f29ca89..b3ff82611756d1bd63325d313e4b80167c8678e7 100644 --- a/tutorials/source_en/index.rst +++ b/tutorials/source_en/index.rst @@ -35,6 +35,7 @@ MindSpore Tutorials advanced_use/customized_debugging_information advanced_use/on_device_inference advanced_use/model_security + advanced_use/mindspore_cpu_win_install_en advanced_use/community .. toctree:: diff --git a/tutorials/source_zh_cn/advanced_use/mindspore_cpu_win_install.md b/tutorials/source_zh_cn/advanced_use/mindspore_cpu_win_install.md new file mode 100644 index 0000000000000000000000000000000000000000..cb19b155b67f36d9474ed60f3770c1627706d311 --- /dev/null +++ b/tutorials/source_zh_cn/advanced_use/mindspore_cpu_win_install.md @@ -0,0 +1,90 @@ +# Windows系统安装MindSpore + +本文档介绍如何在CPU环境的Windows系统上快速安装MindSpore。 + + + +- [Windows系统安装MindSpore](#windows系统安装mindspore) + - [环境要求](#环境要求) + - [系统要求和软件依赖](#系统要求和软件依赖) + - [Conda安装(可选)](#conda安装可选) + - [安装指南](#安装指南) + - [通过可执行文件安装](#通过可执行文件安装) + - [从源码编译安装](#从源码编译安装) + + + +## 环境要求 + +### 系统要求和软件依赖 + +| 版本号 | 操作系统 | 可执行文件安装依赖 | 源码编译安装依赖 | +| ---- | :--- | :--- | :--- | +| MindSpore master | Windows 10 x64 | - [Python](https://www.python.org/downloads/) 3.7.5
- 其他依赖项参见[requirements.txt](https://gitee.com/mindspore/mindspore/blob/master/requirements.txt) | **编译依赖:**
- [Python](https://www.python.org/downloads/) 3.7.5
- [MinGW-W64](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/7.3.0/threads-posix/sjlj/x86_64-7.3.0-release-posix-sjlj-rt_v5-rev0.7z) GCC-7.3.0
- [ActivePerl](http://downloads.activestate.com/ActivePerl/releases/5.24.3.2404/ActivePerl-5.24.3.2404-MSWin32-x64-404865.exe) 5.24.3.2404
- [CMake](https://cmake.org/download/) 3.14.1
- [wheel](https://pypi.org/project/wheel/) >= 0.32.0
**安装依赖:**
与可执行文件安装依赖相同 | + +- 在联网状态下,安装whl包时会自动下载requirements.txt中的依赖项,其余情况需自行安装。 + +### Conda安装(可选) + +1. Conda安装包下载路径如下。 + + - [X86 Anaconda](https://www.anaconda.com/distribution/) 或 [X86 Miniconda](https://docs.conda.io/en/latest/miniconda.html) + +2. 安装后从Windows开始菜单打开Anaconda Prompt。 +3. 创建并激活Python环境。 + + ```bash + conda create -n {your_env_name} python=3.7.5 + conda activate {your_env_name} + ``` + +> Conda是强大的Python环境管理工具,建议初学者上网查阅更多资料。 + +## 安装指南 + +### 通过可执行文件安装 + +1. 从[MindSpore版本库](https://repo.mindspore.cn/mindspore/)获取daily版本对应的Windows安装包,执行如下命令安装MindSpore。 + + ```bash + pip install mindspore-{version}-cp37-cp37m-win_{arch}.whl + ``` + +2. 执行如下命令,如果没有提示`No module named 'mindspore'`等加载错误的信息,则说明安装成功。 + + ```bash + python + import mindspore + ``` + > - 在执行上述命令前,需保证已安装[Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/zh-CN/download/details.aspx?id=48145)。 + +### 从源码编译安装 + +1. 从代码仓下载源码。 + + ```bash + git clone https://gitee.com/mindspore/mindspore.git + ``` + +2. 在源码根目录下执行如下命令编译MindSpore。 + + ```bash + call build.bat + ``` + > - 在执行上述命令前,需保证mingw64\bin\路径和可执行文件cmake所在路径已加入环境变量PATH中。 + > - build.sh中会执行git clone获取第三方依赖库的代码,请提前确保git的网络设置正确可用。 + > - 如果编译机性能较好,可在执行中增加-j{线程数}来增加线程数量(默认-j6)。如`call build.bat -j12`。 + +3. 执行如下命令安装MindSpore。 + + ```bash + pip install build/package/mindspore-{version}-cp37-cp37m-win_{arch}.whl + ``` + +4. 执行如下命令,如果没有提示`No module named 'mindspore'`等加载错误的信息,则说明安装成功。 + + ```bash + python + import mindspore + ``` + > - 在执行上述命令前,需保证已安装[Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/zh-CN/download/details.aspx?id=48145)。 diff --git a/tutorials/source_zh_cn/index.rst b/tutorials/source_zh_cn/index.rst index 1c0c20573ae8306e226061ac2257fcf158206358..0628a239469646d5660cb2abaf0b514367abaa36 100644 --- a/tutorials/source_zh_cn/index.rst +++ b/tutorials/source_zh_cn/index.rst @@ -36,6 +36,7 @@ MindSpore教程 advanced_use/use_on_the_cloud advanced_use/on_device_inference advanced_use/model_security + advanced_use/mindspore_cpu_win_install advanced_use/community .. toctree::