From 358279b71f8ab2462cf3da57b1f4e82d939df08f Mon Sep 17 00:00:00 2001
From: LielinJiang <50691816+LielinJiang@users.noreply.github.com>
Date: Wed, 11 Nov 2020 20:34:56 +0800
Subject: [PATCH] Update readme (#82)
* update readme
* add app apis
---
README.md | 21 +++++++++++----------
README_en.md | 19 ++++++++++---------
2 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 86e16f65d..41fe5579b 100644
--- a/README.md
+++ b/README.md
@@ -17,14 +17,14 @@ GAN--生成对抗网络,被“卷积网络之父”**Yann LeCun(杨立昆)
* 请确保您按照[安装文档](./docs/zh_CN/install.md)的说明正确安装了PaddlePaddle和PaddleGAN
-* 通过ppgan.app接口使用预训练模型:
+* 通过ppgan.apps接口使用预训练模型:
```python
from ppgan.apps import RealSRPredictor
sr = RealSRPredictor()
sr.run("docs/imgs/monarch.png")
```
-
+* 更多预训练模型的使用请参考[ppgan.apps apis](./docs/zh_CN/apis/apps.md)
* 更多训练、评估教程:
* [数据准备](./docs/zh_CN/data_prepare.md)
* [训练/评估/推理教程](./docs/zh_CN/get_started.md)
@@ -91,19 +91,20 @@ GAN--生成对抗网络,被“卷积网络之父”**Yann LeCun(杨立昆)
- 初版发布,支持Pixel2Pixel、CycleGAN、PSGAN模型,支持视频插针、超分、老照片/视频上色、视频动作生成等应用。
- 模块化设计,接口简单易用。
-## PaddleGAN 特别兴趣小组(Special Interest Group)
-
-最早于1961年被[ACM(Association for Computing Machinery)](https://en.wikipedia.org/wiki/Association_for_Computing_Machinery)首次提出并使用,国际顶尖开源组织包括[Kubernates](https://kubernetes.io/)都采用SIGs的形式,使拥有同样特定兴趣的成员可以共同分享、学习知识并进行项目开发。这些成员不需要在同一国家/地区、同一个组织,只要大家志同道合,都可以奔着相同的目标一同学习、工作、玩耍~
-
-PaddleGAN SIG就是这样一个汇集对GAN感兴趣小伙伴们的开发者组织,在这里,有百度飞桨的一线开发人员、有来自世界500强的资深工程师、有国内外顶尖高校的学生。
-
-我们正在持续招募有兴趣、有能力的开发者加入我们一起共同建设本项目,并一起探索更多有用、有趣的应用。
+## 欢迎加入PaddleGAN技术交流群
-[PaddleGAN QQ 群号:1058398620]
+扫描二维码加入PaddleGAN QQ群[群号:1058398620],获得更高效的问题答疑,与各行业开发者交流讨论,我们期待您的加入!
+### PaddleGAN 特别兴趣小组(Special Interest Group)
+
+最早于1961年被[ACM(Association for Computing Machinery)](https://en.wikipedia.org/wiki/Association_for_Computing_Machinery)首次提出并使用,国际顶尖开源组织包括[Kubernates](https://kubernetes.io/)都采用SIGs的形式,使拥有同样特定兴趣的成员可以共同分享、学习知识并进行项目开发。这些成员不需要在同一国家/地区、同一个组织,只要大家志同道合,都可以奔着相同的目标一同学习、工作、玩耍~
+
+PaddleGAN SIG就是这样一个汇集对GAN感兴趣小伙伴们的开发者组织,在这里,有百度飞桨的一线开发人员、有来自世界500强的资深工程师、有国内外顶尖高校的学生。
+
+我们正在持续招募有兴趣、有能力的开发者加入我们一起共同建设本项目,并一起探索更多有用、有趣的应用。欢迎大家在加入群后联系我们讨论加入SIG并参与共建事宜。
## 贡献代码
diff --git a/README_en.md b/README_en.md
index 5f79886f8..3ff2ca83a 100644
--- a/README_en.md
+++ b/README_en.md
@@ -24,7 +24,7 @@ GAN-Generative Adversarial Network, was praised by "the Father of Convolutional
sr = RealSRPredictor()
sr.run("docs/imgs/monarch.png")
```
-
+* More usage of pre-trained models, please refer to [ppgan.apps apis](./docs/en_US/apis/apps.md)
* More tutorials:
- [Data preparation](./docs/en_US/data_prepare.md)
- [Training/Evaluating/Testing basic usage](./docs/zh_CN/get_started.md)
@@ -80,20 +80,21 @@ GAN-Generative Adversarial Network, was praised by "the Father of Convolutional
- Release first version, supported models include Pixel2Pixel, CycleGAN, PSGAN. Supported applications include video frame interpolation, super resolution, colorize images and videos, image animation.
- Modular design and friendly interface.
-## PaddleGAN Special Interest Group(SIG)
-
-It was first proposed and used by [ACM(Association for Computing Machinery)](https://en.wikipedia.org/wiki/Association_for_Computing_Machinery) in 1961. Top International open source organizations including [Kubernates](https://kubernetes.io/) all adopt the form of SIGs, so that members with the same specific interests can share, learn knowledge and develop projects. These members do not need to be in the same country/region or the same organization, as long as they are like-minded, they can all study, work, and play together with the same goals~
-
-PaddleGAN SIG is such a developer organization that brings together people who interested in GAN. There are frontline developers of PaddlePaddle, senior engineers from the world's top 500, and students from top universities at home and abroad.
-
-We are continuing to recruit developers interested and capable to join us building this project and explore more useful and interesting applications together.
+## Community
-[PaddleGAN QQ Group:1058398620]
+Scan OR Code below to join [PaddleGAN QQ Group:1058398620], you can get offical technical support here and communicate with other developers/friends. Look forward to your participation!
+### PaddleGAN Special Interest Group(SIG)
+
+It was first proposed and used by [ACM(Association for Computing Machinery)](https://en.wikipedia.org/wiki/Association_for_Computing_Machinery) in 1961. Top International open source organizations including [Kubernates](https://kubernetes.io/) all adopt the form of SIGs, so that members with the same specific interests can share, learn knowledge and develop projects. These members do not need to be in the same country/region or the same organization, as long as they are like-minded, they can all study, work, and play together with the same goals~
+
+PaddleGAN SIG is such a developer organization that brings together people who interested in GAN. There are frontline developers of PaddlePaddle, senior engineers from the world's top 500, and students from top universities at home and abroad.
+
+We are continuing to recruit developers interested and capable to join us building this project and explore more useful and interesting applications together.
## Contributing