Layer API Refactoring (#675)

* Layer API Refactoring

* private method decorator added

* Input Layers added

* Lazy Import on ROI pooling

* @zsdonghao change proposal added

* UTF-8 header added

* gitignore updated

* Python2 error correction

* Changelog Updated

* Python Headers Uniformized + Codacy Error Fix + LSTMStateTuple missing import

Author: Jonathan DEKHTIAR

.gitignore

@@ -1,21 +1,126 @@
-*.gz
-*.npz
-*.pyc
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
 *~
 
-.DS_Store
-.idea
-.spyproject/
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
 .pytest_cache/
 
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
 venv/
-build/
+ENV/
+env.bak/
+venv.bak/
+venv_/
+venv2/
+venv3/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+
+# IDE Specific directories
+.DS_Store
+.idea
+.vscode/
+
+# TensorLayer Directories
 data/
-dist/
-docs/_build
-tensorlayer.egg-info
-tensorlayer/__pycache__
+lib_win/
 
+# Custom Scripts
 update_tl.bat
 update_tl.py
-.vscode/
+
+# Data Files and ByteCode files
+*.gz
+*.npz

CHANGELOG.md

@@ -79,6 +79,7 @@ To release a new version, please update the changelog as followed:
   - CircleCI added to build and upload Docker Containers for each PR merged and tag release (by @DEKHTIARJonathan in #648)
 - Decorator:
   - `tl.decorators` API created including `deprecated_alias` and `private_method` (by @DEKHTIARJonathan in #660)
+  - `tl.decorators` API enriched with `protected_method` (by @DEKHTIARJonathan in #675)
 - Docker:
   - Containers for each release and for each PR merged on master built (by @DEKHTIARJonathan in #648)
   - Containers built in the following configurations (by @DEKHTIARJonathan in #648):
@@ -125,13 +126,18 @@ To release a new version, please update the changelog as followed:
 - All the tests are now using a DEBUG level verbosity when run individualy (by @DEKHTIARJonathan in #660)
 - `tf.identity` as activation is **ignored**, thus reducing the size of the graph by removing useless operation (by @DEKHTIARJonathan in #667)
 - argument dictionaries are now checked and saved within the `Layer` Base Class (by @DEKHTIARJonathan in #667)
+- `Layer` Base Class now presenting methods to update faultlessly `all_layers`, `all_params`, and `all_drop` (by @DEKHTIARJonathan in #675)
+- Input Layers have been removed from `tl.layers.core` and added to `tl.layers.inputs` (by @DEKHTIARJonathan in #675)
+- Input Layers are now considered as true layers in the graph (they represent a placeholder), unittests have been updated (by @DEKHTIARJonathan in #675)
+- Layer API is simplified, with automatic feeding `prev_layer` into `self.inputs` (by @DEKHTIARJonathan in #675)
 
 ### Deprecated
 - `tl.layers.TimeDistributedLayer` argurment `args` is deprecated in favor of `layer_args` (by @DEKHTIARJonathan in #667)
 
 ### Removed
 - `assert()` calls remove and replaced by `raise AssertionError()` (by @DEKHTIARJonathan in #667)
 - `tl.identity` is removed, not used anymore and deprecated for a long time (by @DEKHTIARJonathan in #667)
+- All Code specific to `TF.__version__ < "1.6"` have been removed (by @DEKHTIARJonathan in #675)
 
 ### Fixed
 - Issue #498 - Deprecation Warning Fix in `tl.layers.RNNLayer` with `inspect` (by @DEKHTIARJonathan in #574)
@@ -143,10 +149,10 @@ To release a new version, please update the changelog as followed:
 - Deprecation warning fixed in `tl.layers.binary._compute_threshold()` (by @DEKHTIARJonathan in #658)
 - All references to `tf.logging` replaced by `tl.logging` (by @DEKHTIARJonathan in #661)
 - Duplicated code removed when bias was used (by @DEKHTIARJonathan in #667)
+- `tensorlayer.third_party.roi_pooling.roi_pooling.roi_pooling_ops` is now lazy loaded to prevent systematic error raised (by @DEKHTIARJonathan in #675)
 - Tutorial:
   - `tutorial_word2vec_basic.py` saving issue #476 fixed (by @DEKHTIARJonathan in #635)
   - All tutorials tested and errors have been fixed (by @DEKHTIARJonathan in #635)
-
 ### Security
 
 ### Dependencies Update

tensorlayer/__init__.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """Deep learning and Reinforcement learning library for Researchers and Engineers"""
+
 from __future__ import absolute_import
 
 import os

tensorlayer/cli/__init__.py

@@ -1 +1,3 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
 """The tensorlayer.cli module provides a command-line tool for some common tasks."""

tensorlayer/cli/__main__.py

@@ -1,3 +1,6 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
+
 import argparse
 
 from tensorlayer.cli import train

tensorlayer/cli/train.py

@@ -1,5 +1,5 @@
-#!/usr/bin/env python
-# encoding: utf-8
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
 """
 tl train
 ========

tensorlayer/cost.py

@@ -1,3 +1,4 @@
+#! /usr/bin/python
 # -*- coding: utf-8 -*-
 
 import numbers

tensorlayer/decorators/__init__.py

@@ -1,3 +1,5 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
 """
 TensorLayer provides rich layer implementations trailed for
 various benchmarks and domain-specific problems. In addition, we also
@@ -8,6 +10,7 @@
 """
 
 from .deprecation import deprecated_alias
-from .private_method import private_method
+from .method_decorator import private_method
+from .method_decorator import protected_method
 
-__all__ = ['deprecated_alias', 'private_method']
+__all__ = ['deprecated_alias', 'private_method', 'protected_method']

tensorlayer/decorators/method_decorator.py

@@ -0,0 +1,45 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
+
+import inspect
+
+
+def private_method(func):
+    """decorator for making an instance method private"""
+
+    def func_wrapper(*args, **kwargs):
+        """decorator wrapper function"""
+        outer_frame = inspect.stack()[1][0]
+        if 'self' not in outer_frame.f_locals or outer_frame.f_locals['self'] is not args[0]:
+            raise RuntimeError('%s.%s is a private method' % (args[0].__class__.__name__, func.__name__))
+
+        return func(*args, **kwargs)
+
+    return func_wrapper
+
+
+def protected_method(func):
+    """decorator for making an instance method private"""
+
+    def func_wrapper(*args, **kwargs):
+        """decorator wrapper function"""
+        outer_frame = inspect.stack()[1][0]
+
+        caller = inspect.getmro(outer_frame.f_locals['self'].__class__)[:-1]
+        target = inspect.getmro(args[0].__class__)[:-1]
+
+        share_subsclass = False
+
+        for cls_ in target:
+            print("cls_:", cls_)
+            if issubclass(caller[0], cls_) or caller[0] is cls_:
+                share_subsclass = True
+                break
+
+        if ('self' not in outer_frame.f_locals or
+                outer_frame.f_locals['self'] is not args[0]) and (not share_subsclass):
+            raise RuntimeError('%s.%s is a protected method' % (args[0].__class__.__name__, func.__name__))
+
+        return func(*args, **kwargs)
+
+    return func_wrapper