Contribute and logging #5181

wangkuiyi · 2017-10-27T23:21:16Z

This PR

moves the new content to be merged in Create vlog_guide.md #5121 into /CONTRIBUTE.md,
updates and merges content from doc/.../contribute_to_paddle_en.md into /CONTRIBUTE.md, and
removes doc/.../contribute_to_paddle_cn.md.

tonyyang-svail · 2017-10-27T23:31:41Z

CONTRIBUTING.md

+When we run a PaddlePaddle application or test, we can specify a verbose threshold.  For example:
+
+```bash
+GLOG_v=3 python ../python/paddle/v2/framework/tests/test_recurrent_op.py


add a module example GLOG_vmodule=buddy_allocator=2 GLOG_v=10 python ../python/paddle/v2/framework/tests/test_recurrent_op.py. This will set the vlog level of buddy_allocator to be 2 and the rest to be 10

reyoung · 2017-10-27T23:44:58Z

CONTRIBUTING.md

+| 1     | reserved                      |
+| 2     | DL model compilation, including the building of backward pass and adding optimizer, feed, init operators |
+| 3     | DL model execution.  For example, in operators |
+| 4     | More detailed information than above. |


Maybe the simplest way to define the max level of the vlog is corresponding with our namespace.

framework should use VLOG(1) as its highest VLOG level. Since the framework is our core code. VLOG(2) and VLOG(3) could be used in framework for unimportant logs.

operators should use VLOG(3) as its highest VLOG level, since it is the middle level of our framework. operators will invoke platform, memories, eigen, etc.

platform, memory should use VLOG(5) as their highest VLOG level, since they are usually invoked at the end our code.

namespace max vlog level

framework 1

operators 3

memory/platform 5

luotao1

removes doc/.../contribute_to_paddle_cn.md.

cn ->en ?

After this PR, should we update the contribute_to_paddle_cn.md?
In contribute_to_paddle_cn, 提交代码的一些约定 is not in contribute_to_paddle_en.md now. Should this PR add these?

luotao1 · 2017-10-28T02:29:08Z

CONTRIBUTING.md

+
+1. Build and test
+
+   Users can build PaddlePaddle natively on Linux and Mac OS X.  But to unify the building environment and to make it easy for debugging, the recommended way is [using Docker](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/howto/dev/contribute_to_paddle_en.md).


Is the URL of using Docker correct?

Corrected it to be (https://github.com/PaddlePaddle/Paddle/blob/develop/doc/howto/dev/build_en.md).

It is not. Thanks for pointing out. I am correcting it.

luotao1 · 2017-10-28T02:30:45Z

doc/howto/dev/contribute_to_paddle_en.md

-clang-formater.......................................(no files to check)Skipped
-[my-cool-stuff c703c041] add test file
- 1 file changed, 0 insertions(+), 0 deletions(-)
- create mode 100644 233


Can we remain the result of git commit? Maybe this result is useful for new developers since they can confirm their pre-commit run successfully.

luotao1 · 2017-10-28T02:33:16Z

doc/howto/dev/contribute_to_paddle_en.md

- Make sure the compiler option `WITH_STYLE_CHECK` is on and the compiler
-  passes the code style check.
- All code must have unit test.
- Pass all unit tests.


Can we remain these Code Requirements?

Good idea. I moving it after the Workflow section, as the Code Standard section.

wangkuiyi

I removed the Chinese version of this document because I noticed that we haven't been able to keep the Chinese and English version consistent with each other.

In contribute_to_paddle_cn, 提交代码的一些约定 is not in contribute_to_paddle_en.md now. Should this PR add these?

Actually, I translated this part but scattered the information around various parts of the new English version.

wangkuiyi · 2017-10-29T18:20:26Z

doc/howto/dev/contribute_to_paddle_en.md

- Make sure the compiler option `WITH_STYLE_CHECK` is on and the compiler
-  passes the code style check.
- All code must have unit test.
- Pass all unit tests.


Good idea. I moving it after the Workflow section, as the Code Standard section.

wangkuiyi · 2017-10-29T18:41:43Z

CONTRIBUTING.md

+
+1. Build and test
+
+   Users can build PaddlePaddle natively on Linux and Mac OS X.  But to unify the building environment and to make it easy for debugging, the recommended way is [using Docker](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/howto/dev/contribute_to_paddle_en.md).


It is not. Thanks for pointing out. I am correcting it.

wangkuiyi · 2017-10-29T18:48:41Z

doc/howto/dev/contribute_to_paddle_en.md

-clang-formater.......................................(no files to check)Skipped
-[my-cool-stuff c703c041] add test file
- 1 file changed, 0 insertions(+), 0 deletions(-)
- create mode 100644 233


… contribute_and_logging

luotao1

LGTM

luotao1 · 2017-10-30T09:16:24Z

If we put contributed.md out of doc/, we can't show it in current website. Shall we have a special link for this contributed.md ? @jetfuel
I removed the Chinese version of this document

This PR doesn't remove the Chinese version, should we update the Chinese version later?
We should remove the corresponding links in index_cn.rst and index_en.rst.

Yang Yang(Tony) and others added 2 commits October 25, 2017 23:14

Create vlog_guide.md

efed904

Move design/vlog_guide.md into CONTRIBUTE.md

e2ac0ae

wangkuiyi requested review from luotao1, reyoung and tonyyang-svail October 27, 2017 23:21

tonyyang-svail reviewed Oct 27, 2017

View reviewed changes

reyoung reviewed Oct 27, 2017

View reviewed changes

In response to comments from Yu Yang and Tony

307c28c

luotao1 reviewed Oct 28, 2017

View reviewed changes

In response to comments from Luo Tao

439bf2f

wangkuiyi commented Oct 29, 2017

View reviewed changes

Merge branch 'develop' of https://github.com/paddlepaddle/paddle into…

88e9607

… contribute_and_logging

luotao1 approved these changes Oct 30, 2017

View reviewed changes

wangkuiyi merged commit 6c8dce9 into PaddlePaddle:develop Oct 30, 2017

wangkuiyi mentioned this pull request Oct 30, 2017

Update index_cn.rst and index_en.rst with the change to CONTRIBUTION.md #5215

Closed

dzhwinter mentioned this pull request Mar 19, 2018

Enable P2P memory copy #9190

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contribute and logging #5181

Contribute and logging #5181

wangkuiyi commented Oct 27, 2017

tonyyang-svail Oct 27, 2017

wangkuiyi Oct 28, 2017

reyoung Oct 27, 2017

wangkuiyi Oct 28, 2017

luotao1 left a comment •

edited

Loading

luotao1 Oct 28, 2017

wangkuiyi Oct 29, 2017 •

edited

Loading

wangkuiyi Oct 29, 2017

luotao1 Oct 28, 2017

wangkuiyi Oct 29, 2017

luotao1 Oct 28, 2017

wangkuiyi Oct 29, 2017

wangkuiyi left a comment

wangkuiyi Oct 29, 2017

wangkuiyi Oct 29, 2017

wangkuiyi Oct 29, 2017

luotao1 left a comment

luotao1 commented Oct 30, 2017


		1. Build and test

		Users can build PaddlePaddle natively on Linux and Mac OS X. But to unify the building environment and to make it easy for debugging, the recommended way is [using Docker](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/howto/dev/contribute_to_paddle_en.md).

Contribute and logging #5181

Contribute and logging #5181

Conversation

wangkuiyi commented Oct 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luotao1 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangkuiyi Oct 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangkuiyi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luotao1 left a comment

Choose a reason for hiding this comment

luotao1 commented Oct 30, 2017

luotao1 left a comment •

edited

Loading

wangkuiyi Oct 29, 2017 •

edited

Loading