!29989 modify cn_api.

Merge pull request !29989 from zhangyi/code_docs_master
This commit is contained in:
i-robot 2022-02-14 08:54:31 +00:00 committed by Gitee
commit 658eb0c44f
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
23 changed files with 1625 additions and 77 deletions

View File

@ -0,0 +1,5 @@
mindspore.boost
================
.. automodule:: mindspore.boost
:members:

View File

@ -129,3 +129,6 @@ mindspore.common.initializer
- **TypeError** - 参数 `init` 的类型不正确。
- **ValueError** - 当 `init` 传入Tensor对象时 `init` 的shape与形参 `shape` 内的数值不一致。
.. automodule:: mindspore.common.initializer
:members:

View File

@ -0,0 +1,14 @@
mindspore.compression
=====================
mindspore.compression.quant
---------------------------
.. automodule:: mindspore.compression.quant
:members:
mindspore.compression.common
----------------------------
.. automodule:: mindspore.compression.common
:members:

View File

@ -0,0 +1,5 @@
mindspore.dataset.config
========================
.. automodule:: mindspore.dataset.config
:members:

View File

@ -29,30 +29,84 @@ mindspore.dataset
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.Caltech101Dataset
mindspore.dataset.Caltech256Dataset
mindspore.dataset.CelebADataset
mindspore.dataset.Cifar10Dataset
mindspore.dataset.Cifar100Dataset
mindspore.dataset.CityscapesDataset
mindspore.dataset.CocoDataset
mindspore.dataset.DIV2KDataset
mindspore.dataset.EMnistDataset
mindspore.dataset.FakeImageDataset
mindspore.dataset.FashionMnistDataset
mindspore.dataset.FlickrDataset
mindspore.dataset.Flowers102Dataset
mindspore.dataset.ImageFolderDataset
mindspore.dataset.KMnistDataset
mindspore.dataset.ManifestDataset
mindspore.dataset.MnistDataset
mindspore.dataset.PhotoTourDataset
mindspore.dataset.Places365Dataset
mindspore.dataset.QMnistDataset
mindspore.dataset.SBDataset
mindspore.dataset.SBUDataset
mindspore.dataset.SemeionDataset
mindspore.dataset.STL10Dataset
mindspore.dataset.SVHNDataset
mindspore.dataset.USPSDataset
mindspore.dataset.VOCDataset
mindspore.dataset.WIDERFaceDataset
文本
----
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.AGNewsDataset
mindspore.dataset.AmazonReviewDataset
mindspore.dataset.CLUEDataset
mindspore.dataset.CoNLL2000Dataset
mindspore.dataset.CSVDataset
mindspore.dataset.DBpediaDataset
mindspore.dataset.EnWik9Dataset
mindspore.dataset.IMDBDataset
mindspore.dataset.IWSLT2016Dataset
mindspore.dataset.IWSLT2017Dataset
mindspore.dataset.PennTreebankDataset
mindspore.dataset.SogouNewsDataset
mindspore.dataset.TextFileDataset
mindspore.dataset.UDPOSDataset
mindspore.dataset.WikiTextDataset
mindspore.dataset.YahooAnswersDataset
mindspore.dataset.YelpReviewDataset
音频
------
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.LJSpeechDataset
mindspore.dataset.SpeechCommandsDataset
mindspore.dataset.TedliumDataset
mindspore.dataset.YesNoDataset
标准格式
--------
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.CSVDataset
mindspore.dataset.MindDataset
@ -63,10 +117,13 @@ mindspore.dataset
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.GeneratorDataset
mindspore.dataset.NumpySlicesDataset
mindspore.dataset.PaddedDataset
mindspore.dataset.RandomDataset
---
@ -97,11 +154,17 @@ mindspore.dataset
.. cnmsautosummary::
:toctree: dataset
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.dataset.BatchInfo
mindspore.dataset.DatasetCache
mindspore.dataset.DSCallback
mindspore.dataset.SamplingStrategy
mindspore.dataset.Schema
mindspore.dataset.Shuffle
mindspore.dataset.WaitedDSCallback
mindspore.dataset.OutputFormat
mindspore.dataset.compare
mindspore.dataset.deserialize
mindspore.dataset.serialize

View File

@ -0,0 +1,50 @@
mindspore.dataset.text
======================
.. automodule:: mindspore.dataset.text
mindspore.dataset.text.transforms
---------------------------------
.. cnmsnoteautosummary::
:toctree: dataset_text
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.text.transforms.BasicTokenizer
mindspore.dataset.text.transforms.BertTokenizer
mindspore.dataset.text.transforms.CaseFold
mindspore.dataset.text.transforms.JiebaTokenizer
mindspore.dataset.text.transforms.Lookup
mindspore.dataset.text.transforms.Ngram
mindspore.dataset.text.transforms.NormalizeUTF8
mindspore.dataset.text.transforms.PythonTokenizer
mindspore.dataset.text.transforms.RegexReplace
mindspore.dataset.text.transforms.RegexTokenizer
mindspore.dataset.text.transforms.SentencePieceTokenizer
mindspore.dataset.text.transforms.SlidingWindow
mindspore.dataset.text.transforms.ToNumber
mindspore.dataset.text.transforms.TruncateSequencePair
mindspore.dataset.text.transforms.UnicodeCharTokenizer
mindspore.dataset.text.transforms.UnicodeScriptTokenizer
mindspore.dataset.text.transforms.WhitespaceTokenizer
mindspore.dataset.text.transforms.WordpieceTokenizer
mindspore.dataset.text.utils
----------------------------
.. cnmsnoteautosummary::
:toctree: dataset_text
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.text.JiebaMode
mindspore.dataset.text.NormalizeForm
mindspore.dataset.text.SentencePieceModel
mindspore.dataset.text.SentencePieceVocab
mindspore.dataset.text.SPieceTokenizerLoadType
mindspore.dataset.text.SPieceTokenizerOutType
mindspore.dataset.text.to_str
mindspore.dataset.text.to_bytes
mindspore.dataset.text.Vocab

View File

@ -0,0 +1,40 @@
mindspore.dataset.transforms
============================
.. automodule:: mindspore.dataset.transforms
mindspore.dataset.transforms.c_transforms
-----------------------------------------
.. cnmsautosummary::
:toctree: dataset_transforms
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.transforms.c_transforms.Compose
mindspore.dataset.transforms.c_transforms.Concatenate
mindspore.dataset.transforms.c_transforms.Duplicate
mindspore.dataset.transforms.c_transforms.Fill
mindspore.dataset.transforms.c_transforms.Mask
mindspore.dataset.transforms.c_transforms.OneHot
mindspore.dataset.transforms.c_transforms.PadEnd
mindspore.dataset.transforms.c_transforms.RandomApply
mindspore.dataset.transforms.c_transforms.RandomChoice
mindspore.dataset.transforms.c_transforms.Relational
mindspore.dataset.transforms.c_transforms.Slice
mindspore.dataset.transforms.c_transforms.TypeCast
mindspore.dataset.transforms.c_transforms.Unique
mindspore.dataset.transforms.py_transforms
------------------------------------------
.. cnmsautosummary::
:toctree: dataset_transforms
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.transforms.py_transforms.Compose
mindspore.dataset.transforms.py_transforms.OneHotOp
mindspore.dataset.transforms.py_transforms.RandomApply
mindspore.dataset.transforms.py_transforms.RandomChoice
mindspore.dataset.transforms.py_transforms.RandomOrder

View File

