From 9974c60284b35a44b127dc31893d903e9a517691 Mon Sep 17 00:00:00 2001 From: Chi Song Date: Tue, 14 May 2019 09:50:19 +0800 Subject: [PATCH] add miniconda for windows recommendation and fixed some typo. (#1072) * fix some format * add Miniconda and fix typo * update indents --- README.md | 2 +- docs/en_US/Installation.md | 14 ++++++++++---- docs/en_US/WindowsLocalMode.md | 11 +++++------ 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e3c2670ea5..420563e26e 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ python -m pip install --upgrade nni Note: * `--user` can be added if you want to install NNI in your home directory, which does not require any special privileges. -* Currently NNI on Windows only support local mode. Anaconda is highly recommended to install NNI on Windows. +* Currently NNI on Windows only support local mode. Anaconda or Miniconda is highly recommended to install NNI on Windows. * If there is any error like `Segmentation fault`, please refer to [FAQ](docs/en_US/FAQ.md) **Install through source code** diff --git a/docs/en_US/Installation.md b/docs/en_US/Installation.md index 1d18a8b799..ec29c50ce5 100644 --- a/docs/en_US/Installation.md +++ b/docs/en_US/Installation.md @@ -25,22 +25,28 @@ Currently we support installation on Linux, Mac and Windows(local mode). You can also install NNI in a docker image. Please follow the instructions [here](https://github.com/Microsoft/nni/tree/master/deployment/docker/README.md) to build NNI docker image. The NNI docker image can also be retrieved from Docker Hub through the command `docker pull msranni/nni:latest`. ## **Installation on Windows** - When you use powershell to run script for the first time, you need **run powershell as administrator** with this command: + + When you use PowerShell to run script for the first time, you need **run PowerShell as administrator** with this command: + ```bash Set-ExecutionPolicy -ExecutionPolicy Unrestricted ``` - Anaconda is highly recommanded. + + Anaconda or Miniconda is highly recommended. * __Install NNI through pip__ Prerequisite: `python(64-bit) >= 3.5` + ```bash python -m pip install --upgrade nni ``` * __Install NNI through source code__ - Prerequisite: `python >=3.5`, `git`, `powershell` - you can install nni as administrator or current user as follows: + Prerequisite: `python >=3.5`, `git`, `PowerShell`. + + you can install NNI as administrator or current user as follows: + ```bash git clone -b v0.7 https://github.com/Microsoft/nni.git cd nni diff --git a/docs/en_US/WindowsLocalMode.md b/docs/en_US/WindowsLocalMode.md index e9c3b9e13e..d4a1e172e6 100644 --- a/docs/en_US/WindowsLocalMode.md +++ b/docs/en_US/WindowsLocalMode.md @@ -4,7 +4,7 @@ Currently we only support local mode on Windows. Windows 10.1809 is well tested ## **Installation on Windows** - **Anaconda python(64-bit) is highly recommended.** + **Anaconda or Miniconda python(64-bit) is highly recommended.** When you use PowerShell to run script for the first time, you need **run PowerShell as administrator** with this command: @@ -22,7 +22,7 @@ Set-ExecutionPolicy -ExecutionPolicy Unrestricted * __Install NNI through source code__ - Prerequisite: `python >=3.5`, `git`, `powershell` + Prerequisite: `python >=3.5`, `git`, `PowerShell` ```bash git clone -b v0.7 https://github.com/Microsoft/nni.git @@ -55,9 +55,9 @@ Set-ExecutionPolicy -ExecutionPolicy Unrestricted >...cannot be loaded because running scripts is disabled on this system. -### Trial failed with missing DLL in cmd or PowerShell +### Trial failed with missing DLL in command line or PowerShell -This error caused by missing LIBIFCOREMD.DLL and LIBMMD.DLL and fail to install SciPy. Using anaconda python(64-bit) can solve it. +This error caused by missing LIBIFCOREMD.DLL and LIBMMD.DLL and fail to install SciPy. Using Anaconda or Miniconda with Python(64-bit) can solve it. >ImportError: DLL load failed ### Trial failed on webUI @@ -77,8 +77,7 @@ If there is a stderr file, please check out. Two possible cases are as follows: Make sure C++ 14.0 compiler installed then try to run `nnictl package install --name=BOHB` to install the dependencies. ### Not supported tuner on Windows -SMAC is not supported currently, the specific reason can be referred to this [github issue](https://github.com/automl/SMAC3/issues/483). - +SMAC is not supported currently, the specific reason can be referred to this [GitHub issue](https://github.com/automl/SMAC3/issues/483). Note: