Skip to content

Commit 782ac8e

Browse files
authored
Fix README. (#1044)
* fix README * fix * further cleanup * cleanup * add awesome Tensorlayer back. * add it back
1 parent 2bdc218 commit 782ac8e

File tree

2 files changed

+41
-46
lines changed

2 files changed

+41
-46
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,16 @@ To release a new version, please update the changelog as followed:
8080

8181
### Fixed
8282

83+
- Fix README. (#PR 1044)
84+
8385
### Removed
8486

8587
### Security
8688

8789
### Contributors
8890

91+
- @luomai
92+
8993

9094
## [2.2.0] - 2019-09-13
9195

README.md

Lines changed: 37 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -20,49 +20,34 @@
2020
<!--- [![Documentation Status](https://readthedocs.org/projects/tensorlayercn/badge/)](https://tensorlayercn.readthedocs.io/)
2121
<!--- [![PyUP Updates](https://pyup.io/repos/github/tensorlayer/tensorlayer/shield.svg)](https://pyup.io/repos/github/tensorlayer/tensorlayer/) --->
2222

23-
<br/>
24-
25-
<a href="https://join.slack.com/t/tensorlayer/shared_invite/enQtMjUyMjczMzU2Njg4LWI0MWU0MDFkOWY2YjQ4YjVhMzI5M2VlZmE4YTNhNGY1NjZhMzUwMmQ2MTc0YWRjMjQzMjdjMTg2MWQ2ZWJhYzc" target="\_blank">
26-
<div align="center">
27-
<img src="img/join_slack.png" width="40%"/>
28-
</div>
29-
</a>
30-
31-
<br/>
32-
3323
TensorLayer 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 complex AI models. TensorLayer is awarded the 2017 Best Open Source Software by the [ACM Multimedia Society](https://twitter.com/ImperialDSI/status/923928895325442049).
3424
TensorLayer can also be found at [iHub](https://code.ihub.org.cn/projects/328) and [Gitee](https://gitee.com/organizations/TensorLayer).
3525

3626
# News
3727

38-
🔥📰🔥 Reinforcement Learning Model Zoos: [Low-level APIs for Research](https://github.com/tensorlayer/tensorlayer/tree/master/examples/reinforcement_learning) and [High-level APIs for Production](https://github.com/tensorlayer/RLzoo)
39-
40-
🔥📰🔥 [Sipeed Maxi-EMC](https://github.com/sipeed/Maix-EMC): Run TensorLayer models on the **low-cost AI chip** (e.g., K210) (Alpha Version)
28+
🔥 Reinforcement Learning Model Zoo: [Low-level APIs for Research](https://github.com/tensorlayer/tensorlayer/tree/master/examples/reinforcement_learning) and [High-level APIs for Production](https://github.com/tensorlayer/RLzoo)
4129

42-
🔥📰🔥 [NNoM](https://github.com/majianjia/nnom): Run TensorLayer quantized models on the **MCU** (e.g., STM32) (Coming Soon)
30+
🔥 [Sipeed Maxi-EMC](https://github.com/sipeed/Maix-EMC): Run TensorLayer models on the **low-cost AI chip** (e.g., K210) (Alpha Version)
4331

32+
<!-- 🔥 [NNoM](https://github.com/majianjia/nnom): Run TensorLayer quantized models on the **MCU** (e.g., STM32) (Coming Soon) -->
4433

45-
🔥📰🔥 [Free GPU and Data Storage from SurgicalAI](https://github.com/fangde/FreeGPU): SurgicalAI is sponsoring the TensorLayer Community with Cloud Computing Resources such as Free GPUs and Data Storage.
34+
🔥 [Free GPU and storage resources](https://github.com/fangde/FreeGPU): TensorLayer users can access to free GPU and storage resources donated by SurgicalAI. Thank you SurgicalAI!
4635

47-
# Features
36+
# Design Features
4837

49-
As deep learning practitioners, we have been looking for a library that can address various development
50-
purposes. This library is easy to adopt by providing diverse examples, tutorials and pre-trained models.
51-
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:
38+
TensorLayer is a new deep learning library designed with simplicity, flexibility and high-performance in mind.
5239

53-
- **_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.
54-
- **_Flexibility_** : TensorLayer APIs are transparent: it does not mask TensorFlow from users; but leaving massive hooks that help _low-level tuning_ and _deep customization_.
55-
- **_Zero-cost Abstraction_** : TensorLayer can achieve the _full power_ of TensorFlow. The following table shows the training speeds of [VGG16](http://www.robots.ox.ac.uk/~vgg/research/very_deep/) using TensorLayer and native TensorFlow on a TITAN Xp.
56-
57-
| Mode | Lib | Data Format | Max GPU Memory Usage(MB) | Max CPU Memory Usage(MB) | Avg CPU Memory Usage(MB) | Runtime (sec) |
58-
| :-------: | :-------------: | :----------: | :----------------------: | :----------------------: | :----------------------: | :-----------: |
59-
| AutoGraph | TensorFlow 2.0 | channel last | 11833 | 2161 | 2136 | 74 |
60-
| | Tensorlayer 2.0 | channel last | 11833 | 2187 | 2169 | 76 |
61-
| Graph | Keras | channel last | 8677 | 2580 | 2576 | 101 |
62-
| Eager | TensorFlow 2.0 | channel last | 8723 | 2052 | 2024 | 97 |
63-
| | TensorLayer 2.0 | channel last | 8723 | 2010 | 2007 | 95 |
40+
- ***Simplicity*** : TensorLayer has a high-level layer/model abstraction which is effortless to learn. You can learn how deep learning can benefit your AI tasks in minutes through the massive [examples](https://github.com/tensorlayer/awesome-tensorlayer).
41+
- ***Flexibility*** : TensorLayer APIs are transparent and flexible, inspired by the emerging PyTorch library. Compared to the Keras abstraction, TensorLayer makes it much easier to build and train complex AI models.
42+
- ***Zero-cost Abstraction*** : Though simple to use, TensorLayer does not require you to make any compromise in the performance of TensorFlow (Check the following benchmark section for more details).
6443

44+
TensorLayer stands at a unique spot in the TensorFlow wrappers. Other wrappers like Keras and TFLearn
45+
hide many powerful features of TensorFlow and provide little support for writing custom AI models. Inspired by PyTorch, TensorLayer APIs are simple, flexible and Pythonic,
46+
making it easy to learn while being flexible enough to cope with complex AI tasks.
47+
TensorLayer has a fast-growing community. It has been used by researchers and engineers all over the world, including those from Peking University,
48+
Imperial College London, UC Berkeley, Carnegie Mellon University, Stanford University, and companies like Google, Microsoft, Alibaba, Tencent, Xiaomi, and Bloomberg.
6549

50+
# Multilingual Documents
6651

6752
TensorLayer has extensive documentation for both beginners and professionals. The documentation is available in
6853
both English and Chinese.
@@ -74,17 +59,17 @@ both English and Chinese.
7459
If you want to try the experimental features on the the master branch, you can find the latest document
7560
[here](https://tensorlayer.readthedocs.io/en/latest/).
7661

77-
# Extensive examples
62+
# Extensive Examples
7863

79-
You can find a large collection of tutorials, examples and real-world applications using TensorLayer within [examples](examples/) or through the following space:
64+
You can find a large collection of examples that use TensorLayer in [here](examples/) and the following space:
8065

8166
<a href="https://github.com/tensorlayer/awesome-tensorlayer/blob/master/readme.md" target="\_blank">
8267
<div align="center">
8368
<img src="img/awesome-mentioned.png" width="40%"/>
8469
</div>
8570
</a>
8671

87-
# Installing TensorLayer is easy
72+
# Getting Start
8873

8974
TensorLayer 2.0 relies on TensorFlow, numpy, and others. To use GPUs, CUDA and cuDNN are required.
9075

@@ -114,13 +99,11 @@ pip3 install --upgrade tensorlayer[extra] # only the `extra` dependen
11499
pip3 install --upgrade tensorlayer[contrib_loggers] # only the `contrib_loggers` dependencies
115100
```
116101

117-
118-
<!---
119-
Alternatively, you can install the latest or development version by directly pulling from github:
102+
If you are TensorFlow 1.X users, you can use TensorLayer 1.11.0:
120103

121104
```bash
122105
# For last stable version of TensorLayer 1.X
123-
pip3 install --upgrade tensorlayer==1.X
106+
pip3 install --upgrade tensorlayer==1.11.0
124107
```
125108

126109
<!---
@@ -155,7 +138,7 @@ nvidia-docker run -it --rm -p 8888:8888 -p 6006:6006 -e PASSWORD=JUPYTER_NB_PASS
155138
```
156139
--->
157140

158-
# Benchmark
141+
# Performance Benchmark
159142

160143
The following table shows the training speeds of [VGG16](http://www.robots.ox.ac.uk/~vgg/research/very_deep/) using TensorLayer and native TensorFlow on a TITAN Xp.
161144

@@ -167,13 +150,25 @@ The following table shows the training speeds of [VGG16](http://www.robots.ox.ac
167150
| Eager | TensorFlow 2.0 | channel last | 8723 | 2052 | 2024 | 97 |
168151
| | TensorLayer 2.0 | channel last | 8723 | 2010 | 2007 | 95 |
169152

170-
# Contribute
153+
# Getting Involved
171154

172155
Please read the [Contributor Guideline](CONTRIBUTING.md) before submitting your PRs.
173156

174-
# Cite
157+
We suggest users to report bugs using Github issues. Users can also discuss how to use TensorLayer in the following slack channel.
175158

176-
If you use TensorLayer for any projects, please cite this paper:
159+
<br/>
160+
161+
<a href="https://join.slack.com/t/tensorlayer/shared_invite/enQtMjUyMjczMzU2Njg4LWI0MWU0MDFkOWY2YjQ4YjVhMzI5M2VlZmE4YTNhNGY1NjZhMzUwMmQ2MTc0YWRjMjQzMjdjMTg2MWQ2ZWJhYzc" target="\_blank">
162+
<div align="center">
163+
<img src="img/join_slack.png" width="40%"/>
164+
</div>
165+
</a>
166+
167+
<br/>
168+
169+
# Citing TensorLayer
170+
171+
If you find TensorLayer useful for your project, please cite the following paper:
177172

178173
```
179174
@article{tensorlayer2017,
@@ -183,8 +178,4 @@ If you use TensorLayer for any projects, please cite this paper:
183178
url = {http://tensorlayer.org},
184179
year = {2017}
185180
}
186-
```
187-
188-
# License
189-
190-
TensorLayer is released under the Apache 2.0 license.
181+
```

0 commit comments

Comments
 (0)