Skip to content

Commit

Permalink
Documentation fix (#703)
Browse files Browse the repository at this point in the history
* Update conf.py

* Theme RTD removed and added to requirements.

* TF 1.9.0rc1 added to Travis

* Changelog updated ready for 1.8.6

* Release 1.8.6

* Readme.rst correction

* Release date fixed

* 1.8.6 changed to 1.9.0
  • Loading branch information
Jonathan DEKHTIAR authored Jun 16, 2018
1 parent 5e61f27 commit 5f57e8e
Show file tree
Hide file tree
Showing 30 changed files with 37 additions and 1,423 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +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.9.0rc1 # 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
Expand Down
137 changes: 21 additions & 116 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,124 +69,23 @@ To release a new version, please update the changelog as followed:
## [Unreleased]

### Added
- API:
- `tl.alphas` and `tl.alphas_like` added following the tf.ones/zeros and tf.zeros_like/ones_like (PR #580)
- `tl.lazy_imports.LazyImport` to import heavy libraries only when necessary (PR #667)
- `tl.act.leaky_relu6` and `tl.layers.PRelu6Layer` have been deprecated (PR #686)
- `tl.act.leaky_twice_relu6` and `tl.layers.PTRelu6Layer` have been deprecated (PR #686)
- CI Tool:
- [Stale Probot](https://github.com/probot/stale) added to clean stale issues (PR #573)
- [Changelog Probot](https://github.com/mikz/probot-changelog) Configuration added (PR #637)
- Travis Builds now handling a matrix of TF Version from TF==1.6.0 to TF==1.8.0 (PR #644)
- CircleCI added to build and upload Docker Containers for each PR merged and tag release (PR #648)
- 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):
- py2 + cpu
- py2 + gpu
- py3 + cpu
- py3 + gpu
- Documentation:
- 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)
- Layer:
- ElementwiseLambdaLayer added to use custom function to connect multiple layer inputs (PR #579)
- AtrousDeConv2dLayer added (PR #662)
- Fix bugs of using `tf.layers` in CNN (PR #686)
- Optimizer:
- AMSGrad Optimizer added based on `On the Convergence of Adam and Beyond (ICLR 2018)` (PR #636)
- Setup:
- Creation of installation flaggs `all`, `all_cpu`, and `all_gpu` (PR #660)
- Test:
- `test_utils_predict.py` added to reproduce and fix issue #288 (PR #566)
- `Layer_DeformableConvolution_Test` added to reproduce issue #572 with deformable convolution (PR #573)
- `Array_Op_Alphas_Test` and `Array_Op_Alphas_Like_Test` added to test `tensorlayer/array_ops.py` file (PR #580)
- `test_optimizer_amsgrad.py` added to test `AMSGrad` optimizer (PR #636)
- `test_logging.py` added to insure robustness of the logging API (PR #645)
- `test_decorators.py` added (PR #660)
- `test_activations.py` added (PR #686)
- Tutorials:
- `tutorial_tfslim` has been introduced to show how to use `SlimNetsLayer` (PR #560).
- add the following to all tutorials (PR #697):
```python
tf.logging.set_verbosity(tf.logging.DEBUG)
tl.logging.set_verbosity(tl.logging.DEBUG)
```


### Changed
- Tensorflow CPU & GPU dependencies moved to separated requirement files in order to allow PyUP.io to parse them (PR #573)
- 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.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)
- `tl.files.voc_dataset` fixed because of original Pascal VOC website was down (PR #657)
- extra requirements hidden inside the library added in the project requirements (PR #657)
- requirements files refactored in `requirements/` directory (PR #657)
- README.md and other markdown files have been refactored and cleaned. (PR #639)
- Ternary Convolution Layer added in unittest (PR #658)
- Convolution Layers unittests have been cleaned & refactored (PR #658)
- All the tests are now using a DEBUG level verbosity when run individualy (PR #660)
- `tf.identity` as activation is **ignored**, thus reducing the size of the graph by removing useless operation (PR #667)
- argument dictionaries are now checked and saved within the `Layer` Base Class (PR #667)
- `Layer` Base Class now presenting methods to update faultlessly `all_layers`, `all_params`, and `all_drop` (PR #675)
- 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)
- `tl.act.leaky_relu` have been deprecated in favor of `tf.nn.leaky_relu` (PR #686)

### Removed
- `assert()` calls remove and replaced by `raise AssertionError()` (PR #667)
- `tl.identity` is removed, not used anymore and deprecated for a long time (PR #667)
- All Code specific to `TF.__version__ < "1.6"` have been removed (PR #675)

### Fixed
- Issue #498 - Deprecation Warning Fix in `tl.layers.RNNLayer` with `inspect` (PR #574)
- Issue #498 - Deprecation Warning Fix in `tl.files` with truth value of an empty array is ambiguous (PR #575)
- Issue #565 related to `tl.utils.predict` fixed - `np.hstack` problem in which the results for multiple batches are stacked along `axis=1` (PR #566)
- Issue #572 with `tl.layers.DeformableConv2d` fixed (PR #573)
- Issue #664 with `tl.layers.ConvLSTMLayer` fixed (PR #676)
- Typo of the document of ElementwiseLambdaLayer (PR #588)
- Error in `tl.layers.TernaryConv2d` fixed - self.inputs not defined (PR #658)
- Deprecation warning fixed in `tl.layers.binary._compute_threshold()` (PR #658)
- All references to `tf.logging` replaced by `tl.logging` (PR #661)
- Duplicated code removed when bias was used (PR #667)
- `tensorlayer.third_party.roi_pooling.roi_pooling.roi_pooling_ops` is now lazy loaded to prevent systematic error raised (PR #675)
- Tutorial:
- `tutorial_word2vec_basic.py` saving issue #476 fixed (PR #635)
- All tutorials tested and errors have been fixed (PR #635)

### Security

### Dependencies Update
- Update pytest from 3.5.1 to 3.6.0 (PR #647)
- Update progressbar2 from 3.37.1 to 3.38.0 (PR #651)
- Update scikit-image from 0.13.1 to 0.14.0 (PR #656)
- Update keras from 2.1.6 to 2.2.0 (PR #684)
- Update requests from 2.18.4 to 2.19.0 (PR #695)

### 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 #691 #692
- @2wins: #560 #566 #662
- @One-sixth: #579
- @zsdonghao: #587 #588 #639 #685 #697
- @luomai: #639 #677
- @dengyueyun666: #676

## [1.8.6] - 2018-06-02

## [1.9.0] - 2018-06-16

### Added
- API:
Expand All @@ -202,6 +101,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):
Expand Down Expand Up @@ -232,6 +132,11 @@ To release a new version, please update the changelog as followed:
- `test_activations.py` added (PR #686)
- Tutorials:
- `tutorial_tfslim` has been introduced to show how to use `SlimNetsLayer` (PR #560).
- add the following to all tutorials (PR #697):
```python
tf.logging.set_verbosity(tf.logging.DEBUG)
tl.logging.set_verbosity(tl.logging.DEBUG)
```

### Changed
- Tensorflow CPU & GPU dependencies moved to separated requirement files in order to allow PyUP.io to parse them (PR #573)
Expand All @@ -255,6 +160,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)
Expand All @@ -277,12 +183,11 @@ To release a new version, please update the changelog as followed:
- All references to `tf.logging` replaced by `tl.logging` (PR #661)
- Duplicated code removed when bias was used (PR #667)
- `tensorlayer.third_party.roi_pooling.roi_pooling.roi_pooling_ops` is now lazy loaded to prevent systematic error raised (PR #675)
- Documentation not build in RTD due to old version of theme in docs directory fixed (PR #703)
- Tutorial:
- `tutorial_word2vec_basic.py` saving issue #476 fixed (PR #635)
- All tutorials tested and errors have been fixed (PR #635)

### Security

### Dependencies Update
- Update pytest from 3.5.1 to 3.6.0 (PR #647)
- Update progressbar2 from 3.37.1 to 3.38.0 (PR #651)
Expand All @@ -291,13 +196,13 @@ To release a new version, please update the changelog as followed:
- Update requests from 2.18.4 to 2.19.0 (PR #695)

### 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)
- @2wins (#560 #566 #662)
- @One-sixth (#579)
- @zsdonghao (#587 #588 #639 #685)
- @luomai (#639 #677)
- @dengyueyun666 (#676)
- @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 #691 #692 #703
- @2wins: #560 #566 #662
- @One-sixth: #579
- @zsdonghao: #587 #588 #639 #685 #697
- @luomai: #639 #677
- @dengyueyun666: #676

## [1.8.5] - 2018-05-09

Expand Down Expand Up @@ -338,6 +243,6 @@ To release a new version, please update the changelog as followed:
### Contributors
@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.6rc6...1.8.5
[1.8.5]: https://github.com/tensorlayer/tensorlayer/compare/1.8.4...1.8.5
[Unreleased]: https://github.com/tensorlayer/tensorlayer/compare/1.9.0...master
[1.9.0]: https://github.com/tensorlayer/tensorlayer/compare/1.9.0...1.8.5
[1.8.5]: https://github.com/tensorlayer/tensorlayer/compare/1.8.4...1.8.5
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.6rc6...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.9.0...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)

Expand All @@ -40,7 +40,7 @@ TensorLayer is a novel TensorFlow-based deep learning and reinforcement learning
# Why another deep learning library: TensorLayer

As deep learning practitioners, we have been looking for a library that can address various development
purposes. This library is easy to adopt by providing diverse examples, tutorials and pre-trained models.
purposes. This library is easy to adopt by providing diverse examples, tutorials and pre-trained models.
Also, it allow users to easily fine-tune TensorFlow; while being suitable for production deployment. TensorLayer aims to satisfy all these purposes. It has three key features:

- ***Simplicity*** : TensorLayer lifts the low-level dataflow interface of TensorFlow to *high-level* layers / models. It is very easy to learn through the rich [example codes](https://github.com/tensorlayer/awesome-tensorlayer) contributed by a wide community.
Expand All @@ -54,8 +54,8 @@ Also, it allow users to easily fine-tune TensorFlow; while being suitable for pr


TensorLayer stands at a unique spot in the library landscape. Other wrapper libraries like Keras and TFLearn also provide high-level abstractions. They, however, often
hide the underlying engine from users, which make them hard to customize
and fine-tune. On the contrary, TensorLayer APIs are generally flexible and transparent.
hide the underlying engine from users, which make them hard to customize
and fine-tune. On the contrary, TensorLayer APIs are generally flexible and transparent.
Users often find it easy to start with the examples and tutorials, and then dive
into TensorFlow seamlessly. In addition, TensorLayer does not create library lock-in through native supports for importing components from Keras, TFSlim and TFLearn.

Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,19 +168,19 @@ TensorLayer is released under the Apache 2.0 license.
: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
:target: https://github.com/tensorlayer/tensorlayer/compare/1.9.0...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
Expand Down
17 changes: 0 additions & 17 deletions docs/_themes/sphinx_rtd_theme/__init__.py

This file was deleted.

31 changes: 0 additions & 31 deletions docs/_themes/sphinx_rtd_theme/breadcrumbs.html

This file was deleted.

52 changes: 0 additions & 52 deletions docs/_themes/sphinx_rtd_theme/footer.html

This file was deleted.

Loading

0 comments on commit 5f57e8e

Please sign in to comment.