PaddlePaddle adheres to the following three sections of code and document specifications.
PaddlePaddle uses git for version control and Docker is used for building and testing environment. The code includes Cuda, C++, Python, Shell and other programming languages,which comply with Google C++ Style, Pep-8, and the code base includes style checking by an automatic inspection tool. Code comments need to follow the Doxygen specification. The code that does not meet the style requirements will fail to compile. We provide the following guidelines for the use of Git, build tests and code development.
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
contribute_to_paddle_en.md
contribute_to_paddle_en.md
PaddlePaddle is well documented in English and Chinese. We recommend using the English version of the documents and problem description. The design documents focus on problem descriptions, backgrounds, and are followed by solutions. As documents are generated by Sphinx, code comments should comply with the Sphinx documentation standard. We recommend to use the paddlepaddle.org tool to compile and generate and preview documents locally. Please refer to:
.. toctree::
:maxdepth: 1
write_docs_en.rst
write_docs_en.rst
PaddlePaddle V2 defines new operations by adding new Layers. You can implement various complex layers by combining basic APIs to satisfy most applications. If you want to customize layer, please refer to the following, and welcome to propose patch.
@@ -6,32 +6,32 @@ PaddlePaddle provides the users the ability to flexibly set various command line
...
@@ -6,32 +6,32 @@ PaddlePaddle provides the users the ability to flexibly set various command line
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
cmd_parameter/index_cn.rst
cmd_parameter/index_en.rst
PaddlePaddle supports distributed training tasks on fabric clusters, MPI clusters, and Kubernetes clusters. For detailed configuration and usage instructions, refer to:
PaddlePaddle supports distributed training tasks on fabric clusters, MPI clusters, and Kubernetes clusters. For detailed configuration and usage instructions, refer to:
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
cluster/index_cn.rst
cluster/index_en.rst
PaddlePaddle provides a C-API for inference. We provide the following guidelines for using the C-API:
PaddlePaddle provides a C-API for inference. We provide the following guidelines for using the C-API:
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
capi/index_cn.rst
capi/index_en.rst
PaddlePaddle supports a variety of flexible and efficient recurrent neural networks. For details, please refer to:
PaddlePaddle supports a variety of flexible and efficient recurrent neural networks. For details, please refer to:
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
rnn/index_cn.rst
rnn/index_en.rst
How to use the built-in timing tool, nvprof, or nvvp to run performance analysis and tuning, please refer to:
How to use the built-in timing tool, nvprof, or nvvp to run performance analysis and tuning, please refer to: