fix fileWriter comment

5 years ago · 1cb8dec1e8
parent 8346da267b
commit 1cb8dec1e8
1 changed files with 3 additions and 0 deletions
--- a/mindspore/mindrecord/filewriter.py
+++ b/mindspore/mindrecord/filewriter.py
@ -34,6 +34,9 @@ class FileWriter:
    """
    Class to write user defined raw data into MindRecord File series.

+    Note:
+        The mindrecord file may fail to be read if the file name is modified.
+
    Args:
        file_name (str): File name of MindRecord File.
        shard_num (int, optional): Number of MindRecord File (default=1).