From 13ed9f99b3b0e91bcd60c3fb7f5005e705816532 Mon Sep 17 00:00:00 2001
From: heleiwang <heleiwang@huawei.com>
Date: Sat, 19 Sep 2020 18:09:58 +0800
Subject: [PATCH] TFRecordDataset add notes

---
 mindspore/dataset/engine/datasets.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mindspore/dataset/engine/datasets.py b/mindspore/dataset/engine/datasets.py
index 37a17f110a..23d6175449 100644
--- 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.