@ -0,0 +1,115 @@
mindspore.dataset.vision
===================================
.. automodule:: mindspore.dataset.vision
mindspore.dataset.vision.c_transforms
------------------------------------------------
.. cnmsautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.vision.c_transforms.AutoContrast
mindspore.dataset.vision.c_transforms.BoundingBoxAugment
mindspore.dataset.vision.c_transforms.CenterCrop
mindspore.dataset.vision.c_transforms.ConvertColor
mindspore.dataset.vision.c_transforms.Crop
mindspore.dataset.vision.c_transforms.CutMixBatch
mindspore.dataset.vision.c_transforms.CutOut
mindspore.dataset.vision.c_transforms.Decode
mindspore.dataset.vision.c_transforms.Equalize
mindspore.dataset.vision.c_transforms.GaussianBlur
mindspore.dataset.vision.c_transforms.HorizontalFlip
mindspore.dataset.vision.c_transforms.HWC2CHW
mindspore.dataset.vision.c_transforms.Invert
mindspore.dataset.vision.c_transforms.MixUpBatch
mindspore.dataset.vision.c_transforms.Normalize
mindspore.dataset.vision.c_transforms.NormalizePad
mindspore.dataset.vision.c_transforms.Pad
mindspore.dataset.vision.c_transforms.RandomAffine
mindspore.dataset.vision.c_transforms.RandomColor
mindspore.dataset.vision.c_transforms.RandomColorAdjust
mindspore.dataset.vision.c_transforms.RandomCrop
mindspore.dataset.vision.c_transforms.RandomCropDecodeResize
mindspore.dataset.vision.c_transforms.RandomCropWithBBox
mindspore.dataset.vision.c_transforms.RandomHorizontalFlip
mindspore.dataset.vision.c_transforms.RandomHorizontalFlipWithBBox
mindspore.dataset.vision.c_transforms.RandomPosterize
mindspore.dataset.vision.c_transforms.RandomResize
mindspore.dataset.vision.c_transforms.RandomResizedCrop
mindspore.dataset.vision.c_transforms.RandomResizedCropWithBBox
mindspore.dataset.vision.c_transforms.RandomResizeWithBBox
mindspore.dataset.vision.c_transforms.RandomRotation
mindspore.dataset.vision.c_transforms.RandomSelectSubpolicy
mindspore.dataset.vision.c_transforms.RandomSharpness
mindspore.dataset.vision.c_transforms.RandomSolarize
mindspore.dataset.vision.c_transforms.RandomVerticalFlip
mindspore.dataset.vision.c_transforms.RandomVerticalFlipWithBBox
mindspore.dataset.vision.c_transforms.Rescale
mindspore.dataset.vision.c_transforms.Resize
mindspore.dataset.vision.c_transforms.ResizeWithBBox
mindspore.dataset.vision.c_transforms.Rotate
mindspore.dataset.vision.c_transforms.SlicePatches
mindspore.dataset.vision.c_transforms.SoftDvppDecodeRandomCropResizeJpeg
mindspore.dataset.vision.c_transforms.SoftDvppDecodeResizeJpeg
mindspore.dataset.vision.c_transforms.UniformAugment
mindspore.dataset.vision.c_transforms.VerticalFlip
mindspore.dataset.vision.py_transforms
-------------------------------------------------
.. cnmsautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.vision.py_transforms.AutoContrast
mindspore.dataset.vision.py_transforms.CenterCrop
mindspore.dataset.vision.py_transforms.Cutout
mindspore.dataset.vision.py_transforms.Decode
mindspore.dataset.vision.py_transforms.Equalize
mindspore.dataset.vision.py_transforms.FiveCrop
mindspore.dataset.vision.py_transforms.Grayscale
mindspore.dataset.vision.py_transforms.HsvToRgb
mindspore.dataset.vision.py_transforms.HWC2CHW
mindspore.dataset.vision.py_transforms.Invert
mindspore.dataset.vision.py_transforms.LinearTransformation
mindspore.dataset.vision.py_transforms.MixUp
mindspore.dataset.vision.py_transforms.Normalize
mindspore.dataset.vision.py_transforms.NormalizePad
mindspore.dataset.vision.py_transforms.Pad
mindspore.dataset.vision.py_transforms.RandomAffine
mindspore.dataset.vision.py_transforms.RandomColor
mindspore.dataset.vision.py_transforms.RandomColorAdjust
mindspore.dataset.vision.py_transforms.RandomCrop
mindspore.dataset.vision.py_transforms.RandomErasing
mindspore.dataset.vision.py_transforms.RandomGrayscale
mindspore.dataset.vision.py_transforms.RandomHorizontalFlip
mindspore.dataset.vision.py_transforms.RandomPerspective
mindspore.dataset.vision.py_transforms.RandomResizedCrop
mindspore.dataset.vision.py_transforms.RandomRotation
mindspore.dataset.vision.py_transforms.RandomSharpness
mindspore.dataset.vision.py_transforms.RandomVerticalFlip
mindspore.dataset.vision.py_transforms.Resize
mindspore.dataset.vision.py_transforms.RgbToHsv
mindspore.dataset.vision.py_transforms.TenCrop
mindspore.dataset.vision.py_transforms.ToPIL
mindspore.dataset.vision.py_transforms.ToTensor
mindspore.dataset.vision.py_transforms.ToType
mindspore.dataset.vision.py_transforms.UniformAugment
mindspore.dataset.vision.utils
-------------------------------
.. cnmsautosummary::
:toctree: dataset_vision
:nosignatures:
:template: classtemplate.rst
mindspore.dataset.vision.Border
mindspore.dataset.vision.ConvertMode
mindspore.dataset.vision.ImageBatchFormat
mindspore.dataset.vision.Inter
mindspore.dataset.vision.SliceMode

View File

@ -0,0 +1,5 @@
mindspore.mindrecord
====================
.. automodule:: mindspore.mindrecord
:members:

View File

@ -12,8 +12,11 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.Cell
mindspore.nn.GraphCell
容器
-----------
@ -46,24 +49,60 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
mindspore.nn.Jvp
mindspore.nn.Vjp
循环层
--------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.GRUCell
mindspore.nn.GRU
mindspore.nn.LSTMCell
mindspore.nn.LSTM
mindspore.nn.RNNCell
mindspore.nn.RNN
稀疏层
-------------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.Embedding
mindspore.nn.EmbeddingLookup
mindspore.nn.MultiFieldEmbeddingLookup
mindspore.nn.SparseToDense
mindspore.nn.SparseTensorDenseMatmul
非线性激活函数
--------------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.CELU
mindspore.nn.ELU
mindspore.nn.FastGelu
mindspore.nn.GELU
mindspore.nn.get_activation
mindspore.nn.HShrink
mindspore.nn.HSigmoid
mindspore.nn.HSwish
mindspore.nn.LeakyReLU
mindspore.nn.LogSigmoid
mindspore.nn.LogSoftmax
mindspore.nn.PReLU
mindspore.nn.ReLU
mindspore.nn.ReLU6
mindspore.nn.Sigmoid
mindspore.nn.Softmax
mindspore.nn.SoftShrink
mindspore.nn.Tanh
工具
@ -71,30 +110,128 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.ClipByNorm
mindspore.nn.Dense
mindspore.nn.Dropout
mindspore.nn.Flatten
mindspore.nn.L1Regularizer
mindspore.nn.Norm
mindspore.nn.OneHot
mindspore.nn.Pad
mindspore.nn.Range
mindspore.nn.ResizeBilinear
mindspore.nn.Roll
mindspore.nn.Tril
mindspore.nn.Triu
mindspore.nn.Unfold
图像函数
--------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.CentralCrop
mindspore.nn.ImageGradients
mindspore.nn.MSSSIM
mindspore.nn.PSNR
mindspore.nn.SSIM
归一化层
---------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.BatchNorm1d
mindspore.nn.BatchNorm2d
mindspore.nn.BatchNorm3d
mindspore.nn.GlobalBatchNorm
mindspore.nn.GroupNorm
mindspore.nn.InstanceNorm2d
mindspore.nn.LayerNorm
mindspore.nn.MatrixDiag
mindspore.nn.MatrixDiagPart
mindspore.nn.MatrixSetDiag
mindspore.nn.SyncBatchNorm
池化层
--------------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.AvgPool1d
mindspore.nn.AvgPool2d
mindspore.nn.MaxPool1d
mindspore.nn.MaxPool2d
量化函数
-------------------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.ActQuant
mindspore.nn.Conv2dBnAct
mindspore.nn.Conv2dBnFoldQuant
mindspore.nn.Conv2dBnFoldQuantOneConv
mindspore.nn.Conv2dBnWithoutFoldQuant
mindspore.nn.Conv2dQuant
mindspore.nn.DenseBnAct
mindspore.nn.DenseQuant
mindspore.nn.FakeQuantWithMinMaxObserver
mindspore.nn.MulQuant
mindspore.nn.TensorAddQuant
损失函数
--------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.BCELoss
mindspore.nn.BCEWithLogitsLoss
mindspore.nn.CosineEmbeddingLoss
mindspore.nn.DiceLoss
mindspore.nn.FocalLoss
mindspore.nn.L1Loss
mindspore.nn.LossBase
mindspore.nn.MSELoss
mindspore.nn.MultiClassDiceLoss
mindspore.nn.RMSELoss
mindspore.nn.SampledSoftmaxLoss
mindspore.nn.SmoothL1Loss
mindspore.nn.SoftMarginLoss
mindspore.nn.SoftmaxCrossEntropyWithLogits
优化器
-------
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.Adagrad
mindspore.nn.Adam
mindspore.nn.AdamOffload
mindspore.nn.AdamWeightDecay
mindspore.nn.ASGD
mindspore.nn.FTRL
mindspore.nn.Lamb
mindspore.nn.LARS
@ -103,6 +240,7 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
mindspore.nn.Optimizer
mindspore.nn.ProximalAdagrad
mindspore.nn.RMSProp
mindspore.nn.Rprop
mindspore.nn.SGD
mindspore.nn.thor
@ -111,15 +249,22 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.DistributedGradReducer
mindspore.nn.DynamicLossScaleUpdateCell
mindspore.nn.FixedLossScaleUpdateCell
mindspore.nn.ForwardValueAndGrad
mindspore.nn.GetNextSingleOp
mindspore.nn.MicroBatchInterleaved
mindspore.nn.ParameterUpdate
mindspore.nn.PipelineCell
mindspore.nn.TimeDistributed
mindspore.nn.TrainOneStepCell
mindspore.nn.TrainOneStepWithLossScaleCell
mindspore.nn.WithEvalCell
mindspore.nn.WithGradCell
mindspore.nn.WithLossCell
数学函数
@ -127,26 +272,44 @@ MindSpore中 `mindspore.nn` 接口与上一版本相比,新增、删除和支
.. cnmsplatformautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.MatMul
mindspore.nn.Moments
mindspore.nn.ReduceLogSumExp
评估指标
--------
.. cnmsautosummary::
:toctree: nn
:nosignatures:
:template: classtemplate.rst
mindspore.nn.Accuracy
mindspore.nn.auc
mindspore.nn.BleuScore
mindspore.nn.ConfusionMatrix
mindspore.nn.ConfusionMatrixMetric
mindspore.nn.CosineSimilarity
mindspore.nn.Dice
mindspore.nn.F1
mindspore.nn.Fbeta
mindspore.nn.HausdorffDistance
mindspore.nn.get_metric_fn
mindspore.nn.Loss
mindspore.nn.MAE
mindspore.nn.MeanSurfaceDistance
mindspore.nn.Metric
mindspore.nn.MSE
mindspore.nn.names
mindspore.nn.OcclusionSensitivity
mindspore.nn.Perplexity
mindspore.nn.Precision
mindspore.nn.Recall
mindspore.nn.ROC
mindspore.nn.RootMeanSquareDistance
mindspore.nn.rearrange_inputs
mindspore.nn.Top1CategoricalAccuracy
mindspore.nn.Top5CategoricalAccuracy

View File

@ -0,0 +1,5 @@
mindspore.nn.transformer
========================
.. automodule:: mindspore.nn.transformer
:members:

View File

