From ee4734594fc4e9ac04ad0196421379925a543f13 Mon Sep 17 00:00:00 2001 From: xuwei06 Date: Tue, 30 Aug 2016 07:01:36 +0000 Subject: [PATCH] Update README.md and remove internl doc links ISSUE=4586877 git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1421 1ad973e4-5ce8-4261-8a94-b56d1f490c56 --- README.md | 23 +++++++++++------------ doc/build/index.rst | 1 - doc/cluster/index.rst | 1 - doc_cn/ui/index.rst | 2 +- 4 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e7d337866c4..1a557c4504d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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]()
+- [Chinese Documentation](http://paddlepaddle.org/doc_cn/)
+ +- [Quick Start](http://paddlepaddle.org/doc/demo/quick_start/)
You can follow the quick start tutorial to learn how use PaddlePaddle step-by-step. -- [Example and Demo]()
+- [Example and Demo](http://paddlepaddle.org/doc/demo/)
We provide five demos, including: image classification, sentiment analysis, sequence to sequence model, recommendation, semantic role labelling. -- [Distributed Training]()
+- [Distributed Training](http://paddlepaddle.org/doc/cluster)
This system supports training deep learning models on multiple machines with data parallelism. -- [Python API]()
+- [Python API](http://paddlepaddle.org/doc/ui/)
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]()
- We sincerely appreciate your interest and contributions. If you’d like to +- [How to Contribute](http://paddlepaddle.org/doc/build/contribute_to_paddle.html)
+ We sincerely appreciate your interest and contributions. If you would like to contribute, please read the contribution guide. -- [Source Code Documents]()
- +- [Source Code Documents](http://paddlepaddle.org/doc/source/)
+ ## Ask Questions If you want to ask questions and discuss about methods and models, welcome diff --git a/doc/build/index.rst b/doc/build/index.rst index 57d3d3bfc4d..211e3bb1aea 100644 --- a/doc/build/index.rst +++ b/doc/build/index.rst @@ -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 diff --git a/doc/cluster/index.rst b/doc/cluster/index.rst index 942248665cb..cf1ea977154 100644 --- a/doc/cluster/index.rst +++ b/doc/cluster/index.rst @@ -4,5 +4,4 @@ Cluster Train .. toctree:: :glob: - internal/index.md opensource/cluster_train.md diff --git a/doc_cn/ui/index.rst b/doc_cn/ui/index.rst index 3a0f1e2dc30..06566539867 100644 --- a/doc_cn/ui/index.rst +++ b/doc_cn/ui/index.rst @@ -13,7 +13,7 @@ TBD API参考 ======= -TBD +`Trainer Config Helper `_ 命令行参数 ========== -- GitLab