Refactoring Markdown Files (#639)

* [WIP] rearrange readme and example list

* Readme Updated

* Error Fix

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update CONTRIBUTING.md

* Update README.md

* Update CONTRIBUTING.md

* Update README.md

* Update CHANGELOG.md

* Changelog updated

* Update README.md

* Fixing Docker run commands

* Deprecated Python 3.4

* New Alias for Docker Added

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update README.md

* Update README.rst

* Update README.rst

* Update README.rst

Author: zsdonghao

.circleci/config.yml

@@ -71,7 +71,7 @@ jobs:
             docker build -t latest_py3_gpu python3/gpu
 
   ###################################################################################
-  #           MASTER BRANCH BUILDS with TensorLayer installed from Source           #
+  #       NIGHTLY BUILDS from TensorLayer Master Branch installed from Source       #
   ###################################################################################
 
   nightly_sources_py2_cpu:
@@ -114,6 +114,10 @@ jobs:
             docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py2-cpu
+            docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
   nightly_sources_py2_gpu:
     working_directory: ~/build
     docker:
@@ -146,6 +150,10 @@ jobs:
             docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py2-gpu
+            docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
   nightly_sources_py3_cpu:
     working_directory: ~/build
     docker:
@@ -178,6 +186,10 @@ jobs:
             docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py3-cpu
+            docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
   nightly_sources_py3_gpu:
     working_directory: ~/build
     docker:
@@ -205,6 +217,10 @@ jobs:
             CONTAINER_TAG="$VERSION_PREFIX"-gpu-py3
             docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            
+            CONTAINER_TAG="$VERSION_PREFIX"-py3-gpu
+            docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
   ###################################################################################
   #                 TAGS BUILDS with TensorLayer installed from PyPI                #
@@ -258,6 +274,10 @@ jobs:
             docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py2-cpu
+            docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
             # ============== Tag Python2 CPU Containers ==============
 
             CONTAINER_TAG="$TL_VERSION"
@@ -276,6 +296,10 @@ jobs:
             docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$TL_VERSION"-py2-cpu
+            docker tag latest_py2_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
   build_pypi_py2_gpu:
     working_directory: ~/build
     docker:
@@ -316,6 +340,10 @@ jobs:
             docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py2-gpu
+            docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
             # ============== Tag Python2 GPU Containers ==============
 
             CONTAINER_TAG="$TL_VERSION"-gpu
@@ -326,6 +354,10 @@ jobs:
             docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$TL_VERSION"-py2-gpu
+            docker tag latest_py2_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
   build_pypi_py3_cpu:
     working_directory: ~/build
     docker:
@@ -366,6 +398,10 @@ jobs:
             docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py3-cpu
+            docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
             # ============== Tag Python3 CPU Containers ==============
 
             CONTAINER_TAG="$TL_VERSION"-py3
@@ -375,6 +411,10 @@ jobs:
             CONTAINER_TAG="$TL_VERSION"-cpu-py3
             docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            
+            CONTAINER_TAG="$TL_VERSION"-py3-cpu
+            docker tag latest_py3_cpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
   build_pypi_py3_gpu:
     working_directory: ~/build
@@ -412,11 +452,19 @@ jobs:
             docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
+            CONTAINER_TAG="$VERSION_PREFIX"-py3-gpu
+            docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+
             # ============== Tag Python3 GPU Containers ==============
 
             CONTAINER_TAG="$TL_VERSION"-gpu-py3
             docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
             docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            
+            CONTAINER_TAG="$TL_VERSION"-py3-gpu
+            docker tag latest_py3_gpu:latest tensorlayer/tensorlayer:"$CONTAINER_TAG"
+            docker push tensorlayer/tensorlayer:"$CONTAINER_TAG"
 
 ###################################################################################
 ###################################################################################

CHANGELOG.md

@@ -107,7 +107,8 @@ To release a new version, please update the changelog as followed:
 - `tl.files` refactored into a directory with numerous files (by @DEKHTIARJonathan in #657)
 - `tl.files.voc_dataset` fixed because of original Pascal VOC website was down (by @DEKHTIARJonathan in #657)
 - extra requirements hidden inside the library added in the project requirements (by @DEKHTIARJonathan in #657)
-- requirements files refactored in `requirements/` directory (by @DEKHTIARJonathan in #657)
+- requirements files refactored in `requirements/` directory (by @DEKHTIARJonathan in #657) 
+- README.md and other markdown files have been refactored and cleaned. (by @zsdonghao @DEKHTIARJonathan @luomai in #639)
 - Ternary Convolution Layer added in unittest (by @DEKHTIARJonathan in #658)
 - Convolution Layers unittests have been cleaned & refactored (by @DEKHTIARJonathan in #658)
 

CONTRIBUTING.md

@@ -1,4 +1,6 @@
-# Contributing to TensorLayer
+# TensorLayer Contributor Guideline
+
+## Continuous integration
 
 We appreciate contributions
 either by adding / improving examples or extending / fixing the core library. 
@@ -17,3 +19,37 @@ make format
 ```
 
 to apply those tools before submitting your PR.
+
+## Build from sources
+
+```bash
+# First clone the repository
+git clone https://github.com/tensorlayer/tensorlayer.git
+cd tensorlayer
+
+# Install virtualenv if necessary
+pip install virtualenv
+
+# Then create a virtualenv called venv inside
+virtualenv venv
+
+# Activate the virtualenv  
+
+# Linux:
+source venv/bin/activate
+
+# Windows:
+venv\Scripts\activate.bat
+
+# for a machine **without** an NVIDIA GPU
+pip install -e .[tf_cpu,db,dev,doc,extra,test]
+
+# for a machine **with** an NVIDIA GPU
+pip install -e .[tf_gpu,db,dev,doc,extra,test]
+```
+
+Launching the unittest:
+
+```bash
+$ pytest
+```