@ -0,0 +1,266 @@
mindspore.numpy
===============
.. automodule:: mindspore.numpy
Array Generation
----------------
.. cnmsplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.numpy.arange
mindspore.numpy.array
mindspore.numpy.asarray
mindspore.numpy.asfarray
mindspore.numpy.bartlett
mindspore.numpy.blackman
mindspore.numpy.copy
mindspore.numpy.diag
mindspore.numpy.diag_indices
mindspore.numpy.diagflat
mindspore.numpy.diagonal
mindspore.numpy.empty
mindspore.numpy.empty_like
mindspore.numpy.eye
mindspore.numpy.full
mindspore.numpy.full_like
mindspore.numpy.geomspace
mindspore.numpy.hamming
mindspore.numpy.hanning
mindspore.numpy.histogram_bin_edges
mindspore.numpy.identity
mindspore.numpy.indices
mindspore.numpy.ix_
mindspore.numpy.linspace
mindspore.numpy.logspace
mindspore.numpy.meshgrid
mindspore.numpy.mgrid
mindspore.numpy.ogrid
mindspore.numpy.ones
mindspore.numpy.ones_like
mindspore.numpy.pad
mindspore.numpy.trace
mindspore.numpy.tri
mindspore.numpy.tril
mindspore.numpy.tril_indices
mindspore.numpy.tril_indices_from
mindspore.numpy.triu
mindspore.numpy.triu_indices
mindspore.numpy.triu_indices_from
mindspore.numpy.vander
mindspore.numpy.zeros
mindspore.numpy.zeros_like
Array Operation
---------------
.. cnmsplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.numpy.append
mindspore.numpy.apply_along_axis
mindspore.numpy.apply_over_axes
mindspore.numpy.array_split
mindspore.numpy.array_str
mindspore.numpy.atleast_1d
mindspore.numpy.atleast_2d
mindspore.numpy.atleast_3d
mindspore.numpy.broadcast_arrays
mindspore.numpy.broadcast_to
mindspore.numpy.choose
mindspore.numpy.column_stack
mindspore.numpy.concatenate
mindspore.numpy.dsplit
mindspore.numpy.dstack
mindspore.numpy.expand_dims
mindspore.numpy.flip
mindspore.numpy.fliplr
mindspore.numpy.flipud
mindspore.numpy.hsplit
mindspore.numpy.hstack
mindspore.numpy.moveaxis
mindspore.numpy.piecewise
mindspore.numpy.ravel
mindspore.numpy.repeat
mindspore.numpy.reshape
mindspore.numpy.roll
mindspore.numpy.rollaxis
mindspore.numpy.rot90
mindspore.numpy.select
mindspore.numpy.size
mindspore.numpy.split
mindspore.numpy.squeeze
mindspore.numpy.stack
mindspore.numpy.swapaxes
mindspore.numpy.take
mindspore.numpy.take_along_axis
mindspore.numpy.tile
mindspore.numpy.transpose
mindspore.numpy.unique
mindspore.numpy.unravel_index
mindspore.numpy.vsplit
mindspore.numpy.vstack
mindspore.numpy.where
Logic
-----
.. cnmsplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.numpy.array_equal
mindspore.numpy.array_equiv
mindspore.numpy.equal
mindspore.numpy.greater
mindspore.numpy.greater_equal
mindspore.numpy.in1d
mindspore.numpy.isclose
mindspore.numpy.isfinite
mindspore.numpy.isin
mindspore.numpy.isinf
mindspore.numpy.isnan
mindspore.numpy.isneginf
mindspore.numpy.isposinf
mindspore.numpy.isscalar
mindspore.numpy.less
mindspore.numpy.less_equal
mindspore.numpy.logical_and
mindspore.numpy.logical_not
mindspore.numpy.logical_or
mindspore.numpy.logical_xor
mindspore.numpy.not_equal
mindspore.numpy.signbit
mindspore.numpy.sometrue
Math
----
.. cnmsplatformautosummary::
:toctree: numpy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.numpy.absolute
mindspore.numpy.add
mindspore.numpy.amax
mindspore.numpy.amin
mindspore.numpy.arccos
mindspore.numpy.arccosh
mindspore.numpy.arcsin
mindspore.numpy.arcsinh
mindspore.numpy.arctan
mindspore.numpy.arctan2
mindspore.numpy.arctanh
mindspore.numpy.argmax
mindspore.numpy.argmin
mindspore.numpy.around
mindspore.numpy.average
mindspore.numpy.bincount
mindspore.numpy.bitwise_and
mindspore.numpy.bitwise_or
mindspore.numpy.bitwise_xor
mindspore.numpy.cbrt
mindspore.numpy.ceil
mindspore.numpy.clip
mindspore.numpy.convolve
mindspore.numpy.copysign
mindspore.numpy.corrcoef
mindspore.numpy.correlate
mindspore.numpy.cos
mindspore.numpy.cosh
mindspore.numpy.count_nonzero
mindspore.numpy.cov
mindspore.numpy.cross
mindspore.numpy.cumprod
mindspore.numpy.cumsum
mindspore.numpy.deg2rad
mindspore.numpy.diff
mindspore.numpy.digitize
mindspore.numpy.divide
mindspore.numpy.divmod
mindspore.numpy.dot
mindspore.numpy.ediff1d
mindspore.numpy.exp
mindspore.numpy.exp2
mindspore.numpy.expm1
mindspore.numpy.fix
mindspore.numpy.float_power
mindspore.numpy.floor
mindspore.numpy.floor_divide
mindspore.numpy.fmod
mindspore.numpy.gcd
mindspore.numpy.gradient
mindspore.numpy.heaviside
mindspore.numpy.histogram
mindspore.numpy.histogram2d
mindspore.numpy.histogramdd
mindspore.numpy.hypot
mindspore.numpy.inner
mindspore.numpy.interp
mindspore.numpy.invert
mindspore.numpy.kron
mindspore.numpy.lcm
mindspore.numpy.log
mindspore.numpy.log10
mindspore.numpy.log1p
mindspore.numpy.log2
mindspore.numpy.logaddexp
mindspore.numpy.logaddexp2
mindspore.numpy.matmul
mindspore.numpy.matrix_power
mindspore.numpy.maximum
mindspore.numpy.mean
mindspore.numpy.minimum
mindspore.numpy.multi_dot
mindspore.numpy.multiply
mindspore.numpy.nancumsum
mindspore.numpy.nanmax
mindspore.numpy.nanmean
mindspore.numpy.nanmin
mindspore.numpy.nanstd
mindspore.numpy.nansum
mindspore.numpy.nanvar
mindspore.numpy.negative
mindspore.numpy.norm
mindspore.numpy.outer
mindspore.numpy.polyadd
mindspore.numpy.polyder
mindspore.numpy.polyint
mindspore.numpy.polymul
mindspore.numpy.polysub
mindspore.numpy.polyval
mindspore.numpy.positive
mindspore.numpy.power
mindspore.numpy.promote_types
mindspore.numpy.ptp
mindspore.numpy.rad2deg
mindspore.numpy.radians
mindspore.numpy.ravel_multi_index
mindspore.numpy.reciprocal
mindspore.numpy.remainder
mindspore.numpy.result_type
mindspore.numpy.rint
mindspore.numpy.searchsorted
mindspore.numpy.sign
mindspore.numpy.sin
mindspore.numpy.sinh
mindspore.numpy.sqrt
mindspore.numpy.square
mindspore.numpy.std
mindspore.numpy.subtract
mindspore.numpy.sum
mindspore.numpy.tan
mindspore.numpy.tanh
mindspore.numpy.tensordot
mindspore.numpy.trapz
mindspore.numpy.true_divide
mindspore.numpy.trunc
mindspore.numpy.unwrap
mindspore.numpy.var

View File

