!40959 fix: add info comment for api

Merge pull request !40959 from guozhijian/fix_docs_usage
This commit is contained in:
i-robot 2022-08-27 09:37:42 +00:00 committed by Gitee
commit 21d9238935
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 8 additions and 4 deletions

View File

@ -78,7 +78,8 @@ class Cifar100ToMR:
Execute transformation from cifar100 to MindRecord.
Args:
fields (list[str]): A list of index field, e.g.["fine_label", "coarse_label"]. Default: None.
fields (list[str]): A list of index field, e.g.["fine_label", "coarse_label"]. Default: None. For index
field settings, please refer to :func:`mindspore.mindrecord.FileWriter.add_index`.
Returns:
MSRStatus, SUCCESS or FAILED.
@ -117,7 +118,8 @@ class Cifar100ToMR:
Encapsulate the :func:`mindspore.mindrecord.Cifar100ToMR.run` function to exit normally.
Args:
fields (list[str]): A list of index field, e.g.["fine_label", "coarse_label"]. Default: None.
fields (list[str]): A list of index field, e.g.["fine_label", "coarse_label"]. Default: None. For index
field settings, please refer to :func:`mindspore.mindrecord.FileWriter.add_index`.
Returns:
MSRStatus, SUCCESS or FAILED.

View File

@ -78,7 +78,8 @@ class Cifar10ToMR:
Execute transformation from cifar10 to MindRecord.
Args:
fields (list[str], optional): A list of index fields. Default: None.
fields (list[str], optional): A list of index fields. Default: None. For index field settings,
please refer to :func:`mindspore.mindrecord.FileWriter.add_index`.
Returns:
MSRStatus, SUCCESS or FAILED.
@ -114,7 +115,8 @@ class Cifar10ToMR:
Encapsulate the :func:`mindspore.mindrecord.Cifar10ToMR.run` function to exit normally.
Args:
fields (list[str], optional): A list of index fields. Default: None.
fields (list[str], optional): A list of index fields. Default: None. For index field settings,
please refer to :func:`mindspore.mindrecord.FileWriter.add_index`.
Returns:
MSRStatus, SUCCESS or FAILED.