Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run doc test on travis CI for CN doc #43

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.DS_Store
/.pytest_cache
/docs/test_build
docs/_build
tensorlayer/__pycache__
tensorlayer/*pyc
tensorlayer/layers/*pyc
.DS_Store
tensorlayer/cli/__pycache__
tensorlayer/layers/*pyc
13 changes: 13 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# https://docs.travis-ci.com/user/languages/python/
language: python

python:
- '3.6'

install:
- pip install tensorflow
- pip install yapf
- pip install -r requirements/requirements_doc.txt

script:
- ./tests/test_documentation.py
2 changes: 1 addition & 1 deletion docs/modules/distributed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ TensorFlow提供了一些 `Session Hooks <https://www.tensorflow.org/api_guides/
来对sessions做操作,我们在这里加更多的helper来实现更多的常规操作。

Stop after maximum time
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: StopAtTimeHook

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Google Drive
.. autofunction:: save_npz

从save_npz加载模型参数列表
^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: load_npz

把模型参数载入模型
Expand All @@ -173,14 +173,14 @@ Google Drive
.. autofunction:: save_npz_dict

从save_npz_dict加载模型参数列表
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: load_and_assign_npz_dict


保存模型结构
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: save_graph

加载模型结构
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: load_graph
Expand Down Expand Up @@ -219,7 +219,7 @@ Google Drive


文件夹/文件相关函数
------------------
-------------------

判断文件存在
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
61 changes: 0 additions & 61 deletions docs/modules/ops.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/modules/prepro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ HSV 转 RGB
.. autofunction:: hsv_to_rgb

调整色调(Hue)
^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^
.. autofunction:: adjust_hue


Expand Down Expand Up @@ -210,7 +210,7 @@ HSV 转 RGB
.. autofunction:: apply_transform

基于坐标点的的投影变换
^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: projective_transform_by_points


Expand Down
7 changes: 4 additions & 3 deletions docs/user/development.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
开发 Development
================

TensorLayer始于一个帝国理工的研究项目,目前由数位 `GitHub`_ 的贡献者负责维护和进行改进。
TensorLayer始于一个帝国理工的研究项目,目前由数位 `Github`_ 的贡献者负责维护和进行改进。

作为一个为研究员和工程师开发的开源项目,我们诚挚地欢迎您为对项目提供帮助。
每个微小的支持都会帮助我们并且会被记录下来。
Expand Down Expand Up @@ -56,7 +56,7 @@ TensorLayer的想法源于组合TensorFlow的灵活性和正确的 building bloc
""""""""""""""

无论什么时候您发现有些文档没有解释清楚,存在误导,敷衍带过或者根本就是错的。
请及时更新它!*Edit on GitHub*的链接就在每一篇文档的右上角
请及时更新它!*Edit on GitHub* 的链接就在每一篇文档的右上角
并且API引用列表中的每篇文档的*[source]*的链接可以帮助您快速地定位任何文字的根源。


Expand Down Expand Up @@ -109,6 +109,7 @@ TensorLayer有100%的代码覆盖率,这过去被证明是十分有用的的

* 每当您更改任何代码的时候,您应该运行测试脚本来测试它是否能优化现有属性。
* 您修改的每个BUG说明一个缺少的测试案例,

所以每个修复BUG的方案应该配置一个您没修复前的测试案例。

发送拉请求
Expand All @@ -127,5 +128,5 @@ https://guides.github.com/introduction/flow/
GitHub会关闭那个问题。


.. _GitHUb: http://github.com/zsdonghao/tensorlayer
.. _Github: http://github.com/zsdonghao/tensorlayer
.. _our mailing list: [email protected]
6 changes: 3 additions & 3 deletions docs/user/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Basics
- Stacked Denoising Autoencoder and Fine-Tuning (MNIST). A MLP classification task, see `tutorial_mnist.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_mnist.py>`_.
- Convolutional Network (MNIST). Classification task, see `tutorial_mnist.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_mnist.py>`_.
- Convolutional Network (CIFAR-10). Classification task, see `tutorial_cifar10.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_cifar10.py>`_ and `tutorial_cifar10_tfrecord.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_cifar10_tfrecord.py>`_.
- TensorFlow dataset API for object detection see `here <https://github.com/tensorlayer/tensorlayer/blob/master/example/tutorial_tf_dataset_voc.py>`_.
- TensorFlow dataset API for object detection see `tutorial_tf_dataset_voc.py <https://github.com/tensorlayer/tensorlayer/blob/master/example/tutorial_tf_dataset_voc.py>`_.
- Merge TF-Slim into TensorLayer. `tutorial_inceptionV3_tfslim.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_inceptionV3_tfslim.py>`_.
- Merge Keras into TensorLayer. `tutorial_keras.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_keras.py>`_.
- Data augmentation with TFRecord. Effective way to load and pre-process data, see `tutorial_tfrecord*.py <https://github.com/zsdonghao/tensorlayer/tree/master/example>`_ and `tutorial_cifar10_tfrecord.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_cifar10_tfrecord.py>`_.
Expand Down Expand Up @@ -78,12 +78,12 @@ Pretrained Models
- SqueezeNet (ImageNet). Model compression, see `tl.models.SqueezeNetV1 <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_models_squeezenetv1.py>`__ or `tutorial_squeezenet.py <https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_squeezenet.py>`_.
- MobileNet (ImageNet). Model compression, see `tl.models.MobileNetV1 <https://github.com/tensorlayer/tensorlayer/blob/master/example/tutorial_models_mobilenetv1.py>`__ or `tutorial_mobilenet.py <https://github.com/tensorlayer/tensorlayer/blob/master/example/tutorial_mobilenet.py>`__.
- More CNN implementations of `TF-Slim <https://github.com/tensorflow/models/tree/master/research/slim>`_ can be connected to TensorLayer via SlimNetsLayer.
- All pretrained models in `here <https://github.com/tensorlayer/pretrained-models>`_.
- All pretrained models in `tensorlayer/pretrained-models <https://github.com/tensorlayer/pretrained-models>`_.

Miscellaneous
=================

- TensorDB by `fangde <https://github.com/fangde>`_ see `here <https://github.com/akaraspt/tl_paper>`_.
- TensorDB by `fangde <https://github.com/fangde>`_ see `akaraspt/tl_paper <https://github.com/akaraspt/tl_paper>`_.
- A simple web service - `TensorFlask <https://github.com/JoelKronander/TensorFlask>`_ by `JoelKronander <https://github.com/JoelKronander>`__.


Expand Down
1 change: 1 addition & 0 deletions tests