@ -1,87 +1,376 @@
mindspore.ops
=============
可用于Cell的构造函数的算子。
.. include:: operations.rst
.. code-block::
组合算子
---------
import mindspore.ops as ops
MindSpore中 `mindspore.ops` 接口与上一版本相比,新增、删除和支持平台的变化信息请参考 `API Updates <https://gitee.com/mindspore/docs/blob/master/resource/api_updates/ops_api_updates.md>`_
operations
----------
神经网络算子
^^^^^^^^^^^^
operations中的Primitive算子在使用前需要实例化。
组合算子是预定义的算子组合。
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.BiasAdd
mindspore.ops.Elu
mindspore.ops.GeLU
mindspore.ops.L2Loss
mindspore.ops.L2Normalize
mindspore.ops.PReLU
mindspore.ops.ReLUV2
mindspore.ops.SeLU
mindspore.ops.Sigmoid
mindspore.ops.batch_dot
mindspore.ops.clip_by_global_norm
mindspore.ops.clip_by_value
mindspore.ops.core
mindspore.ops.count_nonzero
mindspore.ops.cummin
mindspore.ops.dot
mindspore.ops.gamma
mindspore.ops.GradOperation
mindspore.ops.HyperMap
mindspore.ops.laplace
mindspore.ops.Map
mindspore.ops.matmul
mindspore.ops.multinomial
mindspore.ops.MultitypeFuncGraph
mindspore.ops.normal
mindspore.ops.poisson
mindspore.ops.repeat_elements
mindspore.ops.sequence_mask
mindspore.ops.tensor_dot
mindspore.ops.uniform
Math类型算子
^^^^^^^^^^^^
functional算子
---------------
functional算子是经过初始化后的Primitive可以直接作为函数使用。functional算子的使用示例如下
.. code-block:: python
from mindspore import Tensor, ops
from mindspore import dtype as mstype
input_x = Tensor(-1, mstype.int32)
input_dict = {'x':1, 'y':2}
result_abs = ops.absolute(input_x)
print(result_abs)
result_in_dict = ops.in_dict('x', input_dict)
print(result_in_dict)
result_not_in_dict = ops.not_in_dict('x', input_dict)
print(result_not_in_dict)
result_isconstant = ops.isconstant(input_x)
print(result_isconstant)
result_typeof = ops.typeof(input_x)
print(result_typeof)
# outputs:
# 1
# True
# False
# True
# Tensor[Int32]
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.absolute
- Refer to :class:`mindspore.ops.Abs`.
* - mindspore.ops.acos
- Refer to :class:`mindspore.ops.ACos`.
* - mindspore.ops.acosh
- Refer to :class:`mindspore.ops.Acosh`.
* - mindspore.ops.add
- Refer to :class:`mindspore.ops.Add`.
* - mindspore.ops.addn
- Refer to :class:`mindspore.ops.AddN`.
* - mindspore.ops.asin
- Refer to :class:`mindspore.ops.Asin`.
* - mindspore.ops.asinh
- Refer to :class:`mindspore.ops.Asinh`.
* - mindspore.ops.assign
- Refer to :class:`mindspore.ops.Assign`.
* - mindspore.ops.assign_add
- Refer to :class:`mindspore.ops.AssignAdd`.
* - mindspore.ops.assign_sub
- Refer to :class:`mindspore.ops.AssignSub`.
* - mindspore.ops.atan
- Refer to :class:`mindspore.ops.Atan`.
* - mindspore.ops.atan2
- Refer to :class:`mindspore.ops.Atan2`.
* - mindspore.ops.atanh
- Refer to :class:`mindspore.ops.Atanh`.
* - mindspore.ops.bitwise_and
- Refer to :class:`mindspore.ops.BitwiseAnd`.
* - mindspore.ops.bitwise_or
- Refer to :class:`mindspore.ops.BitwiseOr`.
* - mindspore.ops.bitwise_xor
- Refer to :class:`mindspore.ops.BitwiseXor`.
* - mindspore.ops.bool_and
- Calculate the result of logical AND operation. (Usage is the same as "and" in Python)
* - mindspore.ops.bool_eq
- Determine whether the Boolean values are equal. (Usage is the same as "==" in Python)
* - mindspore.ops.bool_not
- Calculate the result of logical NOT operation. (Usage is the same as "not" in Python)
* - mindspore.ops.bool_or
- Calculate the result of logical OR operation. (Usage is the same as "or" in Python)
* - mindspore.ops.cast
- Refer to :class:`mindspore.ops.Cast`.
* - mindspore.ops.check_bprop
- Refer to :class:`mindspore.ops.CheckBprop`.
* - mindspore.ops.cos
- Refer to :class:`mindspore.ops.Cos`.
* - mindspore.ops.cosh
- Refer to :class:`mindspore.ops.Cosh`.
* - mindspore.ops.cumprod
- Refer to :class:`mindspore.ops.CumProd`.
* - mindspore.ops.cumsum
- Refer to :class:`mindspore.ops.CumSum`.
* - mindspore.ops.div
- Refer to :class:`mindspore.ops.RealDiv`.
* - mindspore.ops.depend
- Refer to :class:`mindspore.ops.Depend`.
* - mindspore.ops.dtype
- Refer to :class:`mindspore.ops.DType`.
* - mindspore.ops.erf
- Refer to :class:`mindspore.ops.Erf`.
* - mindspore.ops.erfc
- Refer to :class:`mindspore.ops.Erfc`.
* - mindspore.ops.eye
- Refer to :class:`mindspore.ops.Eye`.
* - mindspore.ops.equal
- Refer to :class:`mindspore.ops.Equal`.
* - mindspore.ops.expand_dims
- Refer to :class:`mindspore.ops.ExpandDims`.
* - mindspore.ops.exp
- Refer to :class:`mindspore.ops.Exp`.
* - mindspore.ops.fill
- Refer to :class:`mindspore.ops.Fill`.
* - mindspore.ops.floor
- Refer to :class:`mindspore.ops.Floor`.
* - mindspore.ops.floordiv
- Refer to :class:`mindspore.ops.FloorDiv`.
* - mindspore.ops.floormod
- Refer to :class:`mindspore.ops.FloorMod`.
* - mindspore.ops.gather
- Refer to :class:`mindspore.ops.Gather`.
* - mindspore.ops.gather_d
- Refer to :class:`mindspore.ops.GatherD`.
* - mindspore.ops.gather_nd
- Refer to :class:`mindspore.ops.GatherNd`.
* - mindspore.ops.ge
- Refer to :class:`mindspore.ops.GreaterEqual`.
* - mindspore.ops.gt
- Refer to :class:`mindspore.ops.Greater`.
* - mindspore.ops.invert
- Refer to :class:`mindspore.ops.Invert`.
* - mindspore.ops.in_dict
- Determine if a str in dict.
* - mindspore.ops.is_not
- Determine whether the input is not the same as the other one. (Usage is the same as "is not" in Python)
* - mindspore.ops.is\_
- Determine whether the input is the same as the other one. (Usage is the same as "is" in Python)
* - mindspore.ops.isconstant
- Determine whether the object is constant.
* - mindspore.ops.isfinite
- Refer to :class:`mindspore.ops.IsFinite`.
* - mindspore.ops.isinstance\_
- Refer to :class:`mindspore.ops.IsInstance`.
* - mindspore.ops.isnan
- Refer to :class:`mindspore.ops.IsNan`.
* - mindspore.ops.issubclass\_
- Refer to :class:`mindspore.ops.IsSubClass`.
* - mindspore.ops.log
- Refer to :class:`mindspore.ops.Log`.
* - mindspore.ops.logical_and
- Refer to :class:`mindspore.ops.LogicalAnd`.
* - mindspore.ops.le
- Refer to :class:`mindspore.ops.LessEqual`.
* - mindspore.ops.less
- Refer to :class:`mindspore.ops.Less`.
* - mindspore.ops.logical_and
- Refer to :class:`mindspore.ops.LogicalAnd`.
* - mindspore.ops.logical_not
- Refer to :class:`mindspore.ops.LogicalNot`.
* - mindspore.ops.logical_or
- Refer to :class:`mindspore.ops.LogicalOr`.
* - mindspore.ops.maximum
- Refer to :class:`mindspore.ops.Maximum`.
* - mindspore.ops.minimum
- Refer to :class:`mindspore.ops.Minimum`.
* - mindspore.ops.mul
- Refer to :class:`mindspore.ops.Mul`.
* - mindspore.ops.neg_tensor
- Refer to :class:`mindspore.ops.Neg`.
* - mindspore.ops.not_equal
- Refer to :class:`mindspore.ops.NotEqual`.
* - mindspore.ops.not_in_dict
- Determine whether the object is not in the dict.
* - mindspore.ops.ones_like
- Refer to :class:`mindspore.ops.OnesLike`.
* - mindspore.ops.partial
- Refer to :class:`mindspore.ops.Partial`.
* - mindspore.ops.pows
- Refer to :class:`mindspore.ops.Pow`.
* - mindspore.ops.print\_
- Refer to :class:`mindspore.ops.Print`.
* - mindspore.ops.rank
- Refer to :class:`mindspore.ops.Rank`.
* - mindspore.ops.reduce_max
- Refer to :class:`mindspore.ops.ReduceMax`.
* - mindspore.ops.reduce_mean
- Refer to :class:`mindspore.ops.ReduceMean`.
* - mindspore.ops.reduce_min
- Refer to :class:`mindspore.ops.ReduceMin`.
* - mindspore.ops.reduce_prod
- Refer to :class:`mindspore.ops.ReduceProd`.
* - mindspore.ops.reduce_sum
- Refer to :class:`mindspore.ops.ReduceSum`.
* - mindspore.ops.reshape
- Refer to :class:`mindspore.ops.Reshape`.
* - mindspore.ops.same_type_shape
- Refer to :class:`mindspore.ops.SameTypeShape`.
* - mindspore.ops.scalar_add
- Get the sum of two numbers. (Usage is the same as "+" in Python)
* - mindspore.ops.scalar_cast
- Refer to :class:`mindspore.ops.ScalarCast`.
* - mindspore.ops.scalar_div
- Get the quotient of dividing the first input number by the second input number. (Usage is the same as "/" in Python)
* - mindspore.ops.scalar_eq
- Determine whether two numbers are equal. (Usage is the same as "==" in Python)
* - mindspore.ops.scalar_floordiv
- Divide the first input number by the second input number and round down to the closest integer. (Usage is the same as "//" in Python)
* - mindspore.ops.scalar_ge
- Determine whether the number is greater than or equal to another number. (Usage is the same as ">=" in Python)
* - mindspore.ops.scalar_gt
- Determine whether the number is greater than another number. (Usage is the same as ">" in Python)
* - mindspore.ops.scalar_le
- Determine whether the number is less than or equal to another number. (Usage is the same as "<=" in Python)
* - mindspore.ops.scalar_log
- Get the natural logarithm of the input number.
* - mindspore.ops.scalar_lt
- Determine whether the number is less than another number. (Usage is the same as "<" in Python)
* - mindspore.ops.scalar_mod
- Get the remainder of dividing the first input number by the second input number. (Usage is the same as "%" in Python)
* - mindspore.ops.scalar_mul
- Get the product of the input two numbers. (Usage is the same as "*" in Python)
* - mindspore.ops.scalar_ne
- Determine whether two numbers are not equal. (Usage is the same as "!=" in Python)
* - mindspore.ops.scalar_pow
- Compute a number to the power of the second input number.
* - mindspore.ops.scalar_sub
- Subtract the second input number from the first input number. (Usage is the same as "-" in Python)
* - mindspore.ops.scalar_to_array
- Refer to :class:`mindspore.ops.ScalarToArray`.
* - mindspore.ops.scalar_to_tensor
- Refer to :class:`mindspore.ops.ScalarToTensor`.
* - mindspore.ops.scalar_uadd
- Get the positive value of the input number.
* - mindspore.ops.scalar_usub
- Get the negative value of the input number.
* - mindspore.ops.scatter_nd
- Refer to :class:`mindspore.ops.ScatterNd`.
* - mindspore.ops.scatter_nd_update
- Refer to :class:`mindspore.ops.ScatterNdUpdate`.
* - mindspore.ops.scatter_update
- Refer to :class:`mindspore.ops.ScatterUpdate`.
* - mindspore.ops.shape
- Refer to :class:`mindspore.ops.Shape`.
* - mindspore.ops.shape_mul
- The input of shape_mul must be shape multiply elements in tuple(shape).
* - mindspore.ops.sin
- Refer to :class:`mindspore.ops.Sin`.
* - mindspore.ops.sinh
- Refer to :class:`mindspore.ops.Sinh`.
* - mindspore.ops.size
- Refer to :class:`mindspore.ops.Size`.
* - mindspore.ops.sort
- Refer to :class:`mindspore.ops.Sort`.
* - mindspore.ops.sqrt
- Refer to :class:`mindspore.ops.Sqrt`.
* - mindspore.ops.square
- Refer to :class:`mindspore.ops.Square`.
* - mindspore.ops.squeeze
- Refer to :class:`mindspore.ops.Squeeze`.
* - mindspore.ops.stack
- Refer to :class:`mindspore.ops.Stack`.
* - mindspore.ops.stop_gradient
- Disable update during back propagation. (`stop_gradient <https://www.mindspore.cn/tutorials/en/master/autograd.html#stop-gradient>`_)
* - mindspore.ops.strided_slice
- Refer to :class:`mindspore.ops.StridedSlice`.
* - mindspore.ops.string_concat
- Concatenate two strings.
* - mindspore.ops.string_eq
- Determine if two strings are equal.
* - mindspore.ops.sub
- Refer to :class:`mindspore.ops.Sub`.
* - mindspore.ops.tan
- Refer to :class:`mindspore.ops.Tan`.
* - mindspore.ops.tanh
- Refer to :class:`mindspore.ops.Tanh`.
* - mindspore.ops.tensor_add
- Refer to :class:`mindspore.ops.Add`.
* - mindspore.ops.tensor_div
- Refer to :class:`mindspore.ops.RealDiv`.
* - mindspore.ops.tensor_exp
- Refer to :class:`mindspore.ops.Exp`.
* - mindspore.ops.tensor_expm1
- Refer to :class:`mindspore.ops.Expm1`.
* - mindspore.ops.tensor_floordiv
- Refer to :class:`mindspore.ops.FloorDiv`.
* - mindspore.ops.tensor_ge
- Refer to :class:`mindspore.ops.GreaterEqual`.
* - mindspore.ops.tensor_gt
- Refer to :class:`mindspore.ops.Greater`.
* - mindspore.ops.tensor_le
- Refer to :class:`mindspore.ops.LessEqual`.
* - mindspore.ops.tensor_lt
- Refer to :class:`mindspore.ops.Less`.
* - mindspore.ops.tensor_mod
- Refer to :class:`mindspore.ops.FloorMod`.
* - mindspore.ops.tensor_mul
- Refer to :class:`mindspore.ops.Mul`.
* - mindspore.ops.tensor_pow
- Refer to :class:`mindspore.ops.Pow`.
* - mindspore.ops.tensor_scatter_add
- Refer to :class:`mindspore.ops.TensorScatterAdd`.
* - mindspore.ops.tensor_scatter_update
- Refer to :class:`mindspore.ops.TensorScatterUpdate`.
* - mindspore.ops.tensor_slice
- Refer to :class:`mindspore.ops.Slice`.
* - mindspore.ops.tensor_sub
- Refer to :class:`mindspore.ops.Sub`.
* - mindspore.ops.tile
- Refer to :class:`mindspore.ops.Tile`.
* - mindspore.ops.transpose
- Refer to :class:`mindspore.ops.Transpose`.
* - mindspore.ops.tuple_to_array
- Refer to :class:`mindspore.ops.TupleToArray`.
* - mindspore.ops.typeof
- Get type of object.
* - mindspore.ops.zeros_like
- Refer to :class:`mindspore.ops.ZerosLike`.
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Add
mindspore.ops.AddN
mindspore.ops.Div
mindspore.ops.Eps
mindspore.ops.Erf
mindspore.ops.Greater
mindspore.ops.Inv
mindspore.ops.LessEqual
mindspore.ops.Log
mindspore.ops.MatMul
mindspore.ops.Mul
mindspore.ops.Pow
mindspore.ops.Sub
Array类型算子
^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
mindspore.ops.Eye
mindspore.ops.Fill
mindspore.ops.Gather
mindspore.ops.OnesLike
mindspore.ops.Reshape
mindspore.ops.Size
mindspore.ops.Squeeze
mindspore.ops.Tile
mindspore.ops.ZerosLike
Random类型算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
mindspore.ops.Gamma
mindspore.ops.UniformReal
mindspore.ops.grad
mindspore.ops.jvp
mindspore.ops.narrow
mindspore.ops.select
mindspore.ops.vjp
原语
----
-----
.. cnmsplatformautosummary::
.. autosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.constexpr
mindspore.ops.prim_attr_register
@ -89,20 +378,27 @@ Random类型算子
mindspore.ops.PrimitiveWithCheck
mindspore.ops.PrimitiveWithInfer
函数实现注册
--------------
----------------
.. cnmsplatformautosummary::
.. autosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.get_vm_impl_fn
算子信息注册
--------------
----------------
.. cnmsplatformautosummary::
.. autosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.AiCPURegOp
mindspore.ops.custom_info_register
mindspore.ops.CustomRegOp
mindspore.ops.DataType
mindspore.ops.op_info_register
mindspore.ops.TBERegOp

