add a detailed Chinese google coding style for convenience

This commit is contained in:
Tongzheng Ren 2017-12-18 23:32:41 +08:00
parent d220f7f2a8
commit 27c1017259
3 changed files with 3 additions and 1 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

BIN
AlphaGo/.DS_Store vendored Normal file

Binary file not shown.

View File

@ -46,6 +46,8 @@ Tianshou(天授) is a reinforcement learning platform. The following image illus
Please follow [google python coding style](https://google.github.io/styleguide/pyguide.html)
There's a more detailed Chinese version [google python coding style in Chinese](http://www.runoob.com/w3cnote/google-python-styleguide.html)
All files/folders should be named with lower case letters and underline (except specified names such as `AlphaGo`).
Try to use full names. Don't use abbrevations for class/function/variable names except common abbrevations (such as `num` for number, `dim` for dimension, `env` for environment, `op` for operation). For now we use `pi` to refer to the policy in examples/ppo_example.py.
@ -73,4 +75,4 @@ HaoshengZou: collaborate mainly on Policy and losses; interfaces and architectur
Note: install openai/gym first to run the Atari environment; note that interfaces between modules may not be finalized; the management of placeholders and `feed_dict` may have to be done manually for the time being;
Without preprocessing and other tricks, this example will not train to any meaningful results. Codes should past two tests: individual module test and run through this example code.
Without preprocessing and other tricks, this example will not train to any meaningful results. Codes should past two tests: individual module test and run through this example code.