!49862 [MD] Add missing API docs

Merge pull request !49862 from xiaotianci/add_missing_api_docs
This commit is contained in:
i-robot 2023-03-07 09:04:14 +00:00 committed by Gitee
commit f06617b700
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
6 changed files with 53 additions and 6 deletions

View File

@ -114,9 +114,13 @@ mindspore.dataset
mindspore.dataset.Flowers102Dataset mindspore.dataset.Flowers102Dataset
mindspore.dataset.Food101Dataset mindspore.dataset.Food101Dataset
mindspore.dataset.ImageFolderDataset mindspore.dataset.ImageFolderDataset
mindspore.dataset.KITTIDataset
mindspore.dataset.KMnistDataset mindspore.dataset.KMnistDataset
mindspore.dataset.LFWDataset
mindspore.dataset.LSUNDataset
mindspore.dataset.ManifestDataset mindspore.dataset.ManifestDataset
mindspore.dataset.MnistDataset mindspore.dataset.MnistDataset
mindspore.dataset.OmniglotDataset
mindspore.dataset.PhotoTourDataset mindspore.dataset.PhotoTourDataset
mindspore.dataset.Places365Dataset mindspore.dataset.Places365Dataset
mindspore.dataset.QMnistDataset mindspore.dataset.QMnistDataset
@ -148,8 +152,10 @@ mindspore.dataset
mindspore.dataset.IMDBDataset mindspore.dataset.IMDBDataset
mindspore.dataset.IWSLT2016Dataset mindspore.dataset.IWSLT2016Dataset
mindspore.dataset.IWSLT2017Dataset mindspore.dataset.IWSLT2017Dataset
mindspore.dataset.Multi30kDataset
mindspore.dataset.PennTreebankDataset mindspore.dataset.PennTreebankDataset
mindspore.dataset.SogouNewsDataset mindspore.dataset.SogouNewsDataset
mindspore.dataset.SQuADDataset
mindspore.dataset.SST2Dataset mindspore.dataset.SST2Dataset
mindspore.dataset.TextFileDataset mindspore.dataset.TextFileDataset
mindspore.dataset.UDPOSDataset mindspore.dataset.UDPOSDataset
@ -165,6 +171,9 @@ mindspore.dataset
:nosignatures: :nosignatures:
:template: classtemplate_inherited.rst :template: classtemplate_inherited.rst
mindspore.dataset.CMUArcticDataset
mindspore.dataset.GTZANDataset
mindspore.dataset.LibriTTSDataset
mindspore.dataset.LJSpeechDataset mindspore.dataset.LJSpeechDataset
mindspore.dataset.SpeechCommandsDataset mindspore.dataset.SpeechCommandsDataset
mindspore.dataset.TedliumDataset mindspore.dataset.TedliumDataset

View File

@ -122,7 +122,13 @@ API样例中常用的导入模块如下
:nosignatures: :nosignatures:
:template: classtemplate.rst :template: classtemplate.rst
mindspore.dataset.vision.AdjustBrightness
mindspore.dataset.vision.AdjustContrast
mindspore.dataset.vision.AdjustGamma mindspore.dataset.vision.AdjustGamma
mindspore.dataset.vision.AdjustHue
mindspore.dataset.vision.AdjustSaturation
mindspore.dataset.vision.AdjustSharpness
mindspore.dataset.vision.Affine
mindspore.dataset.vision.AutoAugment mindspore.dataset.vision.AutoAugment
mindspore.dataset.vision.AutoContrast mindspore.dataset.vision.AutoContrast
mindspore.dataset.vision.BoundingBoxAugment mindspore.dataset.vision.BoundingBoxAugment
@ -133,6 +139,7 @@ API样例中常用的导入模块如下
mindspore.dataset.vision.CutOut mindspore.dataset.vision.CutOut
mindspore.dataset.vision.Decode mindspore.dataset.vision.Decode
mindspore.dataset.vision.Equalize mindspore.dataset.vision.Equalize
mindspore.dataset.vision.Erase
mindspore.dataset.vision.FiveCrop mindspore.dataset.vision.FiveCrop
mindspore.dataset.vision.GaussianBlur mindspore.dataset.vision.GaussianBlur
mindspore.dataset.vision.Grayscale mindspore.dataset.vision.Grayscale
@ -147,6 +154,9 @@ API样例中常用的导入模块如下
mindspore.dataset.vision.NormalizePad mindspore.dataset.vision.NormalizePad
mindspore.dataset.vision.Pad mindspore.dataset.vision.Pad
mindspore.dataset.vision.PadToSize mindspore.dataset.vision.PadToSize
mindspore.dataset.vision.Perspective
mindspore.dataset.vision.Posterize
mindspore.dataset.vision.RandAugment
mindspore.dataset.vision.RandomAdjustSharpness mindspore.dataset.vision.RandomAdjustSharpness
mindspore.dataset.vision.RandomAffine mindspore.dataset.vision.RandomAffine
mindspore.dataset.vision.RandomAutoContrast mindspore.dataset.vision.RandomAutoContrast
@ -176,15 +186,18 @@ API样例中常用的导入模块如下
mindspore.dataset.vision.RandomVerticalFlipWithBBox mindspore.dataset.vision.RandomVerticalFlipWithBBox
mindspore.dataset.vision.Rescale mindspore.dataset.vision.Rescale
mindspore.dataset.vision.Resize mindspore.dataset.vision.Resize
mindspore.dataset.vision.ResizedCrop
mindspore.dataset.vision.ResizeWithBBox mindspore.dataset.vision.ResizeWithBBox
mindspore.dataset.vision.RgbToHsv mindspore.dataset.vision.RgbToHsv
mindspore.dataset.vision.Rotate mindspore.dataset.vision.Rotate
mindspore.dataset.vision.SlicePatches mindspore.dataset.vision.SlicePatches
mindspore.dataset.vision.Solarize
mindspore.dataset.vision.TenCrop mindspore.dataset.vision.TenCrop
mindspore.dataset.vision.ToNumpy mindspore.dataset.vision.ToNumpy
mindspore.dataset.vision.ToPIL mindspore.dataset.vision.ToPIL
mindspore.dataset.vision.ToTensor mindspore.dataset.vision.ToTensor
mindspore.dataset.vision.ToType mindspore.dataset.vision.ToType
mindspore.dataset.vision.TrivialAugmentWide
mindspore.dataset.vision.UniformAugment mindspore.dataset.vision.UniformAugment
mindspore.dataset.vision.VerticalFlip mindspore.dataset.vision.VerticalFlip
@ -375,6 +388,7 @@ API样例中常用的导入模块如下
mindspore.dataset.audio.Dither mindspore.dataset.audio.Dither
mindspore.dataset.audio.EqualizerBiquad mindspore.dataset.audio.EqualizerBiquad
mindspore.dataset.audio.Fade mindspore.dataset.audio.Fade
mindspore.dataset.audio.Filtfilt
mindspore.dataset.audio.Flanger mindspore.dataset.audio.Flanger
mindspore.dataset.audio.FrequencyMasking mindspore.dataset.audio.FrequencyMasking
mindspore.dataset.audio.Gain mindspore.dataset.audio.Gain
@ -429,4 +443,5 @@ API样例中常用的导入模块如下
mindspore.dataset.audio.ScaleType mindspore.dataset.audio.ScaleType
mindspore.dataset.audio.WindowType mindspore.dataset.audio.WindowType
mindspore.dataset.audio.create_dct mindspore.dataset.audio.create_dct
mindspore.dataset.audio.linear_fbanks
mindspore.dataset.audio.melscale_fbanks mindspore.dataset.audio.melscale_fbanks

View File

@ -26,9 +26,13 @@ Vision
mindspore.dataset.Flowers102Dataset mindspore.dataset.Flowers102Dataset
mindspore.dataset.Food101Dataset mindspore.dataset.Food101Dataset
mindspore.dataset.ImageFolderDataset mindspore.dataset.ImageFolderDataset
mindspore.dataset.KITTIDataset
mindspore.dataset.KMnistDataset mindspore.dataset.KMnistDataset
mindspore.dataset.LFWDataset
mindspore.dataset.LSUNDataset
mindspore.dataset.ManifestDataset mindspore.dataset.ManifestDataset
mindspore.dataset.MnistDataset mindspore.dataset.MnistDataset
mindspore.dataset.OmniglotDataset
mindspore.dataset.PhotoTourDataset mindspore.dataset.PhotoTourDataset
mindspore.dataset.Places365Dataset mindspore.dataset.Places365Dataset
mindspore.dataset.QMnistDataset mindspore.dataset.QMnistDataset
@ -55,14 +59,15 @@ Text
mindspore.dataset.AmazonReviewDataset mindspore.dataset.AmazonReviewDataset
mindspore.dataset.CLUEDataset mindspore.dataset.CLUEDataset
mindspore.dataset.CoNLL2000Dataset mindspore.dataset.CoNLL2000Dataset
mindspore.dataset.CSVDataset
mindspore.dataset.DBpediaDataset mindspore.dataset.DBpediaDataset
mindspore.dataset.EnWik9Dataset mindspore.dataset.EnWik9Dataset
mindspore.dataset.IMDBDataset mindspore.dataset.IMDBDataset
mindspore.dataset.IWSLT2016Dataset mindspore.dataset.IWSLT2016Dataset
mindspore.dataset.IWSLT2017Dataset mindspore.dataset.IWSLT2017Dataset
mindspore.dataset.Multi30kDataset
mindspore.dataset.PennTreebankDataset mindspore.dataset.PennTreebankDataset
mindspore.dataset.SogouNewsDataset mindspore.dataset.SogouNewsDataset
mindspore.dataset.SQuADDataset
mindspore.dataset.SST2Dataset mindspore.dataset.SST2Dataset
mindspore.dataset.TextFileDataset mindspore.dataset.TextFileDataset
mindspore.dataset.UDPOSDataset mindspore.dataset.UDPOSDataset
@ -78,6 +83,9 @@ Audio
:nosignatures: :nosignatures:
:template: classtemplate_dataset.rst :template: classtemplate_dataset.rst
mindspore.dataset.CMUArcticDataset
mindspore.dataset.GTZANDataset
mindspore.dataset.LibriTTSDataset
mindspore.dataset.LJSpeechDataset mindspore.dataset.LJSpeechDataset
mindspore.dataset.SpeechCommandsDataset mindspore.dataset.SpeechCommandsDataset
mindspore.dataset.TedliumDataset mindspore.dataset.TedliumDataset

View File

@ -51,7 +51,13 @@ Transforms
:nosignatures: :nosignatures:
:template: classtemplate.rst :template: classtemplate.rst
mindspore.dataset.vision.AdjustBrightness
mindspore.dataset.vision.AdjustContrast
mindspore.dataset.vision.AdjustGamma mindspore.dataset.vision.AdjustGamma
mindspore.dataset.vision.AdjustHue
mindspore.dataset.vision.AdjustSaturation
mindspore.dataset.vision.AdjustSharpness
mindspore.dataset.vision.Affine
mindspore.dataset.vision.AutoAugment mindspore.dataset.vision.AutoAugment
mindspore.dataset.vision.AutoContrast mindspore.dataset.vision.AutoContrast
mindspore.dataset.vision.BoundingBoxAugment mindspore.dataset.vision.BoundingBoxAugment
@ -62,6 +68,7 @@ Transforms
mindspore.dataset.vision.CutOut mindspore.dataset.vision.CutOut
mindspore.dataset.vision.Decode mindspore.dataset.vision.Decode
mindspore.dataset.vision.Equalize mindspore.dataset.vision.Equalize
mindspore.dataset.vision.Erase
mindspore.dataset.vision.FiveCrop mindspore.dataset.vision.FiveCrop
mindspore.dataset.vision.GaussianBlur mindspore.dataset.vision.GaussianBlur
mindspore.dataset.vision.Grayscale mindspore.dataset.vision.Grayscale
@ -76,6 +83,9 @@ Transforms
mindspore.dataset.vision.NormalizePad mindspore.dataset.vision.NormalizePad
mindspore.dataset.vision.Pad mindspore.dataset.vision.Pad
mindspore.dataset.vision.PadToSize mindspore.dataset.vision.PadToSize
mindspore.dataset.vision.Perspective
mindspore.dataset.vision.Posterize
mindspore.dataset.vision.RandAugment
mindspore.dataset.vision.RandomAdjustSharpness mindspore.dataset.vision.RandomAdjustSharpness
mindspore.dataset.vision.RandomAffine mindspore.dataset.vision.RandomAffine
mindspore.dataset.vision.RandomAutoContrast mindspore.dataset.vision.RandomAutoContrast
@ -105,15 +115,18 @@ Transforms
mindspore.dataset.vision.RandomVerticalFlipWithBBox mindspore.dataset.vision.RandomVerticalFlipWithBBox
mindspore.dataset.vision.Rescale mindspore.dataset.vision.Rescale
mindspore.dataset.vision.Resize mindspore.dataset.vision.Resize
mindspore.dataset.vision.ResizedCrop
mindspore.dataset.vision.ResizeWithBBox mindspore.dataset.vision.ResizeWithBBox
mindspore.dataset.vision.RgbToHsv mindspore.dataset.vision.RgbToHsv
mindspore.dataset.vision.Rotate mindspore.dataset.vision.Rotate
mindspore.dataset.vision.SlicePatches mindspore.dataset.vision.SlicePatches
mindspore.dataset.vision.Solarize
mindspore.dataset.vision.TenCrop mindspore.dataset.vision.TenCrop
mindspore.dataset.vision.ToNumpy mindspore.dataset.vision.ToNumpy
mindspore.dataset.vision.ToPIL mindspore.dataset.vision.ToPIL
mindspore.dataset.vision.ToTensor mindspore.dataset.vision.ToTensor
mindspore.dataset.vision.ToType mindspore.dataset.vision.ToType
mindspore.dataset.vision.TrivialAugmentWide
mindspore.dataset.vision.UniformAugment mindspore.dataset.vision.UniformAugment
mindspore.dataset.vision.VerticalFlip mindspore.dataset.vision.VerticalFlip
@ -232,6 +245,7 @@ Transforms
mindspore.dataset.audio.Dither mindspore.dataset.audio.Dither
mindspore.dataset.audio.EqualizerBiquad mindspore.dataset.audio.EqualizerBiquad
mindspore.dataset.audio.Fade mindspore.dataset.audio.Fade
mindspore.dataset.audio.Filtfilt
mindspore.dataset.audio.Flanger mindspore.dataset.audio.Flanger
mindspore.dataset.audio.FrequencyMasking mindspore.dataset.audio.FrequencyMasking
mindspore.dataset.audio.Gain mindspore.dataset.audio.Gain
@ -287,4 +301,5 @@ Utilities
mindspore.dataset.audio.ScaleType mindspore.dataset.audio.ScaleType
mindspore.dataset.audio.WindowType mindspore.dataset.audio.WindowType
mindspore.dataset.audio.create_dct mindspore.dataset.audio.create_dct
mindspore.dataset.audio.linear_fbanks
mindspore.dataset.audio.melscale_fbanks mindspore.dataset.audio.melscale_fbanks

View File

@ -66,8 +66,8 @@ from mindspore.dataset.audio import transforms
from mindspore.dataset.audio import utils from mindspore.dataset.audio import utils
from mindspore.dataset.audio.transforms import AllpassBiquad, AmplitudeToDB, Angle, BandBiquad, \ from mindspore.dataset.audio.transforms import AllpassBiquad, AmplitudeToDB, Angle, BandBiquad, \
BandpassBiquad, BandrejectBiquad, BassBiquad, Biquad, ComplexNorm, ComputeDeltas, Contrast, DBToAmplitude, \ BandpassBiquad, BandrejectBiquad, BassBiquad, Biquad, ComplexNorm, ComputeDeltas, Contrast, DBToAmplitude, \
DCShift, DeemphBiquad, DetectPitchFrequency, Dither, EqualizerBiquad, Fade, Flanger, FrequencyMasking, Gain, \ DCShift, DeemphBiquad, DetectPitchFrequency, Dither, EqualizerBiquad, Fade, Filtfilt, Flanger, FrequencyMasking, \
GriffinLim, HighpassBiquad, InverseMelScale, InverseSpectrogram, LFCC, LFilter, LowpassBiquad, Magphase, \ Gain, GriffinLim, HighpassBiquad, InverseMelScale, InverseSpectrogram, LFCC, LFilter, LowpassBiquad, Magphase, \
MaskAlongAxis, MaskAlongAxisIID, MelScale, MelSpectrogram, MFCC, MuLawDecoding, MuLawEncoding, Overdrive, \ MaskAlongAxis, MaskAlongAxisIID, MelScale, MelSpectrogram, MFCC, MuLawDecoding, MuLawEncoding, Overdrive, \
Phaser, PhaseVocoder, PitchShift, Resample, RiaaBiquad, SlidingWindowCmn, SpectralCentroid, Spectrogram, \ Phaser, PhaseVocoder, PitchShift, Resample, RiaaBiquad, SlidingWindowCmn, SpectralCentroid, Spectrogram, \
TimeMasking, TimeStretch, TrebleBiquad, Vad, Vol TimeMasking, TimeStretch, TrebleBiquad, Vad, Vol

View File

@ -106,10 +106,10 @@ __all__ = ["Caltech101Dataset", # Vision
"GeneratorDataset", # User Defined "GeneratorDataset", # User Defined
"NumpySlicesDataset", # User Defined "NumpySlicesDataset", # User Defined
"PaddedDataset", # User Defined "PaddedDataset", # User Defined
"GraphData", # Graph Data "GraphData", # Graph
"Graph", # Graph "Graph", # Graph
"InMemoryGraphDataset", # InMemoryGraphDataset "InMemoryGraphDataset", # Graph
"ArgoverseDataset", # ArgoverseDataset "ArgoverseDataset", # Graph
"DistributedSampler", # Sampler "DistributedSampler", # Sampler
"RandomSampler", # Sampler "RandomSampler", # Sampler
"SequentialSampler", # Sampler "SequentialSampler", # Sampler