View File

@ -0,0 +1,14 @@
mindspore.parallel.nn
======================
Transformer接口的导入方式由 `mindspore.parallel.nn` 修改为 `mindspore.nn.transformer` ,这些接口的使用方式不变。
原始的导入方式将保留1-2个版本。你可以通过以下样例查看差异
::
# r1.5
from mindspore.parallel.nn import Transformer
# Current
from mindspore.nn.transformer import Transformer

View File

@ -0,0 +1,5 @@
mindspore.parallel
==================
.. automodule:: mindspore.parallel
:members:

View File

@ -118,3 +118,24 @@ MindData数据集处理
:toctree: mindspore
mindspore.run_check
调试
------
.. cnmsautosummary::
:toctree: mindspore
:nosignatures:
:template: classtemplate.rst
mindspore.set_dump
内存回收
----------
.. cnmsautosummary::
:toctree: mindspore
:nosignatures:
:template: classtemplate.rst
mindspore.ms_memory_recycle

View File

@ -0,0 +1,44 @@
mindspore.scipy
===============
.. automodule:: mindspore.scipy
mindspore.scipy.linalg
----------------------
.. cnmsplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.scipy.linalg.block_diag
mindspore.scipy.linalg.eigh
mindspore.scipy.linalg.inv
mindspore.scipy.linalg.lu
mindspore.scipy.linalg.lu_factor
mindspore.scipy.optimize
------------------------
.. automodule:: mindspore.scipy.optimize
.. cnmsplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.scipy.optimize.line_search
mindspore.scipy.optimize.minimize
mindspore.scipy.sparse.linalg
-----------------------------
.. automodule:: mindspore.scipy.sparse.linalg
.. cnmsplatformautosummary::
:toctree: scipy
:nosignatures:
:template: classtemplate_inherited.rst
mindspore.scipy.sparse.linalg.cg
mindspore.scipy.sparse.linalg.gmres

