From c9225d5667b678c2cdd041d23d99ed8052581af0 Mon Sep 17 00:00:00 2001 From: zhangyi Date: Mon, 29 Nov 2021 11:36:30 +0800 Subject: [PATCH] add index files for chinese python api. --- .../dataset_audio/mindspore.dataset.audio.rst | 3 - docs/api/api_python/mindspore.dataset.rst | 69 +++++++++++++++++++ .../api_python/mindspore.dataset_audio.rst | 25 +++++++ docs/api/api_python/mindspore.rst | 46 +++++++++++++ 4 files changed, 140 insertions(+), 3 deletions(-) create mode 100644 docs/api/api_python/mindspore.dataset.rst create mode 100644 docs/api/api_python/mindspore.dataset_audio.rst create mode 100644 docs/api/api_python/mindspore.rst diff --git a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.rst b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.rst index 0a0714a51c5..47266c82bac 100644 --- a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.rst +++ b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.rst @@ -1,6 +1,3 @@ -mindspore.dataset.audio -============================== - 此模块用于音频数据增强,包括 `transforms` 和 `utils` 两个子模块。 `transforms` 是一个高性能音频数据增强模块,支持常见的音频数据增强操作。 `utils` 提供了一些音频处理的工具方法。 diff --git a/docs/api/api_python/mindspore.dataset.rst b/docs/api/api_python/mindspore.dataset.rst new file mode 100644 index 00000000000..2fd7de88529 --- /dev/null +++ b/docs/api/api_python/mindspore.dataset.rst @@ -0,0 +1,69 @@ +mindspore.dataset +================= + +Vision +------- + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.ImageFolderDataset + mindspore.dataset.MnistDataset + mindspore.dataset.VOCDataset + +Text +---- + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.CLUEDataset + +Graph +----- + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.GraphData + + +User Defined +------------ + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.NumpySlicesDataset + mindspore.dataset.PaddedDataset + +Sampler +------- + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.DistributedSampler + mindspore.dataset.PKSampler + mindspore.dataset.RandomSampler + mindspore.dataset.SequentialSampler + mindspore.dataset.SubsetRandomSampler + mindspore.dataset.SubsetSampler + mindspore.dataset.WeightedRandomSampler + +Others +------ + +.. cnmsautosummary:: + :toctree: dataset + + mindspore.dataset.compare + mindspore.dataset.DatasetCache + mindspore.dataset.deserialize + mindspore.dataset.DSCallback + mindspore.dataset.Schema + mindspore.dataset.serialize + mindspore.dataset.show + mindspore.dataset.utils.imshow_det_bbox + mindspore.dataset.WaitedDSCallback + mindspore.dataset.zip diff --git a/docs/api/api_python/mindspore.dataset_audio.rst b/docs/api/api_python/mindspore.dataset_audio.rst new file mode 100644 index 00000000000..2d4984dca96 --- /dev/null +++ b/docs/api/api_python/mindspore.dataset_audio.rst @@ -0,0 +1,25 @@ +mindspore.dataset.audio +======================= + +.. include:: dataset_audio/mindspore.dataset.audio.rst + +mindspore.dataset.audio.transforms +---------------------------------- + +.. cnmsautosummary:: + :toctree: dataset_audio + + mindspore.dataset.audio.transforms.AllpassBiquad + mindspore.dataset.audio.transforms.AmplitudeToDB + mindspore.dataset.audio.transforms.Angle + mindspore.dataset.audio.transforms.BandBiquad + mindspore.dataset.audio.transforms.BandpassBiquad + mindspore.dataset.audio.transforms.BandrejectBiquad + mindspore.dataset.audio.transforms.BassBiquad + mindspore.dataset.audio.transforms.ComplexNorm + mindspore.dataset.audio.transforms.Contrast + mindspore.dataset.audio.transforms.FrequencyMasking + mindspore.dataset.audio.transforms.LowpassBiquad + mindspore.dataset.audio.transforms.TimeMasking + mindspore.dataset.audio.transforms.TimeStretch + mindspore.dataset.audio.utils.ScaleType diff --git a/docs/api/api_python/mindspore.rst b/docs/api/api_python/mindspore.rst new file mode 100644 index 00000000000..6f9923398e2 --- /dev/null +++ b/docs/api/api_python/mindspore.rst @@ -0,0 +1,46 @@ +mindspore +========= + +Tensor +------ + +.. cnmsautosummary:: + :toctree: mindspore + + mindspore.Tensor + mindspore.RowTensor + mindspore.SparseTensor + +Parameter +--------- + +.. cnmsautosummary:: + :toctree: mindspore + + mindspore.Parameter + mindspore.ParameterTuple + +Model +----- + +.. cnmsautosummary:: + :toctree: mindspore + + mindspore.Model + +Serialization +-------------- + +.. cnmsautosummary:: + :toctree: mindspore + + mindspore.build_searched_strategy + mindspore.merge_sliced_parameter + +JIT +--- + +.. cnmsautosummary:: + :toctree: mindspore + + mindspore.ms_function