Issue #689 fix - documentation refactoring (#691)

* Documentation Refactoring * tl.visualize warning fixed * moving mean initializer moved in the arguments * Refactored Changelog * Docs Restructured with Subsection Title * https://github.com/zsdonghao/tensorlayer/ replaced by https://github.com/tensorlayer/tensorlayer/ * Get Involved and Contribution Refactored * Redirections Fixed * get_involved added * Hao added * TL Layer Doc refactoring * Update contributing.rst * Core Team Updated * super resolution layers moved to convolution folder * YAPF Correction * Layer Documentation Refactored * Core Team Updated * Adding Travis TF 1.9.0rc0 * Fangde Added to core team * Contributors page updated * Decorator Deprecated added * Changelog Updated * Update requirements.txt * Python 2 Bug Fix * Missing Import fixed * YAPF Error Fix * 1.8.6rc6 released * Update README.rst * Setup Warning Fixed
tensorlayer · Jun 15, 2018 · 5e61f27 · 5e61f27
1 parent 0ad2382
commit 5e61f27
Show file tree

Hide file tree

Showing 46 changed files with 1,089 additions and 870 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,6 +20,7 @@ env:
   # Backward Compatibility in insured for release less than 1 year old.
   # https://pypi.org/project/tensorflow/#history
   matrix:
