Skip to content

Commit

Permalink
updatedCN&ENReadMe (PaddlePaddle#76)
Browse files Browse the repository at this point in the history
* update Readme
  • Loading branch information
LaraStuStu authored Nov 6, 2020
1 parent 71f3755 commit 83c1b7e
Show file tree
Hide file tree
Showing 6 changed files with 122 additions and 91 deletions.
110 changes: 64 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,113 @@
<div align='center'>
<img src='./docs/imgs/ppgan.jpg'>
</div>

简体中文 | [English](./README_en.md)

# PaddleGAN

PaddleGAN 是一个基于飞桨的生成对抗网络开发工具包.

### 图片变换
<div align='center'>
<img src='./docs/imgs/horse2zebra.gif'>
</div>

### 妆容迁移
<div align='center'>
<img src='./docs/imgs/makeup_shifter.png'>
</div>

### 老视频修复
<div align='center'>
<img src='./docs/imgs/color_sr_peking.gif'>
</div>
飞桨生成对抗网络开发套件--PaddleGAN,为开发者提供经典及前沿的生成对抗网络高性能实现,并支撑开发者快速构建、训练及部署生成对抗网络,以供学术、娱乐及产业应用。

### 超分辨率
<div align='center'>
<img src='./docs/imgs/sr_demo.png'>
</div>
GAN--生成对抗网络,被“卷积网络之父”**Yann LeCun(杨立昆)**誉为**「过去十年计算机科学领域最有趣的想法之一」**,是近年来火遍全网,AI研究者最为关注的深度学习技术方向之一。

### 动作驱动
<div align='center'>
<img src='./docs/imgs/first_order.gif'>
<img src='./docs/imgs/ppgan.jpg'>
</div>

特性:

- 高度的灵活性:

模块化设计,解耦各个网络组件,开发者轻松搭建、试用各种检测模型及优化策略,快速得到高性能、定制化的算法。

- 丰富的应用:

PaddleGAN 提供了非常多的应用,比如说图像生成,图像修复,图像上色,视频补帧,人脸妆容迁移等.

## 安装

请参考[安装文档](./docs/zh_CN/install.md)来进行PaddlePaddle和ppgan的安装
[![License](https://img.shields.io/badge/license-Apache%202-red.svg)](LICENSE)![python version](https://img.shields.io/badge/python-3.6+-orange.svg)

## 快速开始

通过ppgan.app接口使用预训练模型:
* 请确保您按照[安装文档](./docs/zh_CN/install.md)的说明正确安装了PaddlePaddle和PaddleGAN

* 通过ppgan.app接口使用预训练模型:

```python
from ppgan.apps import RealSRPredictor
sr = RealSRPredictor()
sr.run("docs/imgs/monarch.png")
```

更多训练、评估教程参考:
* 更多训练、评估教程:
* [数据准备](./docs/zh_CN/data_prepare.md)
* [训练/评估/推理教程](./docs/zh_CN/get_started.md)

- [数据准备](./docs/zh_CN/data_prepare.md)
- [训练/评估/推理教程](./docs/zh_CN/get_started.md)

## 模型教程
## 经典模型实现

* [Pixel2Pixel](./docs/zh_CN/tutorials/pix2pix_cyclegan.md)
* [CycleGAN](./docs/zh_CN/tutorials/pix2pix_cyclegan.md)
* [PSGAN](./docs/zh_CN/tutorials/psgan.md)
* [First Order Motion Model](./docs/zh_CN/tutorials/motion_driving.md)

## 复合应用

* [视频修复](./docs/zh_CN/tutorials/video_restore.md)

## 在线体验
## 在线教程

通过[AI Studio实训平台](https://aistudio.baidu.com/aistudio/index)在线体验:
您可以通过[人工智能学习与实训社区AI Studio](https://aistudio.baidu.com/aistudio/index) 的示例工程在线体验PaddleGAN的部分能力:

|在线教程 | 链接 |
|--------------|-----------|
|老北京视频修复|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/1161285)|
|表情动作迁移-当苏大强唱起unravel |[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/1048840)|

## 效果展示

### 图片变换

<div align='center'>
<img src='./docs/imgs/horse2zebra.gif'width='700' height='200'/>
</div>

### 老视频修复

<div align='center'>
<img src='./docs/imgs/color_sr_peking.gif' width='700'/>
</div>


### 动作迁移

<div align='center'>
<img src='./docs/imgs/first_order.gif'/>
</div>

### 超分辨率

<div align='center'>
<img src='./docs/imgs/sr_demo.png'width='700' height='250'/>
</div>


### 妆容迁移

<div align='center'>
<img src='./docs/imgs/makeup_shifter.png'width='700' height='250'/>
</div>


## 版本更新

- v0.1.0 (2020.11.02)
- 初版发布,支持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 QQ 群号:1058398620]

<div align='center'>
<img src='./docs/imgs/qq.png'width='250' height='300'/>
</div>

## 贡献代码

我们非常欢迎您可以为PaddleGAN提供任何贡献和建议。大多数贡献都需要同意参与者许可协议(CLA)。当提交拉取请求时,CLA机器人会自动检查您是否需要提供CLA。 只需要按照机器人提供的说明进行操作即可。CLA只需要同意一次,就能应用到所有的代码仓库上。关于更多的流程请参考[贡献指南](docs/zh_CN/contribute.md)。

## 许可证书

本项目的发布受[Apache 2.0 license](LICENSE)许可认证。
103 changes: 58 additions & 45 deletions README_en.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,99 @@
<div align='center'>
<img src='./docs/imgs/ppgan.jpg'>
</div>

English | [简体中文](./README.md)

# PaddleGAN

PaddleGAN is a software development kit of Generative Adversarial Network based on PaddlePaddle.
PaddleGAN provides developers with high-performance implementation of classic and SOTA Generative Adversarial Networks, and support developers to quickly build, train and deploy GANs for academic, entertainment and industrial usage.

GAN-Generative Adversarial Network, was praised by "the Father of Convolutional Networks" **Yann LeCun (Yang Likun)** as **[One of the most interesting ideas in the field of computer science in the past decade]**. It's one the research area in deep learning that AI researchers are most concerned about.

### Image Translation
<div align='center'>
<img src='./docs/imgs/horse2zebra.gif'>
<img src='./docs/imgs/ppgan.jpg'>
</div>

[![License](https://img.shields.io/badge/license-Apache%202-red.svg)](LICENSE)![python version](https://img.shields.io/badge/python-3.6+-orange.svg)

### Makeup shifter
<div align='center'>
<img src='./docs/imgs/makeup_shifter.png'>
</div>
## Quick Start

* Please refer [install](./docs/en_US/install.md) to ensure you sucessfully installed PaddlePaddle and PaddleGAN.

* Get started through ppgan.app interface:

```python
from ppgan.apps import RealSRPredictor
sr = RealSRPredictor()
sr.run("docs/imgs/monarch.png")
```

* More tutorials:
- [Data preparation](./docs/en_US/data_prepare.md)
- [Training/Evaluating/Testing basic usage](./docs/zh_CN/get_started.md)

## Model Tutorial

* [Pixel2Pixel](./docs/en_US/tutorials/pix2pix_cyclegan.md)
* [CycleGAN](./docs/en_US/tutorials/pix2pix_cyclegan.md)
* [PSGAN](./docs/en_US/tutorials/psgan.md)
* [First Order Motion Model](./docs/en_US/tutorials/motion_driving.md)

## Composite Application

* [Video restore](./docs/zh_CN/tutorials/video_restore.md)

## Examples

### Image Translation

### Old video restore
<div align='center'>
<img src='./docs/imgs/color_sr_peking.gif'>
<img src='./docs/imgs/horse2zebra.gif'width='700' height='200'/>
</div>

### Super resolution

### Old video restore
<div align='center'>
<img src='./docs/imgs/sr_demo.png'>
<img src='./docs/imgs/color_sr_peking.gif' width='700'/>
</div>


### Motion driving
<div align='center'>
<img src='./docs/imgs/first_order.gif'>
</div>

Features:

- Highly Flexible:
### Super resolution

Components are designed to be modular. Model architectures, as well as data
preprocess pipelines, can be easily customized with simple configuration
changes.
<div align='center'>
<img src='./docs/imgs/sr_demo.png'width='700' height='250'/>
</div>

- Rich applications:

PaddleGAN provides rich of applications, such as image generator, image restorer, image colorizer, video interpolator, makeup shifter.
### Makeup shifter

## Install
<div align='center'>
<img src='./docs/imgs/makeup_shifter.png'width='700' height='250'/>
</div>

Please refer to [install](./docs/en_US/install.md).

## Quick Start
## Changelog

Get started through ppgan.app interface:
- v0.1.0 (2020.11.02)
- 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.

```python
from ppgan.apps import RealSRPredictor
sr = RealSRPredictor()
sr.run("docs/imgs/monarch.png")
```
## PaddleGAN Special Interest Group(SIG)

More tutorials:
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~

- [Data preparation](./docs/en_US/data_prepare.md)
- [Training/Evaluating/Testing basic usage](./docs/zh_CN/get_started.md)
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.

## Model Tutorial
We are continuing to recruit developers interested and capable to join us building this project and explore more useful and interesting applications together.

* [Pixel2Pixel](./docs/en_US/tutorials/pix2pix_cyclegan.md)
* [CycleGAN](./docs/en_US/tutorials/pix2pix_cyclegan.md)
* [PSGAN](./docs/en_US/tutorials/psgan.md)
* [First Order Motion Model](./docs/en_US/tutorials/motion_driving.md)
* [Video restore](./docs/zh_CN/tutorials/video_restore.md)
[PaddleGAN QQ Group:1058398620]

<div align='center'>
<img src='./docs/imgs/qq.png'width='250' height='300'/>
</div>

## Changelog

- v0.1.0 (2020.11.02)
- 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.

## Contributing

Expand Down
Binary file modified docs/imgs/color_sr_peking.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/imgs/makeup_shifter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/imgs/ppgan.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/qq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 83c1b7e

Please sign in to comment.