diff --git a/docs/api/api_python/dataset/mindspore.dataset.api_list_audio.rst b/docs/api/api_python/dataset/mindspore.dataset.api_list_audio.rst index 682e96f7af7..b729ca15eca 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.api_list_audio.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.api_list_audio.rst @@ -72,8 +72,8 @@ Batch(批操作) :nosignatures: :template: classtemplate.rst - mindspore.dataset.Dataset.add_sampler - mindspore.dataset.Dataset.use_sampler + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler 其他方法 -------- diff --git a/docs/api/api_python/dataset/mindspore.dataset.api_list_nlp.rst b/docs/api/api_python/dataset/mindspore.dataset.api_list_nlp.rst index 3dec7938999..d2c72451630 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.api_list_nlp.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.api_list_nlp.rst @@ -7,8 +7,6 @@ :template: classtemplate.rst mindspore.dataset.Dataset.apply - mindspore.dataset.TextBaseDataset.build_sentencepiece_vocab - mindspore.dataset.TextBaseDataset.build_vocab mindspore.dataset.Dataset.concat mindspore.dataset.Dataset.filter mindspore.dataset.Dataset.flat_map @@ -24,6 +22,8 @@ mindspore.dataset.Dataset.split mindspore.dataset.Dataset.take mindspore.dataset.Dataset.zip + mindspore.dataset.TextBaseDataset.build_sentencepiece_vocab + mindspore.dataset.TextBaseDataset.build_vocab Batch(批操作) ------------------------ @@ -74,8 +74,8 @@ Batch(批操作) :nosignatures: :template: classtemplate.rst - mindspore.dataset.Dataset.add_sampler - mindspore.dataset.Dataset.use_sampler + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler 其他方法 -------- diff --git a/docs/api/api_python/dataset/mindspore.dataset.api_list_vision.rst b/docs/api/api_python/dataset/mindspore.dataset.api_list_vision.rst index 682e96f7af7..b729ca15eca 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.api_list_vision.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.api_list_vision.rst @@ -72,8 +72,8 @@ Batch(批操作) :nosignatures: :template: classtemplate.rst - mindspore.dataset.Dataset.add_sampler - mindspore.dataset.Dataset.use_sampler + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler 其他方法 -------- diff --git a/docs/api/api_python/ops/mindspore.ops.func_batch_norm.rst b/docs/api/api_python/ops/mindspore.ops.func_batch_norm.rst index 4f28fa5fb59..51770335296 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_batch_norm.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_batch_norm.rst @@ -32,7 +32,7 @@ mindspore.ops.batch_norm - **eps** (float) - 添加到分母上的值,以确保数值稳定性。默认值:1e-5。 返回: - Tensor, 数据类型与shape大小与 `input_x` 相同,其中,shape大小为 :math:`(N, C)` 。 + Tensor,数据类型与shape大小与 `input_x` 相同,其中,shape大小为 :math:`(N, C)` 。 异常: - **TypeError** - `training` 不是bool。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_print_.rst b/docs/api/api_python/ops/mindspore.ops.func_print_.rst index d8cfd7fb924..03de420c671 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_print_.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_print_.rst @@ -1,5 +1,5 @@ -mindspore.ops.print_ -==================== +mindspore.ops.print\_ +===================== .. py:function:: mindspore.ops.print_(*input_x) diff --git a/docs/api/api_python_en/dataset_list.rst b/docs/api/api_python_en/dataset_list.rst new file mode 100644 index 00000000000..6f82049c00b --- /dev/null +++ b/docs/api/api_python_en/dataset_list.rst @@ -0,0 +1,330 @@ +.. role:: hidden + :class: hidden-section + +.. currentmodule:: {{ module }} + +{% if objname in ['ArgoverseDataset', 'Caltech101Dataset', 'Caltech256Dataset', 'CelebADataset', 'Cifar100Dataset', 'Cifar10Dataset', 'CityscapesDataset', 'CocoDataset', 'DIV2KDataset', 'EMnistDataset', 'FakeImageDataset', 'FashionMnistDataset', 'FlickrDataset', 'Flowers102Dataset', 'ImageFolderDataset', 'InMemoryGraphDataset', 'KMnistDataset', 'ManifestDataset', 'MnistDataset', 'PhotoTourDataset', 'Places365Dataset', 'QMnistDataset', 'SBDataset', 'SBUDataset', 'SemeionDataset', 'STL10Dataset', 'SVHNDataset', 'USPSDataset', 'VOCDataset', 'WIDERFaceDataset']%} + +{{ fullname | underline }} + +.. autoclass:: {{ name }} + +Pre-processing Operation +---------------------------- + +.. autosummary:: + :toctree: dataset_method/operation + :nosignatures: + + + mindspore.dataset.Dataset.apply + mindspore.dataset.Dataset.concat + mindspore.dataset.Dataset.filter + mindspore.dataset.Dataset.flat_map + mindspore.dataset.Dataset.map + mindspore.dataset.Dataset.project + mindspore.dataset.Dataset.rename + mindspore.dataset.Dataset.repeat + mindspore.dataset.Dataset.reset + mindspore.dataset.Dataset.save + mindspore.dataset.Dataset.set_dynamic_columns + mindspore.dataset.Dataset.shuffle + mindspore.dataset.Dataset.skip + mindspore.dataset.Dataset.split + mindspore.dataset.Dataset.take + mindspore.dataset.Dataset.zip + +Batch +------------------------ + +.. autosummary:: + :toctree: dataset_method/batch + :nosignatures: + + + mindspore.dataset.Dataset.batch + mindspore.dataset.Dataset.bucket_batch_by_length + +Iterator +--------- + +.. autosummary:: + :toctree: dataset_method/iterator + :nosignatures: + + + mindspore.dataset.Dataset.create_dict_iterator + mindspore.dataset.Dataset.create_tuple_iterator + +Attribute +---------- + +.. autosummary:: + :toctree: dataset_method/attribute + :nosignatures: + + + mindspore.dataset.Dataset.dynamic_min_max_shapes + mindspore.dataset.Dataset.get_batch_size + mindspore.dataset.Dataset.get_class_indexing + mindspore.dataset.Dataset.get_col_names + mindspore.dataset.Dataset.get_dataset_size + mindspore.dataset.Dataset.get_repeat_count + mindspore.dataset.Dataset.input_indexs + mindspore.dataset.Dataset.num_classes + mindspore.dataset.Dataset.output_shapes + mindspore.dataset.Dataset.output_types + +Apply Sampler +-------------- + +.. autosummary:: + :toctree: dataset_method/sampler + :nosignatures: + + + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler + +Others +-------- + +.. autosummary:: + :toctree: dataset_method/others + :nosignatures: + + + mindspore.dataset.Dataset.close_pool + mindspore.dataset.Dataset.device_que + mindspore.dataset.Dataset.sync_update + mindspore.dataset.Dataset.sync_wait + mindspore.dataset.Dataset.to_json + mindspore.dataset.Dataset.to_device + + +{% elif objname in ['LJSpeechDataset', 'SpeechCommandsDataset', 'TedliumDataset', 'YesNoDataset'] %} + +{{ fullname | underline }} + +.. autoclass:: {{ name }} + +Pre-processing Operation +------------------------- + +.. autosummary:: + :toctree: dataset_method/operation + :nosignatures: + + + mindspore.dataset.Dataset.apply + mindspore.dataset.Dataset.concat + mindspore.dataset.Dataset.filter + mindspore.dataset.Dataset.flat_map + mindspore.dataset.Dataset.map + mindspore.dataset.Dataset.project + mindspore.dataset.Dataset.rename + mindspore.dataset.Dataset.repeat + mindspore.dataset.Dataset.reset + mindspore.dataset.Dataset.save + mindspore.dataset.Dataset.set_dynamic_columns + mindspore.dataset.Dataset.shuffle + mindspore.dataset.Dataset.skip + mindspore.dataset.Dataset.split + mindspore.dataset.Dataset.take + mindspore.dataset.Dataset.zip + +Batch +------------------------ + +.. autosummary:: + :toctree: dataset_method/batch + :nosignatures: + + + mindspore.dataset.Dataset.batch + mindspore.dataset.Dataset.bucket_batch_by_length + +Iterator +--------- + +.. autosummary:: + :toctree: dataset_method/iterator + :nosignatures: + + + mindspore.dataset.Dataset.create_dict_iterator + mindspore.dataset.Dataset.create_tuple_iterator + +Attribute +---------- + +.. autosummary:: + :toctree: dataset_method/attribute + :nosignatures: + + + mindspore.dataset.Dataset.dynamic_min_max_shapes + mindspore.dataset.Dataset.get_batch_size + mindspore.dataset.Dataset.get_class_indexing + mindspore.dataset.Dataset.get_col_names + mindspore.dataset.Dataset.get_dataset_size + mindspore.dataset.Dataset.get_repeat_count + mindspore.dataset.Dataset.input_indexs + mindspore.dataset.Dataset.num_classes + mindspore.dataset.Dataset.output_shapes + mindspore.dataset.Dataset.output_types + +Apply Sampler +-------------- + +.. autosummary:: + :toctree: dataset_method/sampler + :nosignatures: + + + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler + +Others +-------- + +.. autosummary:: + :toctree: dataset_method/others + :nosignatures: + + + mindspore.dataset.Dataset.close_pool + mindspore.dataset.Dataset.device_que + mindspore.dataset.Dataset.sync_update + mindspore.dataset.Dataset.sync_wait + mindspore.dataset.Dataset.to_json + mindspore.dataset.Dataset.to_device + + +{% elif objname in ['AGNewsDataset', 'AmazonReviewDataset', 'CLUEDataset', 'CoNLL2000Dataset', 'CSVDataset', 'DBpediaDataset', 'EnWik9Dataset', 'GeneratorDataset', 'IMDBDataset', 'IWSLT2016Dataset', 'IWSLT2017Dataset', 'MindDataset', 'NumpySlicesDataset', 'OBSMindDataset', 'PaddedDataset', 'PennTreebankDataset', 'RandomDataset', 'SogouNewsDataset', 'TextFileDataset', 'TFRecordDataset', 'UDPOSDataset', 'WikiTextDataset', 'YahooAnswersDataset', 'YelpReviewDataset'] %} + +{{ fullname | underline }} + +.. autoclass:: {{ name }} + +Pre-processing Operation +------------------------- + +.. autosummary:: + :toctree: dataset_method/operation + :nosignatures: + + + mindspore.dataset.Dataset.apply + mindspore.dataset.Dataset.concat + mindspore.dataset.Dataset.filter + mindspore.dataset.Dataset.flat_map + mindspore.dataset.Dataset.map + mindspore.dataset.Dataset.project + mindspore.dataset.Dataset.rename + mindspore.dataset.Dataset.repeat + mindspore.dataset.Dataset.reset + mindspore.dataset.Dataset.save + mindspore.dataset.Dataset.set_dynamic_columns + mindspore.dataset.Dataset.shuffle + mindspore.dataset.Dataset.skip + mindspore.dataset.Dataset.split + mindspore.dataset.Dataset.take + mindspore.dataset.Dataset.zip + mindspore.dataset.TextBaseDataset.build_sentencepiece_vocab + mindspore.dataset.TextBaseDataset.build_vocab + +Batch +------------------------ + +.. autosummary:: + :toctree: dataset_method/batch + :nosignatures: + + + mindspore.dataset.Dataset.batch + mindspore.dataset.Dataset.bucket_batch_by_length + +Iterator +--------- + +.. autosummary:: + :toctree: dataset_method/iterator + :nosignatures: + + + mindspore.dataset.Dataset.create_dict_iterator + mindspore.dataset.Dataset.create_tuple_iterator + +Attribute +---------- + +.. autosummary:: + :toctree: dataset_method/attribute + :nosignatures: + + + mindspore.dataset.Dataset.dynamic_min_max_shapes + mindspore.dataset.Dataset.get_batch_size + mindspore.dataset.Dataset.get_class_indexing + mindspore.dataset.Dataset.get_col_names + mindspore.dataset.Dataset.get_dataset_size + mindspore.dataset.Dataset.get_repeat_count + mindspore.dataset.Dataset.input_indexs + mindspore.dataset.Dataset.num_classes + mindspore.dataset.Dataset.output_shapes + mindspore.dataset.Dataset.output_types + +Apply Sampler +-------------- + +.. autosummary:: + :toctree: dataset_method/sampler + :nosignatures: + + + mindspore.dataset.MappableDataset.add_sampler + mindspore.dataset.MappableDataset.use_sampler + +Others +-------- + +.. autosummary:: + :toctree: dataset_method/others + :nosignatures: + + + mindspore.dataset.Dataset.close_pool + mindspore.dataset.Dataset.device_que + mindspore.dataset.Dataset.sync_update + mindspore.dataset.Dataset.sync_wait + mindspore.dataset.Dataset.to_json + mindspore.dataset.Dataset.to_device + + +{% elif fullname=="mindspore.dataset.WaitedDSCallback" %} + +{{ fullname | underline }} + +.. autoclass:: {{ name }} + :members: sync_epoch_begin, sync_step_begin + +{% elif objname[0].istitle() %} + +{{ fullname | underline }} + +.. autoclass:: {{ name }} + :inherited-members: + :exclude-members: parse_tree, create_ir_tree, create_runtime_obj + :members: + +{% else %} +{{ fullname | underline }} + +.. autofunction:: {{ fullname }} + +{% endif %} + +.. + autogenerated from _templates/classtemplate.rst + note it does not have :inherited-members: \ No newline at end of file diff --git a/docs/api/api_python_en/mindspore.dataset.rst b/docs/api/api_python_en/mindspore.dataset.rst index 565875b221a..d4b7c88c24a 100644 --- a/docs/api/api_python_en/mindspore.dataset.rst +++ b/docs/api/api_python_en/mindspore.dataset.rst @@ -9,7 +9,7 @@ Vision .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.Caltech101Dataset mindspore.dataset.Caltech256Dataset @@ -46,7 +46,7 @@ Text .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.AGNewsDataset mindspore.dataset.AmazonReviewDataset @@ -72,7 +72,7 @@ Audio .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.LJSpeechDataset mindspore.dataset.SpeechCommandsDataset @@ -85,7 +85,7 @@ Standard Format .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.CSVDataset mindspore.dataset.MindDataset @@ -98,7 +98,7 @@ User Defined .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.GeneratorDataset mindspore.dataset.NumpySlicesDataset @@ -111,7 +111,7 @@ Graph .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.ArgoverseDataset mindspore.dataset.Graph @@ -140,7 +140,7 @@ Others .. autosummary:: :toctree: dataset :nosignatures: - :template: classtemplate_inherited.rst + :template: classtemplate_dataset.rst mindspore.dataset.BatchInfo mindspore.dataset.DatasetCache @@ -156,4 +156,3 @@ Others mindspore.dataset.show mindspore.dataset.sync_wait_for_dataset mindspore.dataset.utils.imshow_det_bbox - mindspore.dataset.zip