!865 Fix doc-string of sync_wait and sync_update

Merge pull request !865 from 章一智/master
pull/865/MERGE
mindspore-ci-bot 5 years ago committed by Gitee
commit 4eb83ffaa5

@ -208,7 +208,6 @@ class Dataset:
Add a blocking condition to the input Dataset Add a blocking condition to the input Dataset
Args: Args:
input_dataset (Dataset): Input dataset to apply flow control
num_batch (int): the number of batches without blocking at the start of each epoch num_batch (int): the number of batches without blocking at the start of each epoch
condition_name (str): The condition name that is used to toggle sending next row condition_name (str): The condition name that is used to toggle sending next row
callback (function): The callback funciton that will be invoked when sync_update is called callback (function): The callback funciton that will be invoked when sync_update is called
@ -921,10 +920,13 @@ class Dataset:
def sync_update(self, condition_name, num_batch=None, data=None): def sync_update(self, condition_name, num_batch=None, data=None):
""" """
condition_name (str): The condition name that is used to toggle sending next row Release a blocking condition and triger callback with given data
num_batch (int or None): The number of batches(rows) that are released
when pass_rows is None, will update the same number as sync_wait specified Args:
data (dict or None): The data passed to the callback condition_name (str): The condition name that is used to toggle sending next row
num_batch (int or None): The number of batches(rows) that are released
When num_batch is None, it will default to the number specified by the sync_wait operator
data (dict or None): The data passed to the callback
""" """
notifiers_dict = self.get_sync_notifiers() notifiers_dict = self.get_sync_notifiers()
if condition_name not in notifiers_dict: if condition_name not in notifiers_dict:

Loading…
Cancel
Save