!3556 add desc about sink_size

Merge pull request !3556 from jinyaohui/master
5 years ago · fa3a1f4a16
parent 2f956d7cc2 ac6d3d557c
commit fa3a1f4a16
1 changed files with 3 additions and 1 deletions
--- a/mindspore/train/model.py
+++ b/mindspore/train/model.py
@ -523,7 +523,9 @@ class Model:
            of data will be transferred one by one. The limitation of data transmission per time is 256M.

        Args:
-            epoch (int): Total number of iterations on the data.
+            epoch (int): Generally, total number of iterations on the data per epoch.
+                         When dataset_sink_mode is set to true and sink_size>0, each epoch sink sink_size
+                         steps on the data instead of total number of iterations.
            train_dataset (Dataset): A training dataset iterator. If there is no
                                     loss_fn, a tuple with multiply data (data1, data2, data3, ...) should be
                                     returned and passed to the network. Otherwise, a tuple (data, label) should