Skip to content

Commit

Permalink
Update README.md and remove internl doc links
Browse files Browse the repository at this point in the history
ISSUE=4586877

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1421 1ad973e4-5ce8-4261-8a94-b56d1f490c56
  • Loading branch information
xuwei06 committed Aug 30, 2016
1 parent e6dfcdd commit ee47345
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 15 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# PaddlePaddle

[![Documentation Status](https://readthedocs.org/projects/ctcspeechrecognition/badge/?version=latest)](http://ctcspeechrecognition.readthedocs.io/en/latest/?badge=latest)

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
Expand Down Expand Up @@ -46,34 +44,35 @@ learning to many products at Baidu.
the capability of PaddlePaddle to make a huge impact for your product.

## Installation
See [installation guide]() to build and install from the source code or install
the Docker Image.
See [Installation Guide](http://paddlepaddle.org/doc/build/) to install from pre-built package or build from the source code.

## Documentation
- [Quick Start]() <br>
- [Chinese Documentation](http://paddlepaddle.org/doc_cn/) <br>

- [Quick Start](http://paddlepaddle.org/doc/demo/quick_start/) <br>
You can follow the quick start tutorial to learn how use PaddlePaddle
step-by-step.

- [Example and Demo]() <br>
- [Example and Demo](http://paddlepaddle.org/doc/demo/) <br>
We provide five demos, including: image classification, sentiment analysis,
sequence to sequence model, recommendation, semantic role labelling.

- [Distributed Training]() <br>
- [Distributed Training](http://paddlepaddle.org/doc/cluster) <br>
This system supports training deep learning models on multiple machines
with data parallelism.

- [Python API]() <br>
- [Python API](http://paddlepaddle.org/doc/ui/) <br>
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.

- [How to Contribute]() <br>
We sincerely appreciate your interest and contributions. If you’d like to
- [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
contribute, please read the contribution guide.

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

## Ask Questions

If you want to ask questions and discuss about methods and models, welcome
Expand Down
1 change: 0 additions & 1 deletion doc/build/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ If you want to hack and contribute PaddlePaddle source code, following guides ca
:glob:

build_from_source.md
internal/contribute_code.md
contribute_to_paddle.md

Build Docker Images
Expand Down
1 change: 0 additions & 1 deletion doc/cluster/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Cluster Train
.. toctree::
:glob:

internal/index.md
opensource/cluster_train.md
2 changes: 1 addition & 1 deletion doc_cn/ui/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TBD
API参考
=======

TBD
`Trainer Config Helper <http://paddlepaddle.org/doc/ui/api/trainer_config_helpers/index.html>`_

命令行参数
==========
Expand Down

0 comments on commit ee47345

Please sign in to comment.