Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index_en.rst #9321

Merged
merged 2 commits into from
Mar 26, 2018
Merged

Update index_en.rst #9321

merged 2 commits into from
Mar 26, 2018

Conversation

legend06hvl
Copy link
Contributor

@legend06hvl legend06hvl commented Mar 22, 2018

New file
fix #8920

@shanyi15 shanyi15 self-requested a review March 22, 2018 08:32
Copy link
Contributor

@abhinavarora abhinavarora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR. There are some suggestions. Please look into them before merging.

PaddlePaddle adheres to the following three sections of code and document specifications.


PaddlePaddle uses git for version management 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, and if code that does not meet the style requirements will fail to compile with. we provide the following guidelines for the use of git, build tests and code development.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version management -> version control

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker -> Docker

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doxygen specification, and if code that does not meet the style requirements will fail to compile with. -> Doxygen specification. The code that does not meet the style requirements will fail to compile.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we provide the -> We provide the

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git -> Git

contribute_to_paddle_cn.md


PaddlePaddle is suitable for domestic and foreign users, including Chinese and English documents. We recommend the English version of design documents and problem descriptions. The design documents focus on problem descriptions, backgrounds, and followed by solutions. As documents are generated by Sphinx, code comments should comply with the Sphinx document standard. We recommend to use the paddlepaddle.org tool to compile and generate and preview documents locally. Please refer to:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not suggest to write the first sentence. The sentence makes PaddlePaddle sound like a localized project. We should instead write something like this:

PaddlePaddle is well documented in English and Chinese. We recommend using the English version of the documents and problem description.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The design documents focus on problem descriptions, backgrounds, and followed by solutions. -> The design documents focus on problem descriptions, backgrounds and are followed by solutions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx document standard -> Sphinx documentation standard

.. toctree::
:maxdepth: 1

write_docs_cn.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be write_docs_en.rst

.. toctree::
:maxdepth: 1

contribute_to_paddle_cn.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be contribute_to_paddle_en.md

contribute_to_paddle_en.md
write_docs_en.rst
new_layer_en.rst
new_layer_cn.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be new_layer_en.rst


write_docs_cn.rst

PaddlePaddle V2 defines new operations by adding new Layer. 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new Layer -> new layers.

Fix refer to suggestions
@abhinavarora abhinavarora merged commit 6a97c02 into PaddlePaddle:develop Mar 26, 2018
@shanyi15
Copy link
Collaborator

Thank you so much for the review! @abhinavarora

blacksheep-Aristotle pushed a commit to blacksheep-Aristotle/Paddle that referenced this pull request Nov 22, 2024
…save_info.json location (PaddlePaddle#9321)

* [Unified checkpoint] update optimizer async save signal

* update async_save_info.json file place
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Translation Plan-开发标准-汉译英-概述
3 participants