Skip to content

Commit 8f1f6f6

Browse files
committed
slightly improve readme.
1 parent 01f89ab commit 8f1f6f6

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ TensorLayer is a deep learning and reinforcement learning library on top of [Ten
2424

2525
# News
2626
* [18 Jan] [《深度学习:一起玩转TensorLayer》](http://www.broadview.com.cn/book/5059) (Deep Learning using TensorLayer)
27-
* [17 Dec] Experimentally release APIs for distributed training (by [TensorPort](https://tensorport.com)). See [tiny example](https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_mnist_distributed.py).
27+
* [17 Dec] Release experimental APIs for distributed training (by [TensorPort](https://tensorport.com)). See [tiny example](https://github.com/zsdonghao/tensorlayer/blob/master/example/tutorial_mnist_distributed.py).
2828
* [17 Nov] Release data augmentation APIs for object detection, see [tl.prepro](http://tensorlayer.readthedocs.io/en/latest/modules/prepro.html#object-detection).
2929
* [17 Nov] Support [Convolutional LSTM](https://arxiv.org/abs/1506.04214), see [ConvLSTMLayer](http://tensorlayer.readthedocs.io/en/latest/modules/layers.html#conv-lstm-layer).
3030
* [17 Nov] Support [Deformable Convolution](https://arxiv.org/abs/1703.06211), see [DeformableConv2dLayer](http://tensorlayer.readthedocs.io/en/latest/modules/layers.html#d-deformable-conv).
@@ -41,13 +41,15 @@ TensorLayer is a deep learning and reinforcement learning library on top of [Ten
4141

4242
# Installation
4343

44-
TensorLayer has package pre-requisites including TensorFlow, numpy, matplotlib and nltk (optional). For GPU support, CUDA and cuDNN are required. Please check [documentation](http://tensorlayer.readthedocs.io/en/latest/user/installation.html) for detailed instructions. The simplest way to install TensorLayer in your python program is:
44+
TensorLayer has pre-requisites including TensorFlow, numpy, matplotlib and nltk (optional). For GPU support, CUDA and cuDNN are required.
45+
The simplest way to install TensorLayer is:
4546

4647
```bash
4748
[for master version] pip install git+https://github.com/zsdonghao/tensorlayer.git (Recommended)
4849
[for stable version] pip install tensorlayer
4950
```
5051

52+
Please check [documentation](http://tensorlayer.readthedocs.io/en/latest/user/installation.html) for detailed instructions.
5153

5254

5355
# Examples and Tutorials
@@ -123,16 +125,17 @@ TensorLayer provides two set of Convolutional layer APIs, see [(Professional)](h
123125

124126
# Library Features
125127

126-
As deep learning practitioners, we have been looking for a library that can serve for various development phases. This library shall be easy for beginners by providing rich neural network reference implementations. Later, it can be extended to address *real-world problems* by controlling training backends to exhibit low-level cognitive behaviours. In the end, it shall be able to serve in challenging *production environments*. TensorLayer is developed with the following goals:
128+
As deep learning practitioners, we have been looking for a library that can serve for various development phases. This library is easy for beginners by offering rich neural network
129+
examples and tutorials. Later, its APIs can be extended to address *real-world problems* by allowing users to carefully manipulating TensorFlow. In the end, it is able to serve in challenging *production environments*. TensorLayer is a novel library that aims to satisfy development requirements throughout these phases. It has three key features:
127130

128-
- *Simplicity* : TensorLayer lifts the low-level dataflow abstraction of TensorFlow to **high-level** deep learning modules.
129-
A user often find it easy to bootstrap with TensorLayer, and then dive into low-level implementation only if need.
131+
- *Simplicity* : TensorLayer lifts the low-level dataflow abstraction of TensorFlow to **high-level** deep learning modules. It also
132+
provides users with massive examples and tutorials to help bootstrap.
130133
- *Transparency* : TensorLayer provides access to the **native APIs** of TensorFlow. This helps users achieve flexible controls within the training engine.
131-
- *Performance* : TensorLayer provides **zero-cost** abstraction (see Benchmark below). It can run on distributed and heterogeneous TensorFlow platforms with full power.
134+
- *Performance* : TensorLayer provides **zero-cost** abstraction. It can run on distributed and heterogeneous TensorFlow platforms with full power.
132135

133-
## Low Runtime Overhead
136+
## Negligible Overhead
134137

135-
TensorLayer has negligible overhead. We show this by benchmarking classic deep learning
138+
TensorLayer has negligible performance overhead. We benchmark classic deep learning
136139
models using TensorLayer and native TensorFlow implementations
137140
on a Titan X Pascal GPU. Here are the training speeds of respective tasks:
138141

@@ -141,14 +144,17 @@ on a Titan X Pascal GPU. Here are the training speeds of respective tasks:
141144
| TensorLayer | 2528 images/s | 18063 words/s | 58167 words/s |
142145
| TensorFlow | 2530 images/s | 18075 words/s | 58181 words/s |
143146

144-
## Comparing TensorLayer with Keras and TFLearn
147+
## Compared with Keras and TFLearn
145148

146149
A frequent question regarding TensorLayer is what is the different with other libraries like Keras and Tflearn.
147150
These libraries are comfortable to start with. They provide imperative abstractions to lower adoption barrier;
148151
but in turn mask the underlying engine from users. Though good for bootstrap,
149152
it becomes hard to leverage the advanced features of TensorFlow, which is quite necessary in tackling real-world problems.
150153
Without compromise in simplicity, TensorLayer APIs are generally more flexible and transparent.
151-
Users often find it easy to start with the examples and tutorials of TensorLayer, then dive into the TensorFlow low-level APIs only if need through the transparent API design.
154+
Users often find it easy to start with the examples and tutorials of TensorLayer, and
155+
then dive into the TensorFlow low-level APIs only if need through the transparent API design.
156+
TensorLayer does not intend to create library lock-in. Users can easily import models from Keras, TFSlim and TFLearn into
157+
a TensorLayer environment.
152158

153159

154160
# Documentation
@@ -229,7 +235,7 @@ We provide many helper functions (like `fit()` , `test()`) that is similar to Ke
229235

230236
# Academic and Industry Users
231237

232-
TensorLayer is in an active development stage and has received numerous contributions from an open community.
238+
TensorLayer is in an active development stage and has an open community.
233239
It has been widely used by researchers from Imperial College London, Carnegie Mellon University, Stanford University,
234240
Tsinghua University, UCLA, Linköping University and etc.,
235241
as well as engineers from Google, Microsoft, Alibaba, Tencent, Penguins Innovate, ReFULE4, Bloomberg, GoodAILab and many others.

0 commit comments

Comments
 (0)