diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e17d39fb..69b081ff2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,8 +96,8 @@ coverage html ``` ## Documentation -Even though you follow [numpydoc](https://numpydoc.readthedocs.io/en/latest/) document style when writing your code, -this does not ensure those lines appear on TensorLayer online documentation. +Even though you follow [numpydoc](https://numpydoc.readthedocs.io/en/latest/) document style when writing your code, +this does not ensure those lines appear on TensorLayer online documentation. You need further modify corresponding RST files in `docs/modules`. For example, to add your implemented new pooling layer into documentation, modify `docs/modules/layer.rst`. First, insert layer name under Layer list @@ -129,9 +129,9 @@ Finally, test with local documentation: cd ./docs make clean -make html +make html # then view generated local documentation by ./html/index.html -``` +``` ## General intro to TensorLayer2 * TensorLayer2 is built on [TensorFlow2](https://www.tensorflow.org/alpha), so TensorLayer2 is purely eager, no sessions, no globals. diff --git a/README.md b/README.md index 033818f7c..f80cb96c3 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ # Please click [TensorLayerX](https://github.com/tensorlayer/tensorlayerx) 🔥🔥🔥 -[TensorLayer](https://tensorlayer.readthedocs.io) is a novel TensorFlow-based deep learning and reinforcement learning library designed for researchers and engineers. It provides an extensive collection of customizable neural layers to build advanced AI models quickly, based on this, the community open-sourced mass [tutorials](https://github.com/tensorlayer/tensorlayer/blob/master/examples/reinforcement_learning/README.md) and [applications](https://github.com/tensorlayer). TensorLayer is awarded the 2017 Best Open Source Software by the [ACM Multimedia Society](https://twitter.com/ImperialDSI/status/923928895325442049). +[TensorLayer](https://tensorlayer.readthedocs.io) is a novel TensorFlow-based deep learning and reinforcement learning library designed for researchers and engineers. It provides an extensive collection of customizable neural layers to build advanced AI models quickly, based on this, the community open-sourced mass [tutorials](https://github.com/tensorlayer/tensorlayer/blob/master/examples/reinforcement_learning/README.md) and [applications](https://github.com/tensorlayer). TensorLayer is awarded the 2017 Best Open Source Software by the [ACM Multimedia Society](https://twitter.com/ImperialDSI/status/923928895325442049). This project can also be found at [OpenI](https://git.openi.org.cn/TensorLayer/tensorlayer3.0) and [Gitee](https://gitee.com/organizations/TensorLayer). # News diff --git a/docs/index.rst b/docs/index.rst index b4b1fd2b6..eb7f49038 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -75,7 +75,7 @@ method, this part of the documentation is for you. modules/db modules/optimizers modules/distributed - + Command-line Reference ---------------------- diff --git a/docs/modules/activation.rst b/docs/modules/activation.rst index 79bad9601..dd95c9ca1 100644 --- a/docs/modules/activation.rst +++ b/docs/modules/activation.rst @@ -20,7 +20,7 @@ For more complex activation, TensorFlow API will be required. def double_activation(x): return x * 2 - + double_activation = lambda x: x * 2 .. automodule:: tensorlayer.activation diff --git a/setup.travis.cfg b/setup.travis.cfg index 15b01240b..17899f9aa 100644 --- a/setup.travis.cfg +++ b/setup.travis.cfg @@ -32,7 +32,7 @@ addopts = --ignore=tests/test_documentation.py --ignore=tests/performance_test/vgg/tf2-autograph.py --ignore=tests/performance_test/vgg/keras_test.py --ignore=tests/performance_test/vgg/pytorch_test.py - + [flake8] max-line-length = 120 ignore = diff --git a/setup.travis_doc.cfg b/setup.travis_doc.cfg index 41ee76043..424434a8e 100644 --- a/setup.travis_doc.cfg +++ b/setup.travis_doc.cfg @@ -63,4 +63,4 @@ no_spaces_around_selected_binary_operators = True allow_multiline_lambdas = True SPLIT_PENALTY_FOR_ADDED_LINE_SPLIT = 10 -SPLIT_PENALTY_AFTER_OPENING_BRACKET = 500 \ No newline at end of file +SPLIT_PENALTY_AFTER_OPENING_BRACKET = 500