!361 Add TDT transfer data limit description

Merge pull request !361 from pengyanjun/add_tdt_transfer_data_limit_doc
This commit is contained in:
mindspore-ci-bot 2020-04-15 22:00:44 +08:00 committed by Gitee
commit 5519af5568
1 changed files with 9 additions and 1 deletions

View File

@ -548,12 +548,16 @@ class Dataset:
def device_que(self, prefetch_size=None):
"""
Returns a transferredDataset that transfer data through tdt.
Returns a transferredDataset that transfer data through device.
Args:
prefetch_size (int, optional): prefetch number of records ahead of the
user's request (default=None).
Note:
If device is Ascend, features of data will be transferred one by one. The limitation
of data transferation per time is 256M.
Return:
TransferDataset, dataset for transferring.
"""
@ -566,6 +570,10 @@ class Dataset:
Args:
num_batch (int, optional): limit the number of batch to be sent to device (default=None).
Note:
If device is Ascend, features of data will be transferred one by one. The limitation
of data transferation per time is 256M.
Returns:
TransferDataset, dataset for transferring.