Merge pull request #9 from Microsoft/master

merge master

.travis.yml

@@ -4,9 +4,9 @@ language: python
 python:
   - "3.6"
 before_install:
-  - wget https://nodejs.org/dist/v10.9.0/node-v10.9.0-linux-x64.tar.xz
-  - tar xf node-v10.9.0-linux-x64.tar.xz
-  - sudo mv node-v10.9.0-linux-x64 /usr/local/node
+  - wget https://nodejs.org/dist/v10.10.0/node-v10.10.0-linux-x64.tar.xz
+  - tar xf node-v10.10.0-linux-x64.tar.xz
+  - sudo mv node-v10.10.0-linux-x64 /usr/local/node
   - export PATH=/usr/local/node/bin:$PATH
   - sudo sh -c 'PATH=/usr/local/node/bin:$PATH yarn global add serve'
 install:

Makefile

@@ -20,7 +20,7 @@ else  # is normal user
 endif
 
 ## Dependency information
-NODE_VERSION ?= v10.9.0
+NODE_VERSION ?= v10.10.0
 NODE_TARBALL ?= node-$(NODE_VERSION)-linux-x64.tar.xz
 NODE_PATH ?= $(INSTALL_PREFIX)/nni/node
 
@@ -294,7 +294,7 @@ ifdef _ROOT
 	$(error You should not develop NNI as root)
 endif
 ifdef _MISS_DEPS
-	$(error Please install Node.js, Yarn, and Serve to develop NNI)
+#	$(error Please install Node.js, Yarn, and Serve to develop NNI)
 endif
 	#$(_INFO) Pass! $(_END)
 

deployment/Dockerfile.build.base

@@ -40,7 +40,7 @@ RUN pip3 --no-cache-dir install \
     numpy==1.14.3 scipy==1.1.0 
 
 #
-#Install node 10.9.0, yarn 1.9.4, NNI v0.1
+#Install node 10.10.0, yarn 1.9.4, NNI v0.1
 #
 RUN git clone -b v0.1 https://github.com/Microsoft/nni.git
 RUN cd nni && sh install.sh

docs/HowToContribute.md

@@ -0,0 +1,53 @@
+**How to contribute**
+===
+## Best practice for debug NNI source code
+
+For debugging NNI source code, your development environment should be under Ubuntu 16.04 (or above) system with python 3 and pip 3 installed, then follow the below steps.
+
+**1. Clone the source code**
+
+Run the command
+```
+git clone https://github.com/Microsoft/nni.git
+```
+to clone the source code
+
+**2. Prepare the debug environment and install dependencies**
+
+Change directory to the source code folder, then run the command
+```
+make install-dependencies
+```
+to install the dependent tools for the environment
+
+**3. Build source code**
+
+Run the command
+```
+make build
+```
+to build the source code
+
+**4. Install NNI to development environment**
+
+Run the command
+```
+make dev-install
+```
+to install the distribution content to development environment, and create cli scripts
+
+**5. Check if the environment is ready**
+
+Now, you can try to start an experiment to check if your environment is ready
+For example, run the command
+```
+nnictl create --config ~/nni/examples/trials/mnist/config.yml
+```
+And open web ui to check if everything is OK
+
+**6. Redeploy**
+
+After you change some code, just use **step 4** to rebuild your code, then the change will take effect immediately
+
+---
+At last, wish you have a wonderful day.