Skip to content

Commit dc420f9

Browse files
committed
Merge branch 'develop' into demo
2 parents 8ac9e9a + 44d4be6 commit dc420f9

File tree

17 files changed

+1275
-48
lines changed

17 files changed

+1275
-48
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ before_install:
5050
fi
5151
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo paddle/scripts/travis/before_install.linux.sh; fi
5252
- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then paddle/scripts/travis/before_install.osx.sh; fi
53-
- pip install wheel protobuf sphinx breathe recommonmark virtualenv numpy
53+
- pip install wheel protobuf sphinx breathe recommonmark virtualenv numpy sphinx_rtd_theme
5454
script:
5555
- paddle/scripts/travis/main.sh
5656
notifications:

doc/conf.py.in

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ AutoStructify = transform.AutoStructify
2323
# documentation root, use os.path.abspath to make it absolute, like shown here.
2424
sys.path.insert(0, '@PROJ_ROOT@/python')
2525

26-
templates_path = ["@PROJ_ROOT@/doc/templates"]
26+
templates_path = ["@PROJ_ROOT@/doc_theme/templates"]
2727

2828
# -- General configuration ------------------------------------------------
2929

@@ -113,13 +113,12 @@ todo_include_todos = False
113113

114114
# The theme to use for HTML and HTML Help pages. See the documentation for
115115
# a list of builtin themes.
116-
#html_theme = 'sphinx_rtd_theme'
117-
html_theme = 'classic'
116+
html_theme = 'sphinx_rtd_theme'
118117

119118
# Add any paths that contain custom static files (such as style sheets) here,
120119
# relative to this directory. They are copied after the builtin static files,
121120
# so a file named "default.css" will overwrite the builtin "default.css".
122-
html_static_path = ['_static']
121+
html_static_path = ['@PROJ_ROOT@/doc_theme/static']
123122

124123
# Output file base name for HTML help builder.
125124
htmlhelp_basename = project + 'doc'

doc/howto/cmd_parameter/arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ It looks like there are a lot of arguments. However, most of them are for develo
143143
</tr>
144144

145145
<tr>
146-
<td class="left" rowspan = "2">testing during training</td><td class="left">test_all_data_in_one_period</td>
146+
<td class="left" rowspan = "2">testing during training</td><td class="left">test_period</td>
147147
<td class="left">√</td><td class="left">√</td><td class="left"></td><td class="left"></td>
148148
</tr>
149149

doc/howto/cmd_parameter/detail_introduction.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
- type: string (default: null).
3232

3333
* `--version`
34-
- Whether to print version infomatrion.
34+
- Whether to print version information.
3535
- type: bool (default: 0).
3636

3737
* `--show_layer_stat`
@@ -110,8 +110,8 @@
110110
- type: int32 (default: -1).
111111

112112
* `--test_period`
113-
- Run testing every test_period train batches. If not set, run testing each pass.
114-
- type: int32 (default: 1000).
113+
- if equal 0, do test on all test data at the end of each pass. While if equal non-zero, do test on all test data every test_period batches.
114+
- type: int32 (default: 0).
115115

116116
* `--test_wait`
117117
- Whether to wait for parameter per pass if not exist. If set test_data_path in submitting environment of cluster, it will launch one process to perfom testing, so we need to set test_wait=1. Note that in the cluster submitting environment, this argument has been set True by default.
@@ -121,10 +121,6 @@
121121
- File that saves the model list when testing. It was set automatically when using cluster submitting environment after setting model_path.
122122
- type: string (default: "", null).
123123

124-
* `--test_all_data_in_one_period`
125-
- This argument is usually used in testing period during traning. If true, all data will be tested in one test period. Otherwise (batch_size * log_peroid) data will be tested.
126-
- type: bool (default: 0).
127-
128124
* `--predict_output_dir`
129125
- Directory that saves the layer output. It is configured in Outputs() in network config. Default, this argument is null, meaning save nothing. Specify this directory if you want to save feature map of some layers in testing mode. Note that, layer outputs are values after activation function.
130126
- type: string (default: "", null).

doc/howto/cmd_parameter/use_case.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ paddle train \
1010
--config=network_config \
1111
--save_dir=output \
1212
--trainer_count=COUNT \ #(default:1)
13-
--test_period=M \ #(default:1000)
14-
--test_all_data_in_one_period=true \ #(default:false)
15-
--num_passes=N \ #(defalut:100)
13+
--test_period=M \ #(default:0)
14+
--num_passes=N \ #(defalut:100)
1615
--log_period=K \ #(default:100)
1716
--dot_period=1000 \ #(default:1)
1817
#[--show_parameter_stats_period=100] \ #(default:0)

doc_cn/conf.py.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ AutoStructify = transform.AutoStructify
2222
# add these directories to sys.path here. If the directory is relative to the
2323
# documentation root, use os.path.abspath to make it absolute, like shown here.
2424
sys.path.insert(0, '@PROJ_ROOT@/python')
25-
templates_path = ["@PROJ_ROOT@/doc/templates"]
25+
templates_path = ["@PROJ_ROOT@/doc_theme/templates"]
2626

2727
# -- General configuration ------------------------------------------------
2828

@@ -112,12 +112,12 @@ todo_include_todos = False
112112

113113
# The theme to use for HTML and HTML Help pages. See the documentation for
114114
# a list of builtin themes.
115-
#html_theme = 'sphinx_rtd_theme' # sphinx_rtd_theme will cause table bad style
116-
html_theme = 'classic'
115+
html_theme = 'sphinx_rtd_theme'
116+
117117
# Add any paths that contain custom static files (such as style sheets) here,
118118
# relative to this directory. They are copied after the builtin static files,
119119
# so a file named "default.css" will overwrite the builtin "default.css".
120-
html_static_path = ['_static']
120+
html_static_path = ['@PROJ_ROOT@/doc_theme/static']
121121

122122
# Output file base name for HTML help builder.
123123
htmlhelp_basename = project + 'doc'

0 commit comments

Comments
 (0)