From d79e74e68e36532a1491ab831df5f3efb935a3aa Mon Sep 17 00:00:00 2001
From: liyong <liyong126@huawei.com>
Date: Wed, 7 Jul 2021 14:52:57 +0800
Subject: [PATCH] fix api doc

---
 mindspore/mindrecord/filewriter.py           |  9 ++++++---
 mindspore/mindrecord/tools/cifar100_to_mr.py |  6 ++++++
 mindspore/mindrecord/tools/cifar10_to_mr.py  |  6 ++++++
 mindspore/mindrecord/tools/csv_to_mr.py      | 10 ++++------
 4 files changed, 22 insertions(+), 9 deletions(-)

diff --git a/mindspore/mindrecord/filewriter.py b/mindspore/mindrecord/filewriter.py
index 9a2bb9244b6..76f6f092473 100644
--- a/mindspore/mindrecord/filewriter.py
+++ b/mindspore/mindrecord/filewriter.py
@@ -36,7 +36,8 @@ class FileWriter:
     Class to write user defined raw data into MindRecord files.
 
     Note:
-        The mindrecord file may fail to be read if the file name is modified.
+        After the MindRecord file is generated, if the file name is changed,
+            the file may fail to be read.
 
     Args:
         file_name (str): File name of MindRecord file.
@@ -266,7 +267,8 @@ class FileWriter:
         the MindRecord file can store.
 
         Args:
-            header_size (int): Size of header, between 16KB and 128MB.
+            header_size (int): Size of header, between 16*1024(16KB) and
+                128*1024*1024(128MB).
 
         Returns:
             MSRStatus, SUCCESS or FAILED.
@@ -284,7 +286,8 @@ class FileWriter:
         The larger a page, the more data the page can store.
 
         Args:
-           page_size (int): Size of page, between 32KB and 256MB.
+           page_size (int): Size of page, between 32*1024(32KB) and
+               256*1024*1024(256MB).
 
         Returns:
             MSRStatus, SUCCESS or FAILED.
diff --git a/mindspore/mindrecord/tools/cifar100_to_mr.py b/mindspore/mindrecord/tools/cifar100_to_mr.py
index f8192cbb1ca..ca0b814de8e 100644
--- a/mindspore/mindrecord/tools/cifar100_to_mr.py
+++ b/mindspore/mindrecord/tools/cifar100_to_mr.py
@@ -110,6 +110,12 @@ class Cifar100ToMR:
     def transform(self, fields=None):
         """
         Encapsulate the run function to exit normally
+
+        Args:
+            fields (list[str]): A list of index field, e.g.["fine_label", "coarse_label"].
+
+        Returns:
+            MSRStatus, whether cifar100 is successfully transformed to MindRecord.
         """
 
         t = ExceptionThread(target=self.run, kwargs={'fields': fields})
diff --git a/mindspore/mindrecord/tools/cifar10_to_mr.py b/mindspore/mindrecord/tools/cifar10_to_mr.py
index f16cca5a652..961ba4db487 100644
--- a/mindspore/mindrecord/tools/cifar10_to_mr.py
+++ b/mindspore/mindrecord/tools/cifar10_to_mr.py
@@ -106,6 +106,12 @@ class Cifar10ToMR:
     def transform(self, fields=None):
         """
         Encapsulate the run function to exit normally
+
+        Args:
+            fields (list[str], optional): A list of index fields. Default: None.
+
+        Returns:
+            MSRStatus, whether cifar10 is successfully transformed to MindRecord.
         """
 
         t = ExceptionThread(target=self.run, kwargs={'fields': fields})
diff --git a/mindspore/mindrecord/tools/csv_to_mr.py b/mindspore/mindrecord/tools/csv_to_mr.py
index 862ddd42031..4e573c11482 100644
--- a/mindspore/mindrecord/tools/csv_to_mr.py
+++ b/mindspore/mindrecord/tools/csv_to_mr.py
@@ -54,7 +54,7 @@ class CsvToMR:
         else:
             raise ValueError("The parameter source must be str.")
 
-        self.check_columns(columns_list, "columns_list")
+        self._check_columns(columns_list, "columns_list")
         self.columns_list = columns_list
 
         if isinstance(destination, str):
@@ -72,8 +72,7 @@ class CsvToMR:
 
         self.writer = FileWriter(self.destination, self.partition_number)
 
-    @staticmethod
-    def check_columns(columns, columns_name):
+    def _check_columns(self, columns, columns_name):
         """
         Validate the columns of csv
         """
@@ -111,8 +110,7 @@ class CsvToMR:
             raise RuntimeError("Failed to generate schema from csv file.")
         return schema
 
-    @staticmethod
-    def get_row_of_csv(df, columns_list):
+    def _get_row_of_csv(self, df, columns_list):
         """Get row data from csv file."""
         for _, r in df.iterrows():
             row = {}
@@ -152,7 +150,7 @@ class CsvToMR:
         # add the index
         self.writer.add_index(list(self.columns_list))
 
-        csv_iter = self.get_row_of_csv(df, self.columns_list)
+        csv_iter = self._get_row_of_csv(df, self.columns_list)
         batch_size = 256
         transform_count = 0
         while True: