Skip to content

Commit 0def593

Browse files
authored
Update doc for 2.0 API and some callback (#31180) (#31189)
test=document_fix
1 parent 5bd7c82 commit 0def593

File tree

2 files changed

+27
-21
lines changed

2 files changed

+27
-21
lines changed

python/paddle/fluid/layers/detection.py

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2214,17 +2214,18 @@ def multi_box_head(inputs,
22142214
Examples 1: set min_ratio and max_ratio:
22152215
.. code-block:: python
22162216
2217-
import paddle.fluid as fluid
2217+
import paddle
2218+
paddle.enable_static()
22182219
2219-
images = fluid.data(name='data', shape=[None, 3, 300, 300], dtype='float32')
2220-
conv1 = fluid.data(name='conv1', shape=[None, 512, 19, 19], dtype='float32')
2221-
conv2 = fluid.data(name='conv2', shape=[None, 1024, 10, 10], dtype='float32')
2222-
conv3 = fluid.data(name='conv3', shape=[None, 512, 5, 5], dtype='float32')
2223-
conv4 = fluid.data(name='conv4', shape=[None, 256, 3, 3], dtype='float32')
2224-
conv5 = fluid.data(name='conv5', shape=[None, 256, 2, 2], dtype='float32')
2225-
conv6 = fluid.data(name='conv6', shape=[None, 128, 1, 1], dtype='float32')
2220+
images = paddle.static.data(name='data', shape=[None, 3, 300, 300], dtype='float32')
2221+
conv1 = paddle.static.data(name='conv1', shape=[None, 512, 19, 19], dtype='float32')
2222+
conv2 = paddle.static.data(name='conv2', shape=[None, 1024, 10, 10], dtype='float32')
2223+
conv3 = paddle.static.data(name='conv3', shape=[None, 512, 5, 5], dtype='float32')
2224+
conv4 = paddle.static.data(name='conv4', shape=[None, 256, 3, 3], dtype='float32')
2225+
conv5 = paddle.static.data(name='conv5', shape=[None, 256, 2, 2], dtype='float32')
2226+
conv6 = paddle.static.data(name='conv6', shape=[None, 128, 1, 1], dtype='float32')
22262227
2227-
mbox_locs, mbox_confs, box, var = fluid.layers.multi_box_head(
2228+
mbox_locs, mbox_confs, box, var = paddle.static.nn.multi_box_head(
22282229
inputs=[conv1, conv2, conv3, conv4, conv5, conv6],
22292230
image=images,
22302231
num_classes=21,
@@ -2239,17 +2240,18 @@ def multi_box_head(inputs,
22392240
Examples 2: set min_sizes and max_sizes:
22402241
.. code-block:: python
22412242
2242-
import paddle.fluid as fluid
2243+
import paddle
2244+
paddle.enable_static()
22432245
2244-
images = fluid.data(name='data', shape=[None, 3, 300, 300], dtype='float32')
2245-
conv1 = fluid.data(name='conv1', shape=[None, 512, 19, 19], dtype='float32')
2246-
conv2 = fluid.data(name='conv2', shape=[None, 1024, 10, 10], dtype='float32')
2247-
conv3 = fluid.data(name='conv3', shape=[None, 512, 5, 5], dtype='float32')
2248-
conv4 = fluid.data(name='conv4', shape=[None, 256, 3, 3], dtype='float32')
2249-
conv5 = fluid.data(name='conv5', shape=[None, 256, 2, 2], dtype='float32')
2250-
conv6 = fluid.data(name='conv6', shape=[None, 128, 1, 1], dtype='float32')
2246+
images = paddle.static.data(name='data', shape=[None, 3, 300, 300], dtype='float32')
2247+
conv1 = paddle.static.data(name='conv1', shape=[None, 512, 19, 19], dtype='float32')
2248+
conv2 = paddle.static.data(name='conv2', shape=[None, 1024, 10, 10], dtype='float32')
2249+
conv3 = paddle.static.data(name='conv3', shape=[None, 512, 5, 5], dtype='float32')
2250+
conv4 = paddle.static.data(name='conv4', shape=[None, 256, 3, 3], dtype='float32')
2251+
conv5 = paddle.static.data(name='conv5', shape=[None, 256, 2, 2], dtype='float32')
2252+
conv6 = paddle.static.data(name='conv6', shape=[None, 128, 1, 1], dtype='float32')
22512253
2252-
mbox_locs, mbox_confs, box, var = fluid.layers.multi_box_head(
2254+
mbox_locs, mbox_confs, box, var = paddle.static.nn.multi_box_head(
22532255
inputs=[conv1, conv2, conv3, conv4, conv5, conv6],
22542256
image=images,
22552257
num_classes=21,

python/paddle/hapi/callbacks.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,13 +298,15 @@ def on_predict_batch_end(self, step, logs=None):
298298

299299
class ProgBarLogger(Callback):
300300
"""
301-
Logger callback function.
301+
Logger callback function to print loss and metrics to stdout. It supports
302+
silent mode (not print), progress bar or one line per each printing,
303+
see arguments for more detailed.
302304
303305
Args:
304306
log_freq (int): The frequency, in number of steps,
305307
the logs such as loss, metrics are printed. Default: 1.
306308
verbose (int): The verbosity mode, should be 0, 1, or 2.
307-
0 = silent, 1 = progress bar, 2 = one line per epoch, 3 = 2 +
309+
0 = silent, 1 = progress bar, 2 = one line each printing, 3 = 2 +
308310
time counter, such as average reader cost, samples per second.
309311
Default: 2.
310312
@@ -531,7 +533,9 @@ def on_predict_end(self, logs=None):
531533

532534
class ModelCheckpoint(Callback):
533535
"""
534-
Model checkpoint callback function.
536+
Model checkpoint callback function to save model weights and optimizer
537+
state during training in conjunction with model.fit(). Currently,
538+
ModelCheckpoint only supports saving after a fixed number of epochs.
535539
536540
Args:
537541
save_freq(int): The frequency, in number of epochs, the model checkpoint

0 commit comments

Comments
 (0)