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

G
gangliao 已提交
3 4 5 6 7

[![Build Status](https://travis-ci.org/baidu/Paddle.svg?branch=master)](https://travis-ci.org/baidu/Paddle)
[![Coverage Status](https://coveralls.io/repos/github/baidu/Paddle/badge.svg?branch=develop)](https://coveralls.io/github/baidu/Paddle?branch=develop)
[![Join the chat at https://gitter.im/PaddlePaddle/Deep_Learning](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PaddlePaddle/Deep_Learning?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
E
emailweixu 已提交
8

G
gangliao 已提交
9
Welcome to the PaddlePaddle GitHub.
E
emailweixu 已提交
10

Z
zhangjinchao01 已提交
11 12 13 14 15
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 已提交
16 17 18
Our vision is to enable deep learning for everyone via PaddlePaddle.
Please refer to our [release log](https://github.com/baidu/Paddle/releases) to track the latest feature of PaddlePaddle. 

Z
zhangjinchao01 已提交
19 20 21 22
## Features

- **Flexibility**

G
gangliao 已提交
23 24 25 26
    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 已提交
27 28 29

-  **Efficiency**
  
G
gangliao 已提交
30 31 32 33 34 35 36 37 38 39 40
    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 已提交
41 42 43

- **Scalability**

G
gangliao 已提交
44 45 46
    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 已提交
47 48 49

- **Connected to Products**

G
gangliao 已提交
50 51 52 53 54 55 56
    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 已提交
57 58

## Installation
G
gangliao 已提交
59 60 61 62
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 已提交
63
## Documentation
G
gangliao 已提交
64
Both [English Docs](http://paddlepaddle.org/doc/) and [Chinese Docs](http://paddlepaddle.org/doc_cn/) are provided for our users and developers.
65

L
liaogang 已提交
66
- [Quick Start](http://paddlepaddle.org/doc/demo/quick_start/index_en) <br>
Z
zhangjinchao01 已提交
67 68 69
   You can follow the quick start tutorial to learn how use PaddlePaddle
   step-by-step.
    
70
- [Example and Demo](http://paddlepaddle.org/doc/demo/) <br>
Z
zhangjinchao01 已提交
71
   We provide five demos, including: image classification, sentiment analysis,
D
dangqingqing 已提交
72
   sequence to sequence model, recommendation, semantic role labeling. 
Z
zhangjinchao01 已提交
73
   
74
- [Distributed Training](http://paddlepaddle.org/doc/cluster) <br>
Z
zhangjinchao01 已提交
75 76 77
  This system supports training deep learning models on multiple machines
  with data parallelism.
   
78
- [Python API](http://paddlepaddle.org/doc/ui/) <br>
Z
zhangjinchao01 已提交
79 80 81 82 83
   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.
 
84 85
- [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 已提交
86 87
   contribute, please read the contribution guide.   

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

Z
zhangjinchao01 已提交
90
## Ask Questions
G
gangliao 已提交
91 92 93
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 已提交
94
bug reports are collected on [Issues](https://github.com/baidu/paddle/issues).
Z
zhangjinchao01 已提交
95 96 97

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