+    - _TF_VERSION=1.9.0rc0 # Remove on Apr 28, 2019
     - _TF_VERSION=1.8.0 # Remove on Apr 28, 2019
     - _TF_VERSION=1.7.1 # Remove on May 08, 2019
     - _TF_VERSION=1.7.0 # Remove on Mar 29, 2019

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -82,6 +82,7 @@ To release a new version, please update the changelog as followed:
 - Decorator:
   - `tl.decorators` API created including `deprecated_alias` and `private_method` (PR #660)
   - `tl.decorators` API enriched with `protected_method` (PR #675)
+  - `tl.decorators` API enriched with `deprecated` directly raising warning and modifying documentation (PR #691)
 - Docker:
   - Containers for each release and for each PR merged on master built (PR #648)
   - Containers built in the following configurations (PR #648):
@@ -90,7 +91,7 @@ To release a new version, please update the changelog as followed:
     - py3 + cpu
     - py3 + gpu
 - Documentation:
-  - Clean README (PR #677)
+  - Clean README.md (PR #677)
   - Release semantic version added on index page (PR #633)
   - Optimizers page added (PR #636)
   - `AMSGrad` added on Optimizers page added (PR #636)
@@ -123,7 +124,7 @@ To release a new version, please update the changelog as followed:
 - The document of LambdaLayer for linking it with ElementwiseLambdaLayer (PR #587)
 - RTD links point to stable documentation instead of latest used for development (PR #633)
 - TF Version older than 1.6.0 are officially unsupported and raises an exception (PR #644)
-- Readme Badges Updated with Support Python and Tensorflow Versions (PR #644)
+- README.md Badges Updated with Support Python and Tensorflow Versions (PR #644)
 - TL logging API has been consistent with TF logging API and thread-safe (PR #645)
 - Relative Imports changed for absolute imports (PR #657)
 - `tl.files` refactored into a directory with numerous files (PR #657)
@@ -140,6 +141,7 @@ To release a new version, please update the changelog as followed:
 - Input Layers have been removed from `tl.layers.core` and added to `tl.layers.inputs` (PR #675)
 - Input Layers are now considered as true layers in the graph (they represent a placeholder), unittests have been updated (PR #675)
 - Layer API is simplified, with automatic feeding `prev_layer` into `self.inputs` (PR #675)
+- Complete Documentation Refactoring and Reorganization (namely Layer APIs) (PR #691)
 
 ### Deprecated
 - `tl.layers.TimeDistributedLayer` argurment `args` is deprecated in favor of `layer_args` (PR #667)
@@ -177,7 +179,7 @@ To release a new version, please update the changelog as followed:
 
 ### Contributors
 - @lgarithm: #563
-- @DEKHTIARJonathan: #573 #574 #575 #580 #633 #635 #636 #639 #644 #645 #648 #657 #667 #658 #659 #660 #661 #666 #667 #672 #675 #683 #686 #687 #690 #692
+- @DEKHTIARJonathan: #573 #574 #575 #580 #633 #635 #636 #639 #644 #645 #648 #657 #667 #658 #659 #660 #661 #666 #667 #672 #675 #683 #686 #687 #690 #691 #692
 - @2wins: #560 #566 #662
 - @One-sixth: #579
 - @zsdonghao: #587 #588 #639 #685 #697
@@ -208,7 +210,7 @@ To release a new version, please update the changelog as followed:
     - py3 + cpu
     - py3 + gpu
 - Documentation:
-  - Clean README (PR #677)
+  - Clean README.md (PR #677)
   - Release semantic version added on index page (PR #633)
   - Optimizers page added (PR #636)
   - `AMSGrad` added on Optimizers page added (PR #636)
@@ -236,7 +238,7 @@ To release a new version, please update the changelog as followed:
 - The document of LambdaLayer for linking it with ElementwiseLambdaLayer (PR #587)
 - RTD links point to stable documentation instead of latest used for development (PR #633)
 - TF Version older than 1.6.0 are officially unsupported and raises an exception (PR #644)
-- Readme Badges Updated with Support Python and Tensorflow Versions (PR #644)
+- README.md Badges Updated with Support Python and Tensorflow Versions (PR #644)
 - TL logging API has been consistent with TF logging API and thread-safe (PR #645)
 - Relative Imports changed for absolute imports (PR #657)
 - `tl.files` refactored into a directory with numerous files (PR #657)
@@ -337,5 +339,5 @@ To release a new version, please update the changelog as followed:
 @zsdonghao @luomai @DEKHTIARJonathan
 
 [Unreleased]: https://github.com/tensorlayer/tensorlayer/compare/1.8.5...master
-[1.8.6]: https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc5...1.8.5
+[1.8.6]: https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc6...1.8.5
 [1.8.5]: https://github.com/tensorlayer/tensorlayer/compare/1.8.4...1.8.5
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 
 ![PyPI Stable Version](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer.svg?label=PyPI%20-%20Release)
 ![PyPI RC Version](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer/all.svg?label=PyPI%20-%20Pre-Release)
-[![Github commits (since latest release)](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/commits-since/tensorlayer/tensorlayer/latest.svg)](https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc5...master)
+[![Github commits (since latest release)](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/commits-since/tensorlayer/tensorlayer/latest.svg)](https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc6...master)
 [![PyPI - Python Version](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/pypi/pyversions/tensorlayer.svg)](https://pypi.org/project/tensorlayer/)
 [![Supported TF Version](http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/badge/tensorflow-1.6.0+-blue.svg)](https://github.com/tensorflow/tensorflow/releases)
 

diff --git a/README.rst b/README.rst
@@ -1,95 +1,14 @@
-.. raw:: html
+|TENSORLAYER-LOGO|
 
-   <a href="https://tensorlayer.readthedocs.io/">
-       <div align="center">
-           <img src="img/tl_transparent_logo.png" width="50%" height="30%"/>
-       </div>
-   </a>
 
+|Awesome| |Documentation-EN| |Documentation-CN| |Book-CN| |Downloads|
 
-.. image:: https://awesome.re/mentioned-badge.svg
-    :target: https://github.com/tensorlayer/awesome-tensorlayer
+|PyPI| |PyPI-Prerelease| |Commits-Since| |Python| |TensorFlow|
 
-.. image:: https://img.shields.io/badge/documentation-english-blue.svg
-    :target: https://tensorlayer.readthedocs.io/
+|Travis| |Docker| |RTD-EN| |RTD-CN| |PyUP| |Docker-Pulls| |Code-Quality|
 
-.. image:: https://img.shields.io/badge/documentation-中文-blue.svg
-    :target: https://tensorlayercn.readthedocs.io/
 
-.. image:: https://img.shields.io/badge/book-中文-blue.svg
-    :target: http://www.broadview.com.cn/book/5059/
-
-.. image:: http://pepy.tech/badge/tensorlayer
-    :target: http://pepy.tech/project/tensorlayer
-
-
-.. raw:: html
-
-   <br/>
-
-.. raw:: html
-
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer.svg?label=PyPI%20-%20Release
-    :target: https://pypi.org/project/tensorlayer/
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer/all.svg?label=PyPI%20-%20Pre-Release
-    :target: https://pypi.org/project/tensorlayer/
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/commits-since/tensorlayer/tensorlayer/latest.svg
-    :target: https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc5...master
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/pypi/pyversions/tensorlayer.svg
-    :target: https://pypi.org/project/tensorlayer/
-
-.. image:: https://img.shields.io/badge/tensorflow-1.6.0+-blue.svg
-    :target: https://github.com/tensorflow/tensorflow/releases
-
-
-.. raw:: html
-
-   <br/>
-
-.. raw:: html
-
-
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/travis/tensorlayer/tensorlayer/master.svg?label=Travis
-    :target: https://travis-ci.org/tensorlayer/tensorlayer
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/circleci/project/github/tensorlayer/tensorlayer/master.svg?label=Docker%20Build
-    :target: https://circleci.com/gh/tensorlayer/tensorlayer/tree/master
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/readthedocs/tensorlayer/latest.svg?label=ReadTheDocs-EN
-    :target: https://tensorlayer.readthedocs.io/
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/readthedocs/tensorlayercn/latest.svg?label=ReadTheDocs-CN
-    :target: https://tensorlayercn.readthedocs.io/
-
-.. image:: https://pyup.io/repos/github/tensorlayer/tensorlayer/shield.svg
-    :target: https://pyup.io/repos/github/tensorlayer/tensorlayer/
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/docker/pulls/tensorlayer/tensorlayer.svg
-    :target: https://hub.docker.com/r/tensorlayer/tensorlayer/
-
-.. image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/codacy/grade/ca2a29ddcf7445588beff50bee5406d9.svg
-    :target: https://app.codacy.com/app/tensorlayer/tensorlayer
-
-
-
-.. raw:: html
-
-   <br/><br/>
-
-   <a href="https://join.slack.com/t/tensorlayer/shared_invite/enQtMjUyMjczMzU2Njg4LWI0MWU0MDFkOWY2YjQ4YjVhMzI5M2VlZmE4YTNhNGY1NjZhMzUwMmQ2MTc0YWRjMjQzMjdjMTg2MWQ2ZWJhYzc" target="\_blank">
-       <div align="center">
-           <img src="img/join_slack.png" width="40%"/>
-       </div>
-   </a>
-
-   <br/>
-
-.. raw:: html
+|JOIN-SLACK-LOGO|
 
 TensorLayer is a novel TensorFlow-based deep learning and reinforcement
 learning library designed for researchers and engineers. It provides a
@@ -232,3 +151,47 @@ License
 =======
 
 TensorLayer is released under the Apache 2.0 license.
+
+
+.. |TENSORLAYER-LOGO| image:: https://raw.githubusercontent.com/tensorlayer/tensorlayer/master/img/tl_transparent_logo.png
+   :target: https://tensorlayer.readthedocs.io/
+.. |JOIN-SLACK-LOGO| image:: https://raw.githubusercontent.com/tensorlayer/tensorlayer/master/img/join_slack.png
+   :target: https://join.slack.com/t/tensorlayer/shared_invite/enQtMjUyMjczMzU2Njg4LWI0MWU0MDFkOWY2YjQ4YjVhMzI5M2VlZmE4YTNhNGY1NjZhMzUwMmQ2MTc0YWRjMjQzMjdjMTg2MWQ2ZWJhYzc
+
+.. |Awesome| image:: https://awesome.re/mentioned-badge.svg
+   :target: https://github.com/tensorlayer/awesome-tensorlayer
+.. |Documentation-EN| image:: https://img.shields.io/badge/documentation-english-blue.svg
+   :target: https://tensorlayer.readthedocs.io/
+.. |Documentation-CN| image:: https://img.shields.io/badge/documentation-中文-blue.svg
+   :target: https://tensorlayercn.readthedocs.io/
+.. |Book-CN| image:: https://img.shields.io/badge/book-中文-blue.svg
+   :target: http://www.broadview.com.cn/book/5059/
+.. |Downloads| image:: http://pepy.tech/badge/tensorlayer
+   :target: http://pepy.tech/project/tensorlayer
+
+
+.. |PyPI| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer.svg?label=PyPI%20-%20Release
+   :target: https://pypi.org/project/tensorlayer/
+.. |PyPI-Prerelease| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/release/tensorlayer/tensorlayer/all.svg?label=PyPI%20-%20Pre-Release
+   :target: https://pypi.org/project/tensorlayer/
+.. |Commits-Since| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/github/commits-since/tensorlayer/tensorlayer/latest.svg
+   :target: https://github.com/tensorlayer/tensorlayer/compare/1.8.6rc5...master
+.. |Python| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/pypi/pyversions/tensorlayer.svg
+   :target: https://pypi.org/project/tensorlayer/
+.. |TensorFlow| image:: https://img.shields.io/badge/tensorflow-1.6.0+-blue.svg
+   :target: https://github.com/tensorflow/tensorflow/releases
+
+.. |Travis| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/travis/tensorlayer/tensorlayer/master.svg?label=Travis
+   :target: https://travis-ci.org/tensorlayer/tensorlayer
+.. |Docker| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/circleci/project/github/tensorlayer/tensorlayer/master.svg?label=Docker%20Build
+   :target: https://circleci.com/gh/tensorlayer/tensorlayer/tree/master
+.. |RTD-EN| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/readthedocs/tensorlayer/latest.svg?label=ReadTheDocs-EN
+   :target: https://tensorlayer.readthedocs.io/
+.. |RTD-CN| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/readthedocs/tensorlayercn/latest.svg?label=ReadTheDocs-CN
+   :target: https://tensorlayercn.readthedocs.io/
+.. |PyUP| image:: https://pyup.io/repos/github/tensorlayer/tensorlayer/shield.svg
+   :target: https://pyup.io/repos/github/tensorlayer/tensorlayer/
+.. |Docker-Pulls| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/docker/pulls/tensorlayer/tensorlayer.svg
+   :target: https://hub.docker.com/r/tensorlayer/tensorlayer/
+.. |Code-Quality| image:: http://ec2-35-178-47-120.eu-west-2.compute.amazonaws.com/codacy/grade/ca2a29ddcf7445588beff50bee5406d9.svg
+   :target: https://app.codacy.com/app/tensorlayer/tensorlayer
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ Welcome to TensorLayer
 **Good News:** We won the **Best Open Source Software Award** `@ACM Multimedia (MM) 2017 <http://www.acmmm.org/2017/mm-2017-awardees/>`_.
 
 `TensorLayer`_ is a Deep Learning (DL) and Reinforcement Learning (RL) library extended from `Google TensorFlow <https://www.tensorflow.org>`_.  It provides popular DL and RL modules that can be easily customized and assembled for tackling real-world machine learning problems.
-More details can be found `here <https://github.com/zsdonghao/tensorlayer>`_.
+More details can be found `here <https://github.com/tensorlayer/tensorlayer>`_.
 
 .. note::
    If you got problem to read the docs online, you could download the repository
@@ -28,12 +28,14 @@ to the library as a developer.
 
 .. toctree::
   :maxdepth: 2
+  :caption: Starting with TensorLayer
 
   user/installation
   user/tutorial
   user/example
-  user/development
-  user/more
+  user/contributing
+  user/get_involved
+  user/faq
 
 API Reference
 -------------
@@ -43,21 +45,27 @@ method, this part of the documentation is for you.
 
 .. toctree::
   :maxdepth: 2
+  :caption: Stable Functionalities
 
   modules/activation
   modules/array_ops
   modules/cost
   modules/distributed
   modules/files
   modules/iterate
+  modules/layers
   modules/models
   modules/nlp
-  modules/layers
   modules/optimizers
   modules/prepro
   modules/rein
   modules/utils
   modules/visualize
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Unstable Functionalities
+
   modules/db
 
 
@@ -68,6 +76,7 @@ TensorLayer provides a handy command-line tool `tl` to perform some common tasks
 
 .. toctree::
   :maxdepth: 2
+  :caption: Command Line Interface 
 
   modules/cli
 
@@ -80,5 +89,5 @@ Indices and tables
 * :ref:`search`
 
 
-.. _GitHub: https://github.com/zsdonghao/tensorlayer
-.. _TensorLayer: https://github.com/zsdonghao/tensorlayer/
+.. _GitHub: https://github.com/tensorlayer/tensorlayer
+.. _TensorLayer: https://github.com/tensorlayer/tensorlayer/
diff --git a/docs/modules/distributed.rst b/docs/modules/distributed.rst
@@ -4,7 +4,7 @@ API - Distributed Training
 (Alpha release - usage might change later)
 
 Helper sessions and methods to run a distributed training.
-Check this `minst example <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_mnist_distributed.py>`_.
+Check this `minst example <https://github.com/tensorlayer/tensorlayer/blob/master/example/tutorial_mnist_distributed.py>`_.
 
 .. automodule:: tensorlayer.distributed