README.md 4.8 KB
Newer Older
Z
zhangjinchao01 已提交
1 2
# PaddlePaddle

G
gangliao 已提交
3

L
liaogang 已提交
4
[![Build Status](https://travis-ci.org/PaddlePaddle/Paddle.svg?branch=develop)](https://travis-ci.org/baidu/Paddle)
L
liaogang 已提交
5
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://www.paddlepaddle.org/)
L
liaogang 已提交
6
[![Documentation Status](https://img.shields.io/badge/中文文档-最新-brightgreen.svg)](http://www.paddlepaddle.org/cn/index.html)
L
liaogang 已提交
7 8
[![Coverage Status](https://coveralls.io/repos/github/PaddlePaddle/Paddle/badge.svg?branch=develop)](https://coveralls.io/github/baidu/Paddle?branch=develop)
[![Release](https://img.shields.io/github/release/baidu/Paddle.svg?colorB=fedcba)](https://github.com/baidu/Paddle/releases)
L
liaogang 已提交
9 10
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)

E
emailweixu 已提交
11

G
gangliao 已提交
12
Welcome to the PaddlePaddle GitHub.
Z
zhangjinchao01 已提交
13 14 15 16 17
PaddlePaddle (PArallel Distributed Deep LEarning) is an easy-to-use,
efficient, flexible and scalable deep learning platform, which is originally
developed by Baidu scientists and engineers for the purpose of applying deep
learning to many products at Baidu.

G
gangliao 已提交
18
Our vision is to enable deep learning for everyone via PaddlePaddle.
19
Please refer to our [release announcement](https://github.com/baidu/Paddle/releases) to track the latest feature of PaddlePaddle. 
G
gangliao 已提交
20

Z
zhangjinchao01 已提交
21 22 23 24
## Features

- **Flexibility**

G
gangliao 已提交
25 26 27 28
    PaddlePaddle supports a wide range of neural network architectures and
    optimization algorithms. It is easy to configure complex models such as
    neural machine translation model with attention mechanism or complex memory
    connection.
Z
zhangjinchao01 已提交
29 30 31

-  **Efficiency**
  
G
gangliao 已提交
32 33 34 35 36 37 38 39 40 41 42
    In order to unleash the power of heterogeneous computing resource,
    optimization occurs at different levels of PaddlePaddle, including
    computing, memory, architecture and communication. The following are some
    examples:

      - Optimized math operations through SSE/AVX intrinsics, BLAS libraries
      (e.g. MKL, ATLAS, cuBLAS) or customized CPU/GPU kernels. 
      - Highly optimized recurrent networks which can handle **variable-length** 
      sequence without padding.
      - Optimized local and distributed training for models with high dimensional
      sparse data.
Z
zhangjinchao01 已提交
43 44 45

- **Scalability**

G
gangliao 已提交
46 47 48
    With PaddlePaddle, it is easy to use many CPUs/GPUs and machines to speed
    up your training. PaddlePaddle can achieve high throughput and performance
    via optimized communication.
Z
zhangjinchao01 已提交
49 50 51

- **Connected to Products**

G
gangliao 已提交
52 53 54 55 56 57 58
    In addition, PaddlePaddle is also designed to be easily deployable. At Baidu,
    PaddlePaddle has been deployed into products or service with a vast number
    of users, including ad click-through rate (CTR) prediction, large-scale image
    classification, optical character recognition(OCR), search ranking, computer
    virus detection, recommendation, etc. It is widely utilized in products at
    Baidu and it has achieved a significant impact. We hope you can also exploit
    the capability of PaddlePaddle to make a huge impact for your product.
Z
zhangjinchao01 已提交
59 60

## Installation
G
gangliao 已提交
61 62 63 64
Check out the [Install Guide](http://paddlepaddle.org/doc/build/) to install from
pre-built packages (**docker image**, **deb package**) or 
directly build on **Linux** and **Mac OS X** from the source code.
 
Z
zhangjinchao01 已提交
65
## Documentation
G
gangliao 已提交
66
Both [English Docs](http://paddlepaddle.org/doc/) and [Chinese Docs](http://paddlepaddle.org/doc_cn/) are provided for our users and developers.
67

L
liaogang 已提交
68
- [Quick Start](http://paddlepaddle.org/doc/demo/quick_start/index_en) <br>
Z
zhangjinchao01 已提交
69 70 71
   You can follow the quick start tutorial to learn how use PaddlePaddle
   step-by-step.
    
72
- [Example and Demo](http://paddlepaddle.org/doc/demo/) <br>
Z
zhangjinchao01 已提交
73
   We provide five demos, including: image classification, sentiment analysis,
D
dangqingqing 已提交
74
   sequence to sequence model, recommendation, semantic role labeling. 
Z
zhangjinchao01 已提交
75
   
76
- [Distributed Training](http://paddlepaddle.org/doc/cluster) <br>
Z
zhangjinchao01 已提交
77 78 79
  This system supports training deep learning models on multiple machines
  with data parallelism.
   
80
- [Python API](http://paddlepaddle.org/doc/ui/) <br>
Z
zhangjinchao01 已提交
81 82 83 84 85
   PaddlePaddle supports using either Python interface or C++ to build your
   system. We also use SWIG to wrap C++ source code to create a user friendly
   interface for Python. You can also use SWIG to create interface for your
   favorite programming language.
 
86 87
- [How to Contribute](http://paddlepaddle.org/doc/build/contribute_to_paddle.html) <br>
   We sincerely appreciate your interest and contributions. If you would like to
Z
zhangjinchao01 已提交
88 89
   contribute, please read the contribution guide.   

90 91
- [Source Code Documents](http://paddlepaddle.org/doc/source/) <br>

Z
zhangjinchao01 已提交
92
## Ask Questions
G
gangliao 已提交
93 94 95
Please join the [**gitter chat**](https://gitter.im/PaddlePaddle/Deep_Learning) or send email to
**paddle-dev@baidu.com** to ask questions and talk about methods and models.
Framework development discussions and
Y
yuyang18 已提交
96
bug reports are collected on [Issues](https://github.com/baidu/paddle/issues).
Z
zhangjinchao01 已提交
97 98 99

## Copyright and License
PaddlePaddle is provided under the [Apache-2.0 license](LICENSE).