diff --git a/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst b/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst index 05ec34cf68d..564da061e79 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst @@ -40,5 +40,3 @@ - 如果线下训练,建议为每次训练设置 `BATCH_JOB_ID` 环境变量。 - 分布式训练中,假如使用多个节点(服务器),则必须使用每个节点全部的8张卡。如果只有一个节点(服务器),则没有这样的限制。 - - .. include:: mindspore.dataset.sync_wait_dataset.rst diff --git a/docs/api/api_python/dataset/mindspore.dataset.sync_wait_dataset.rst b/docs/api/api_python/dataset/mindspore.dataset.sync_wait_for_dataset.rst similarity index 67% rename from docs/api/api_python/dataset/mindspore.dataset.sync_wait_dataset.rst rename to docs/api/api_python/dataset/mindspore.dataset.sync_wait_for_dataset.rst index c3b25530474..df29bf54673 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.sync_wait_dataset.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.sync_wait_for_dataset.rst @@ -1,14 +1,14 @@ -mindspore.dataset.sync_wait_dataset -=================================== - -.. py:function:: mindspore.dataset.sync_wait_dataset(rank_id, rank_size, current_epoch) - - 等待所有的卡需要的数据集文件下载完成。 - - .. note:: 需要配合 `mindspore.dataset.OBSMindDataset` 使用,建议在每次epoch开始前调用。 - - **参数:** - - - **rank_id** (int) - 当前卡的逻辑序号。 - - **rank_size** (int) - 卡的数量。 - - **current_epoch** (int) - 训练时当前的epoch数。 +mindspore.dataset.sync_wait_for_dataset +======================================= + +.. py:function:: mindspore.dataset.sync_wait_for_dataset(rank_id, rank_size, current_epoch) + + 等待所有的卡需要的数据集文件下载完成。 + + .. note:: 需要配合 `mindspore.dataset.OBSMindDataset` 使用,建议在每次epoch开始前调用。 + + **参数:** + + - **rank_id** (int) - 当前卡的逻辑序号。 + - **rank_size** (int) - 卡的数量。 + - **current_epoch** (int) - 训练时当前的epoch数。 diff --git a/docs/api/api_python/mindspore.dataset.rst b/docs/api/api_python/mindspore.dataset.rst index 781aad9b150..83f8136e7f0 100644 --- a/docs/api/api_python/mindspore.dataset.rst +++ b/docs/api/api_python/mindspore.dataset.rst @@ -170,6 +170,6 @@ mindspore.dataset mindspore.dataset.deserialize mindspore.dataset.serialize mindspore.dataset.show - mindspore.dataset.sync_wait_dataset + mindspore.dataset.sync_wait_for_dataset mindspore.dataset.utils.imshow_det_bbox mindspore.dataset.zip