Skip to content

Commit 4649f66

Browse files
committed
Follow comments & polish doc
1 parent 9942a30 commit 4649f66

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

python/paddle/fluid/recordio_writer.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ def convert_reader_to_recordio_files(
103103
This API is basically same as :code:`convert_reader_to_recordio_file`,
104104
instead of it will create many recordio files. Each file contains at
105105
most :code:`batch_per_file` records.
106+
107+
Please reference
108+
:ref:`api_fluid_recordio_writer_convert_reader_to_recordio_file` for more
109+
details.
106110
"""
107111
if feed_order is None:
108112
feed_order = feeder.feed_names

python/paddle/fluid/trainer.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class EndStepEvent(object):
8383
epoch_id(int): The current epoch ID.
8484
step_id(int): The current step ID.
8585
metrics(list): A list of fetched tensor. The order of this list is same
86-
as the :code:`train_func` returns.
86+
as the :code:`train_func` returns.
8787
"""
8888

8989
def __init__(self, epoch_id, step_id, metrics):
@@ -99,7 +99,7 @@ class CheckpointConfig(object):
9999
100100
Args:
101101
checkpoint_dir(str): Directory path to save check point. Default is the
102-
current directory.
102+
current directory.
103103
104104
max_num_checkpoints(int): The max number of local check points.
105105
epoch_interval(int): Every number of epoch to save check point.
@@ -389,11 +389,11 @@ def train(self, num_epochs, event_handler, reader=None, feed_order=None):
389389
Start the train loop to train the model.
390390
391391
Args:
392-
num_epochs: The number of epoch. An epoch will process all data in reader
393-
event_handler: The event handler. A function with type (ev:Event)->void
394-
reader: A reader creator object. See also
392+
num_epochs(int): The number of epoch. An epoch will process all data in reader
393+
event_handler(callable): The event handler. A function with type (ev:Event)->void
394+
reader(callable): A reader creator object. See also
395395
:ref:`api_guide_python_reader` .
396-
feed_order: Feeding order of reader. None will following the defining
396+
feed_order(list): Feeding order of reader. None will following the defining
397397
order in program
398398
399399
Returns:
@@ -427,9 +427,10 @@ def test(self, reader, feed_order):
427427

428428
def save_params(self, param_path):
429429
"""
430-
Save all parameters into :code:`param_path`
430+
Save all parameters into :code:`param_path`.
431+
431432
Args:
432-
param_path(str): The path to save parameters
433+
param_path(str): The path to save parameters.
433434
434435
Returns:
435436
None

0 commit comments

Comments
 (0)