View File

@ -27,6 +27,9 @@ mindspore.train.callback
.. include:: train/mindspore.train.callback.LearningRateScheduler.rst
.. automodule:: mindspore.train.callback
:members:
mindspore.train.train_thor
--------------------------

View File

@ -0,0 +1,431 @@
operations
----------
神经网络算子
^^^^^^^^^^^^^^^^^^^^^^^^
operations中的Primitive算子在使用前需要实例化。
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Acosh
mindspore.ops.Adam
mindspore.ops.AdamNoUpdateParam
mindspore.ops.AdamWeightDecay
mindspore.ops.AdaptiveAvgPool2D
mindspore.ops.ApplyAdadelta
mindspore.ops.ApplyAdagrad
mindspore.ops.ApplyAdagradDA
mindspore.ops.ApplyAdagradV2
mindspore.ops.ApplyAdaMax
mindspore.ops.ApplyAddSign
mindspore.ops.ApplyCenteredRMSProp
mindspore.ops.ApplyGradientDescent
mindspore.ops.ApplyMomentum
mindspore.ops.ApplyPowerSign
mindspore.ops.ApplyProximalAdagrad
mindspore.ops.ApplyProximalGradientDescent
mindspore.ops.ApplyRMSProp
mindspore.ops.AvgPool
mindspore.ops.AvgPool3D
mindspore.ops.BasicLSTMCell
mindspore.ops.BatchNorm
mindspore.ops.BCEWithLogitsLoss
mindspore.ops.BiasAdd
mindspore.ops.BinaryCrossEntropy
mindspore.ops.ComputeAccidentalHits
mindspore.ops.Conv2D
mindspore.ops.Conv2DBackpropInput
mindspore.ops.Conv2DTranspose
mindspore.ops.Conv3D
mindspore.ops.Conv3DTranspose
mindspore.ops.CTCGreedyDecoder
mindspore.ops.CTCLoss
mindspore.ops.DataFormatDimMap
mindspore.ops.DepthwiseConv2dNative
mindspore.ops.Dropout
mindspore.ops.Dropout2D
mindspore.ops.Dropout3D
mindspore.ops.DropoutDoMask
mindspore.ops.DropoutGenMask
mindspore.ops.DynamicGRUV2
mindspore.ops.DynamicRNN
mindspore.ops.Elu
mindspore.ops.FastGeLU
mindspore.ops.Flatten
mindspore.ops.FloorMod
mindspore.ops.FusedSparseAdam
mindspore.ops.FusedSparseLazyAdam
mindspore.ops.FusedSparseProximalAdagrad
mindspore.ops.GeLU
mindspore.ops.GetNext
mindspore.ops.HShrink
mindspore.ops.HSigmoid
mindspore.ops.HSwish
mindspore.ops.KLDivLoss
mindspore.ops.L2Loss
mindspore.ops.L2Normalize
mindspore.ops.LARSUpdate
mindspore.ops.LayerNorm
mindspore.ops.LogSoftmax
mindspore.ops.LRN
mindspore.ops.LSTM
mindspore.ops.MaxPool
mindspore.ops.MaxPool3D
mindspore.ops.MaxPoolWithArgmax
mindspore.ops.MirrorPad
mindspore.ops.Mish
mindspore.ops.NLLLoss
mindspore.ops.OneHot
mindspore.ops.Pad
mindspore.ops.PReLU
mindspore.ops.ReLU
mindspore.ops.ReLU6
mindspore.ops.ReLUV2
mindspore.ops.ResizeBilinear
mindspore.ops.RNNTLoss
mindspore.ops.ROIAlign
mindspore.ops.SeLU
mindspore.ops.SGD
mindspore.ops.Sigmoid
mindspore.ops.SigmoidCrossEntropyWithLogits
mindspore.ops.SmoothL1Loss
mindspore.ops.SoftMarginLoss
mindspore.ops.Softmax
mindspore.ops.SoftmaxCrossEntropyWithLogits
mindspore.ops.Softplus
mindspore.ops.SoftShrink
mindspore.ops.Softsign
mindspore.ops.SparseApplyAdagrad
mindspore.ops.SparseApplyAdagradV2
mindspore.ops.SparseApplyProximalAdagrad
mindspore.ops.SparseSoftmaxCrossEntropyWithLogits
mindspore.ops.Stack
mindspore.ops.Tanh
mindspore.ops.TopK
mindspore.ops.Unstack
数学算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Abs
mindspore.ops.AccumulateNV2
mindspore.ops.ACos
mindspore.ops.Add
mindspore.ops.AddN
mindspore.ops.ApproximateEqual
mindspore.ops.Asin
mindspore.ops.Asinh
mindspore.ops.AssignAdd
mindspore.ops.AssignSub
mindspore.ops.Atan
mindspore.ops.Atan2
mindspore.ops.Atanh
mindspore.ops.BatchMatMul
mindspore.ops.BesselI0e
mindspore.ops.BesselI1e
mindspore.ops.BitwiseAnd
mindspore.ops.BitwiseOr
mindspore.ops.BitwiseXor
mindspore.ops.Cdist
mindspore.ops.Ceil
mindspore.ops.Conj
mindspore.ops.Cos
mindspore.ops.Cosh
mindspore.ops.CumProd
mindspore.ops.CumSum
mindspore.ops.Div
mindspore.ops.DivNoNan
mindspore.ops.Eps
mindspore.ops.Equal
mindspore.ops.EqualCount
mindspore.ops.Erf
mindspore.ops.Erfc
mindspore.ops.Erfinv
mindspore.ops.Exp
mindspore.ops.Expm1
mindspore.ops.FloatStatus
mindspore.ops.Floor
mindspore.ops.FloorDiv
mindspore.ops.Ger
mindspore.ops.Greater
mindspore.ops.GreaterEqual
mindspore.ops.HistogramFixedWidth
mindspore.ops.Imag
mindspore.ops.IndexAdd
mindspore.ops.InplaceAdd
mindspore.ops.InplaceSub
mindspore.ops.Inv
mindspore.ops.Invert
mindspore.ops.IsInf
mindspore.ops.IsNan
mindspore.ops.Lerp
mindspore.ops.Less
mindspore.ops.LessEqual
mindspore.ops.LinSpace
mindspore.ops.Log
mindspore.ops.Log1p
mindspore.ops.LogicalAnd
mindspore.ops.LogicalNot
mindspore.ops.LogicalOr
mindspore.ops.LpNorm
mindspore.ops.MatMul
mindspore.ops.MatrixInverse
mindspore.ops.Maximum
mindspore.ops.Minimum
mindspore.ops.Mod
mindspore.ops.Mul
mindspore.ops.MulNoNan
mindspore.ops.Neg
mindspore.ops.NMSWithMask
mindspore.ops.NotEqual
mindspore.ops.NPUAllocFloatStatus
mindspore.ops.NPUClearFloatStatus
mindspore.ops.NPUGetFloatStatus
mindspore.ops.Pow
mindspore.ops.Real
mindspore.ops.RealDiv
mindspore.ops.Reciprocal
mindspore.ops.ReduceAll
mindspore.ops.ReduceAny
mindspore.ops.ReduceMax
mindspore.ops.ReduceMean
mindspore.ops.ReduceMin
mindspore.ops.ReduceProd
mindspore.ops.ReduceSum
mindspore.ops.Round
mindspore.ops.Rsqrt
mindspore.ops.Sign
mindspore.ops.Sin
mindspore.ops.Sinh
mindspore.ops.Sqrt
mindspore.ops.Square
mindspore.ops.SquaredDifference
mindspore.ops.SquareSumAll
mindspore.ops.Sub
mindspore.ops.Tan
mindspore.ops.TruncateDiv
mindspore.ops.TruncateMod
mindspore.ops.Xdivy
mindspore.ops.Xlogy
数组算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.ApplyFtrl
mindspore.ops.Argmax
mindspore.ops.ArgMaxWithValue
mindspore.ops.Argmin
mindspore.ops.ArgMinWithValue
mindspore.ops.BatchToSpace
mindspore.ops.BatchToSpaceND
mindspore.ops.BroadcastTo
mindspore.ops.Cast
mindspore.ops.Concat
mindspore.ops.DepthToSpace
mindspore.ops.DType
mindspore.ops.DynamicShape
mindspore.ops.EditDistance
mindspore.ops.EmbeddingLookup
mindspore.ops.ExpandDims
mindspore.ops.ExtractVolumePatches
mindspore.ops.Eye
mindspore.ops.Fill
mindspore.ops.FusedSparseFtrl
mindspore.ops.Gather
mindspore.ops.GatherD
mindspore.ops.GatherNd
mindspore.ops.Identity
mindspore.ops.InplaceUpdate
mindspore.ops.InvertPermutation
mindspore.ops.IsFinite
mindspore.ops.IsInstance
mindspore.ops.IsSubClass
mindspore.ops.MaskedFill
mindspore.ops.MaskedSelect
mindspore.ops.Meshgrid
mindspore.ops.Ones
mindspore.ops.OnesLike
mindspore.ops.Padding
mindspore.ops.ParallelConcat
mindspore.ops.Randperm
mindspore.ops.Rank
mindspore.ops.Reshape
mindspore.ops.ResizeNearestNeighbor
mindspore.ops.ReverseSequence
mindspore.ops.ReverseV2
mindspore.ops.Rint
mindspore.ops.SameTypeShape
mindspore.ops.ScalarCast
mindspore.ops.ScalarToArray
mindspore.ops.ScalarToTensor
mindspore.ops.ScatterAdd
mindspore.ops.ScatterDiv
mindspore.ops.ScatterMax
mindspore.ops.ScatterMin
mindspore.ops.ScatterMul
mindspore.ops.ScatterNd
mindspore.ops.ScatterNdAdd
mindspore.ops.ScatterNdSub
mindspore.ops.ScatterNdUpdate
mindspore.ops.ScatterNonAliasingAdd
mindspore.ops.ScatterSub
mindspore.ops.ScatterUpdate
mindspore.ops.Select
mindspore.ops.Shape
mindspore.ops.Size
mindspore.ops.Slice
mindspore.ops.Sort
mindspore.ops.SpaceToBatch
mindspore.ops.SpaceToBatchND
mindspore.ops.SpaceToDepth
mindspore.ops.SparseApplyFtrl
mindspore.ops.SparseApplyFtrlV2
mindspore.ops.SparseGatherV2
mindspore.ops.Split
mindspore.ops.SplitV
mindspore.ops.Squeeze
mindspore.ops.StridedSlice
mindspore.ops.TensorScatterAdd
mindspore.ops.TensorScatterMax
mindspore.ops.TensorScatterMin
mindspore.ops.TensorScatterSub
mindspore.ops.TensorScatterUpdate
mindspore.ops.Tile
mindspore.ops.Transpose
mindspore.ops.TupleToArray
mindspore.ops.Unique
mindspore.ops.UniqueWithPad
mindspore.ops.UnsortedSegmentMax
mindspore.ops.UnsortedSegmentMin
mindspore.ops.UnsortedSegmentProd
mindspore.ops.UnsortedSegmentSum
mindspore.ops.Zeros
mindspore.ops.ZerosLike
通信算子
^^^^^^^^^^^^^^^^^^^^^^^
注意,以下列表中的接口需要先配置好通信环境变量。
针对Ascend设备用户需要准备rank表设置rank_id和device_id详见 `Ascend指导文档 \
<https://www.mindspore.cn/tutorials/zh-CN/master/intermediate/distributed_training/
distributed_training_ascend.html#id12>`_ 。
针对GPU设备用户需要准备host文件和mpi详见 `GPU指导文档 \
<https://www.mindspore.cn/tutorials/zh-CN/master/intermediate/distributed_training/distributed_training_gpu.html#id6>`_ 。
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.AllGather
mindspore.ops.AllReduce
mindspore.ops.AlltoAll
mindspore.ops.Broadcast
mindspore.ops.NeighborExchange
mindspore.ops.NeighborExchangeV2
mindspore.ops.ReduceOp
mindspore.ops.ReduceScatter
调试算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.HistogramSummary
mindspore.ops.HookBackward
mindspore.ops.ImageSummary
mindspore.ops.InsertGradientOf
mindspore.ops.Print
mindspore.ops.ScalarSummary
mindspore.ops.TensorSummary
随机算子
^^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Gamma
mindspore.ops.LogUniformCandidateSampler
mindspore.ops.Multinomial
mindspore.ops.Poisson
mindspore.ops.RandomCategorical
mindspore.ops.RandomChoiceWithMask
mindspore.ops.StandardLaplace
mindspore.ops.StandardNormal
mindspore.ops.UniformCandidateSampler
mindspore.ops.UniformInt
mindspore.ops.UniformReal
图像算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.CropAndResize
稀疏算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.SparseToDense
mindspore.ops.SparseTensorDenseMatmul
自定义算子
^^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Custom
其他算子
^^^^^^^^^^^^^^^
.. cnmsplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.Assign
mindspore.ops.BoundingBoxDecode
mindspore.ops.BoundingBoxEncode
mindspore.ops.CheckBprop
mindspore.ops.CheckValid
mindspore.ops.Depend
mindspore.ops.InTopK
mindspore.ops.IOU
mindspore.ops.NoRepeatNGram
mindspore.ops.Partial
mindspore.ops.PopulationCount

