reading source code with woboq #1707

Yancey0623 · 2017-03-27T05:58:03Z

No description provided.

helinwang · 2017-03-27T21:23:45Z

paddle/scripts/docker/README.md

+- Build PaddlePaddle source code to be static files
+
+```bash
+docker run -v $PWD:/paddle -v $HOME/nginx_data:/usr/share/nginx/html/data -v $HOME/nginx_data/paddle:/usr/share/nginx/html/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=OFF" -e "RUN_TEST=OFF" -e "BUILD_WOBOQ=ON" paddle:dev


感觉应该让用户知道需要创建文件夹$HOME/nginx_data，以及这个指令会运行woboq将网页版代码生成到$HOME/nginx_data里面。

用户应该不需要手动创建$HOME/nginx_data，docker run会自动在本地创建这个目录，但确实应该指出来会创建这个目录。
Done.

wangkuiyi · 2017-03-28T02:40:16Z

paddle/scripts/docker/README.md

 ```
+
+### Reading source code with woboq codebrowser
+If you are interesting of PaddlePaddle source code, [Woboq codebrowser](https://github.com/woboq/woboq_codebrowser) is a suitable tool.


For developers who are interested in the C++ source code, please use -e "WOBOQ=ON" to enable building C++ source code into HTML pages using Woboq codebrowser

wangkuiyi · 2017-03-28T02:41:56Z

paddle/scripts/docker/README.md

+- Build PaddlePaddle source code to be static files
+
+```bash
+docker run -v $PWD:/paddle -v $HOME/nginx_data:/usr/share/nginx/html/data -v $HOME/nginx_data/paddle:/usr/share/nginx/html/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=OFF" -e "RUN_TEST=OFF" -e "BUILD_WOBOQ=ON" paddle:dev


这个例子里，需要提及 WITH_TEST 是不是因为这个决定过了unit test的源码是否被转换成HTML？我看了一下，woboq codebrowser是根据cmake的输出来知道如何build源码和转换源码的。

但是 RUN_TEST 是不是不必在这个例子里提及？

赞细致，Done.

wangkuiyi · 2017-03-28T02:42:12Z

paddle/scripts/docker/README.md

+- Build PaddlePaddle source code to be static files
+
+```bash
+docker run -v $PWD:/paddle -v $HOME/nginx_data:/usr/share/nginx/html/data -v $HOME/nginx_data/paddle:/usr/share/nginx/html/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=OFF" -e "RUN_TEST=OFF" -e "BUILD_WOBOQ=ON" paddle:dev


BUILD_WOBOQ => WOBOQ ?

wangkuiyi · 2017-03-28T02:44:09Z

paddle/scripts/docker/README.md

+- Build PaddlePaddle source code to be static files
+
+```bash
+docker run -v $PWD:/paddle -v $HOME/nginx_data:/usr/share/nginx/html/data -v $HOME/nginx_data/paddle:/usr/share/nginx/html/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=OFF" -e "RUN_TEST=OFF" -e "BUILD_WOBOQ=ON" paddle:dev


这里为什么需要制定 /usr/share/nginx/html/data 和同一个目录下的 paddle 两个子目录呢？是不是弄成 /woboq 就行了？

这里为什么要放在 /usr/share/nginx/html 里呢？这个是nginx的目录。但是development image里应该不需要有nginx？nginx如果需要应该放在doc image里？

/usr/share/nginx/html/data保存了一些js代码，paddle目录保存的是html代码，但确实在这个Image里确实只创建一个根目录的volume就好了，另外/woboq用来存在woboq源码了，所以目录改为/woboq_out, :)
Done.

wangkuiyi · 2017-03-28T19:02:56Z

paddle/scripts/docker/README.md

+### Reading source code with woboq codebrowser
+For developers who are interested in the C++ source code, please use -e "WOBOQ=ON" to enable building C++ source code into HTML pages using [Woboq codebrowser](https://github.com/woboq/woboq_codebrowser).
+
+- The following command will generate woboq HTML pages in a docker volume directory, `$HOME/nginx` directory will be created on your local disk when the build finishes.


这个目录和nginx其实没关系，名字也不应该是nginx。可以叫 woboq_out 什么的？

$HOME/nginx => $HOME/woboq_out
Done.

wangkuiyi · 2017-03-28T19:04:18Z

paddle/scripts/docker/README.md

+### Reading source code with woboq codebrowser
+For developers who are interested in the C++ source code, please use -e "WOBOQ=ON" to enable building C++ source code into HTML pages using [Woboq codebrowser](https://github.com/woboq/woboq_codebrowser).
+
+- The following command will generate woboq HTML pages in a docker volume directory, `$HOME/nginx` directory will be created on your local disk when the build finishes.


The following command builds PaddlePaddle, generates HTML pages from C++ source code, and writes HTML pages into $HOME/woboq_out on the host:

wangkuiyi · 2017-03-28T19:05:20Z

paddle/scripts/docker/README.md

+docker run -v $PWD:/paddle -v $HOME/nginx:/woboq_out -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=ON" -e "WOBOQ=ON" paddle:dev
+```
+
+- Open the generated static files in a browser, or upload these files to your web server. You can run nginx server as the following command, and then hit "http://<hostip>:8080/paddle" in browser.


You can open the generated HTML files in your Web browser. Or, if you want to run a Nginx container to serve them for a wider audience, you can run:

helinwang · 2017-04-03T21:51:10Z

Dockerfile


 # ENV variables
-ARG BUILD_WOBOQ
+ARG WOBOQ


这一行和16行貌似都不需要。因为
docker run -v $PWD:/paddle -v $HOME/woboq_out:/woboq_out -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=ON" -e "WOBOQ=ON" paddle:dev
好像并没有用到这个Dockerfile（这个Dockerfile是build paddle:dev的时候用到的。）

多谢 @helinwang , 第10行看起来确实不需要，不过对于第16行，因为docker run的时候会执行https://github.com/Yancey1989/Paddle/blob/woboq_view/paddle/scripts/docker/build.sh#L50，感觉这个环境变量写在Dockerfile里并赋初始值更符合用户习惯？

明白了。写在16行的ENV WOBOQ确实更能够表达意图，更符合用户习惯。是我疏忽了，谢谢提醒！👍

wangkuiyi

LGTM

With only a minor comment about English grammar.

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

paddle/scripts/docker/README.md

 ```
+
+### Reading source code with woboq codebrowser
+For developers who are interested in the C++ source code, please use -e "WOBOQ=ON" to enable building C++ source code into HTML pages using [Woboq codebrowser](https://github.com/woboq/woboq_codebrowser).


to enable building ==> to enable the building of

…addlePaddle#1707) * update solov2 some detail * fix check paddle version

reading source code with woboq

587a05e

helinwang reviewed Mar 27, 2017

View reviewed changes

wangkuiyi requested changes Mar 28, 2017

View reviewed changes

Yancey0623 added 3 commits March 28, 2017 14:16

update

35e0f97

update

95972aa

update

8b15be6

wangkuiyi requested changes Mar 28, 2017

View reviewed changes

update

82764fd

helinwang reviewed Apr 3, 2017

View reviewed changes

update

385614a

wangkuiyi approved these changes Apr 10, 2017

View reviewed changes

to enable building ==> to enable the building of

a073575

Yancey0623 merged commit caffcc8 into PaddlePaddle:develop Apr 11, 2017

Yancey0623 deleted the woboq_view branch April 11, 2017 17:30

heavengate pushed a commit to heavengate/Paddle that referenced this pull request Aug 16, 2021

update solov2 some detail & fix paddle.enable_static() check_version (P…

dd077f9

…addlePaddle#1707) * update solov2 some detail * fix check paddle version

reading source code with woboq #1707

reading source code with woboq #1707

Uh oh!

Conversation

Yancey0623 commented Mar 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangkuiyi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants