TFRecordDataset add notes

2020-09-19 18:09:58 +08:00 · 2020-09-19 18:09:58 +08:00 · 13ed9f99b3
parent 295e2b1bb8
commit 13ed9f99b3
1 changed files with 4 additions and 0 deletions
--- a/mindspore/dataset/engine/datasets.py
+++ b/mindspore/dataset/engine/datasets.py
@ -3725,6 +3725,10 @@ class TFRecordDataset(SourceDataset):
        """
        Get the number of batches in an epoch.

+        Note:
+            Because the TFRecord format does not save metadata, all files need to be traversed to obtain
+            the total amount of data. Therefore, this api is slow.
+
        Args:
            estimate (bool, optional): Fast estimation of the dataset size instead of a full scan.