View File

@ -1,7 +1,7 @@
mindspore.ops.DataType
======================
.. py:class:: mindspore.ops.DataType:
.. py:class:: mindspore.ops.DataType
Ascend算子的dtype和format的多种组合。

View File

@ -1,7 +1,7 @@
mindspore.ops.constexpr
=======================
.. py:function:: mindspore.ops.constexpr(fn=None, get_instance=True, name=None):
.. py:function:: mindspore.ops.constexpr(fn=None, get_instance=True, name=None)
创建PrimiveWithInfer算子用于在编译时推断值。可以用它定义函数从而使用构造函数中的常量计算出常量值。
@ -9,4 +9,4 @@ mindspore.ops.constexpr
- **fn** (function) - `fn` 用作输出算子的infer_value。默认值None。
- **get_instance** (bool) - 如果为True返回算子的实例否则返回算子的类。默认值True。
- **name** (str) - 定义算子的名称。如果 `name` 为None则使用函数名称作为算子名称。默认值None。
- **name** (str) - 定义算子的名称。如果 `name` 为None则使用函数名称作为算子名称。默认值None。

View File

@ -1,7 +1,7 @@
mindspore.ops.get_vm_impl_fn
============================
.. py:function:: mindspore.ops.get_vm_impl_fn(prim):
.. py:function:: mindspore.ops.get_vm_impl_fn(prim)
通过Primitive对象或Primitive名称获取虚拟实现函数。

View File

@ -1,7 +1,7 @@
mindspore.ops.prim_attr_register
================================
.. py:function:: mindspore.ops.prim_attr_register(fn):
.. py:function:: mindspore.ops.prim_attr_register(fn)
Primitive属性的注册器。