index_en.rst 1.5 KB
Newer Older
L
Luo Tao 已提交
1 2 3
Development
------------

L
legend06hvl 已提交
4 5 6 7 8

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.
L
Luo Tao 已提交
9 10 11 12
..  toctree::
  :maxdepth: 1

  contribute_to_paddle_en.md
L
legend06hvl 已提交
13 14 15 16 17 18 19


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

L
Luo Tao 已提交
20
  write_docs_en.rst
L
legend06hvl 已提交
21 22 23 24 25 26

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.

..  toctree::
  :maxdepth: 1

L
Luo Tao 已提交
27
  new_layer_en.rst