@@ -83,7 +83,7 @@ class EndStepEvent(object):
83
83
epoch_id(int): The current epoch ID.
84
84
step_id(int): The current step ID.
85
85
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.
87
87
"""
88
88
89
89
def __init__ (self , epoch_id , step_id , metrics ):
@@ -99,7 +99,7 @@ class CheckpointConfig(object):
99
99
100
100
Args:
101
101
checkpoint_dir(str): Directory path to save check point. Default is the
102
- current directory.
102
+ current directory.
103
103
104
104
max_num_checkpoints(int): The max number of local check points.
105
105
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):
389
389
Start the train loop to train the model.
390
390
391
391
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
395
395
: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
397
397
order in program
398
398
399
399
Returns:
@@ -427,9 +427,10 @@ def test(self, reader, feed_order):
427
427
428
428
def save_params (self , param_path ):
429
429
"""
430
- Save all parameters into :code:`param_path`
430
+ Save all parameters into :code:`param_path`.
431
+
431
432
Args:
432
- param_path(str): The path to save parameters
433
+ param_path(str): The path to save parameters.
433
434
434
435
Returns:
435
436
None
0 commit comments