提交 b282caf4 编写于 作者: Q qijun

Merge remote-tracking branch 'baidu/develop' into feature/sppnet

###############################
如何贡献/修改PaddlePaddle的文档
###############################
PaddlePaddle的文档使用 `cmake`_ 驱动 `sphinx`_ 生成。公有两个文档,:code:`doc` 和 :code:`doc_cn` 。这两者会在 `cmake`_ 中进行编译,生成后的文档会存储在服务器的 :code:`doc` 和 :code:`doc_cn` 两个目录下。
下面分几个部分介绍一下PaddlePaddle文档的贡献方法。
如何书写PaddlePaddle的文档
==========================
TBD
如何构建PaddlePaddle的文档
==========================
构建PaddlePaddle文档,需要使用构建Paddle的全部环境。准备这个环境相对来说比较复杂,所以本文档提供两种方式构建PaddlePaddle的文档,即
* 使用Docker构建PaddlePaddle的文档
* 直接构建PaddlePaddle的文档。
并且,我们推荐使用Docker来构建PaddlePaddle的文档。
使用Docker构建PaddlePaddle的文档
--------------------------------
使用Docker构建PaddlePaddle的文档,首先要求在系统里安装好Docker工具包。安装Docker请参考 `Docker的官网 <https://docs.docker.com/>`_ 。
安装好Docker之后可以使用源码目录下的脚本构建文档,即
.. code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
cd paddle/scripts/tools/build_docs
bash build_docs.sh
执行完这个脚本后,该目录下会生成两个目录,分别是\:
* doc 目录,英文文档地址
* doc_cn 目录,中文文档地址
打开浏览器访问对应目录下的index.html即可访问本地文档。
.. code-block:: bash
open doc_cn/index.html
直接构建PaddlePaddle的文档
--------------------------
TBD
如何更新www.paddlepaddle.org文档
================================
TBD
.. _cmake: https://cmake.org/
.. _sphinx: http://www.sphinx-doc.org/en/1.4.8/
\ No newline at end of file
...@@ -15,6 +15,7 @@ PaddlePaddle文档 ...@@ -15,6 +15,7 @@ PaddlePaddle文档
开发指南 开发指南
-------- --------
* `新写Layer <../doc/dev/new_layer/index.html>`_ * `新写Layer <../doc/dev/new_layer/index.html>`_
* `如何贡献文档 <howto/how_to_write_docs/index.html>`_
算法教程 算法教程
-------- --------
......
...@@ -35,8 +35,8 @@ bool CudnnConvLayer::init(const LayerMap &layerMap, ...@@ -35,8 +35,8 @@ bool CudnnConvLayer::init(const LayerMap &layerMap,
ProjectionConfig* conf = new ProjectionConfig(); ProjectionConfig* conf = new ProjectionConfig();
conf->set_type("conv"); conf->set_type("conv");
conf->set_num_filters(numFilters_); conf->set_num_filters(numFilters_);
conf->set_allocated_conv_conf( ConvConfig* convConf = conf->mutable_conv_conf();
config_.mutable_inputs(i)->mutable_conv_conf()); *convConf = *(config_.mutable_inputs(i)->mutable_conv_conf());
conf->set_input_size(getPrev(i)->getSize()); conf->set_input_size(getPrev(i)->getSize());
conf->set_output_size(getSize()); conf->set_output_size(getSize());
projConf_.emplace_back(conf); projConf_.emplace_back(conf);
......
FROM paddledev/paddle:cpu-devel-latest
COPY build.sh /
RUN pip install sphinx &&\
apt install -y doxygen graphviz &&\
pip install breathe recommonmark numpy protobuf==2.6.1
CMD /build.sh
#!/bin/bash
set -ex
mkdir -p /build
cd /build
cmake /paddle -DWITH_DOC=ON
make paddle_docs paddle_docs_cn -j `nproc`
mkdir -p /output/doc
mkdir -p /output/doc_cn
cp -r doc/html/* /output/doc/
cp -r doc_cn/html/* /output/doc_cn/
cd /
rm -rf /paddle/build
#!/bin/bash
set -e
docker build . -t paddle_build_doc
docker run --rm -v $PWD/../../../../:/paddle -v $PWD:/output paddle_build_doc
...@@ -116,6 +116,7 @@ void Tester::testOnePeriod() { ...@@ -116,6 +116,7 @@ void Tester::testOnePeriod() {
} }
testOneDataBatch(dataBatch, &outArgs); testOneDataBatch(dataBatch, &outArgs);
} }
finishTestPeriod();
} }
void Tester::finishTestPeriod() { void Tester::finishTestPeriod() {
......
...@@ -394,6 +394,15 @@ sinclude(`ModelConfigLayer.proto.m4') ...@@ -394,6 +394,15 @@ sinclude(`ModelConfigLayer.proto.m4')
// bias size // bias size
optional uint32 bias_size = 48 [default = 0]; optional uint32 bias_size = 48 [default = 0];
// this parameter can be used as a user-defined parameter when necessary,
// without changing the proto file.
// e.g., when a new layer with a user-defined parameter is implemented,
// it can be used to pass that parameter, without modifying the proto file.
// string type is used for flexibility: different types can be converted
// to string and reinterpreted in the user's own layer implementation.
optional string user_arg = 49;
} }
message EvaluatorConfig { message EvaluatorConfig {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册