forked from mindspore-Ecosystem/mindspore
!40959 fix: add info comment for api
Merge pull request !40959 from guozhijian/fix_docs_usage
This commit is contained in:
commit
21d9238935
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue