mindspore.ops ============= operators that can be used for constructor function of Cell .. code-block:: import mindspore.ops as ops Compared with the previous version, the added, deleted and supported platforms change information of `mindspore.ops` operators in MindSpore, please refer to the link ``_. Operator Primitives ------------------- .. autosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Primitive mindspore.ops.PrimitiveWithCheck mindspore.ops.PrimitiveWithInfer Decorators ---------- .. autosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.constexpr mindspore.ops.custom_info_register mindspore.ops.ms_kernel mindspore.ops.op_info_register mindspore.ops.prim_attr_register Neural Network Layer Operators ------------------------------ Neural Network ^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.AvgPool mindspore.ops.AvgPool3D mindspore.ops.BasicLSTMCell mindspore.ops.BatchNorm mindspore.ops.Conv2D mindspore.ops.Conv2DBackpropInput mindspore.ops.Conv2DTranspose mindspore.ops.Conv3D mindspore.ops.Conv3DTranspose mindspore.ops.CTCGreedyDecoder 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.Flatten mindspore.ops.LayerNorm mindspore.ops.LRN mindspore.ops.LSTM mindspore.ops.MaxPool mindspore.ops.MaxPool3D mindspore.ops.MaxPoolWithArgmax mindspore.ops.MirrorPad mindspore.ops.Pad mindspore.ops.EmbeddingLookup mindspore.ops.Padding mindspore.ops.ResizeNearestNeighbor mindspore.ops.ResizeBilinear Loss Function ^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.BCEWithLogitsLoss mindspore.ops.BinaryCrossEntropy mindspore.ops.CTCLoss mindspore.ops.KLDivLoss mindspore.ops.L2Loss mindspore.ops.NLLLoss mindspore.ops.RNNTLoss mindspore.ops.SigmoidCrossEntropyWithLogits mindspore.ops.SmoothL1Loss mindspore.ops.SoftMarginLoss mindspore.ops.SoftmaxCrossEntropyWithLogits mindspore.ops.SparseSoftmaxCrossEntropyWithLogits Activation Function ^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Elu mindspore.ops.FastGeLU mindspore.ops.GeLU mindspore.ops.HShrink mindspore.ops.HSigmoid mindspore.ops.HSwish mindspore.ops.LogSoftmax mindspore.ops.Mish mindspore.ops.PReLU mindspore.ops.ReLU mindspore.ops.ReLU6 mindspore.ops.ReLUV2 mindspore.ops.SeLU mindspore.ops.Sigmoid mindspore.ops.Softmax mindspore.ops.Softplus mindspore.ops.SoftShrink mindspore.ops.Softsign mindspore.ops.Tanh Optimizer ^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst 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.ApplyFtrl mindspore.ops.ApplyGradientDescent mindspore.ops.ApplyMomentum mindspore.ops.ApplyPowerSign mindspore.ops.ApplyProximalAdagrad mindspore.ops.ApplyProximalGradientDescent mindspore.ops.ApplyRMSProp mindspore.ops.FusedSparseAdam mindspore.ops.FusedSparseFtrl mindspore.ops.FusedSparseLazyAdam mindspore.ops.FusedSparseProximalAdagrad mindspore.ops.LARSUpdate mindspore.ops.SparseApplyAdagrad mindspore.ops.SparseApplyAdagradV2 mindspore.ops.SparseApplyProximalAdagrad mindspore.ops.SGD mindspore.ops.SparseApplyFtrl mindspore.ops.SparseApplyFtrlV2 Distance Function ^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Cdist mindspore.ops.EditDistance mindspore.ops.LpNorm Sampling Operator ^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.ComputeAccidentalHits mindspore.ops.LogUniformCandidateSampler mindspore.ops.UniformCandidateSampler Image Processing ^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.BoundingBoxDecode mindspore.ops.BoundingBoxEncode mindspore.ops.CheckValid mindspore.ops.CropAndResize mindspore.ops.ExtractVolumePatches mindspore.ops.IOU mindspore.ops.L2Normalize mindspore.ops.NMSWithMask mindspore.ops.ROIAlign Text Processing ^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.NoRepeatNGram Mathematical Operators ---------------------- Element-wise Operator ^^^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Abs mindspore.ops.AccumulateNV2 mindspore.ops.ACos mindspore.ops.Acosh mindspore.ops.Add mindspore.ops.Addcdiv mindspore.ops.Addcmul mindspore.ops.AddN mindspore.ops.Asin mindspore.ops.Asinh mindspore.ops.Atan mindspore.ops.Atan2 mindspore.ops.Atanh mindspore.ops.BesselI0e mindspore.ops.BesselI1e mindspore.ops.BitwiseAnd mindspore.ops.BitwiseOr mindspore.ops.BitwiseXor mindspore.ops.Ceil mindspore.ops.Conj mindspore.ops.Cos mindspore.ops.Cosh mindspore.ops.Div mindspore.ops.DivNoNan mindspore.ops.Einsum mindspore.ops.Erf mindspore.ops.Erfc mindspore.ops.Erfinv mindspore.ops.Exp mindspore.ops.Expm1 mindspore.ops.Floor mindspore.ops.FloorDiv mindspore.ops.FloorMod mindspore.ops.Imag mindspore.ops.Inv mindspore.ops.Invert mindspore.ops.Lerp mindspore.ops.Log mindspore.ops.Log1p mindspore.ops.LogicalAnd mindspore.ops.LogicalNot mindspore.ops.LogicalOr mindspore.ops.Mod mindspore.ops.Mul mindspore.ops.MulNoNan mindspore.ops.Neg mindspore.ops.Pow mindspore.ops.Real mindspore.ops.RealDiv mindspore.ops.Reciprocal mindspore.ops.Rint 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.Trunc mindspore.ops.TruncateDiv mindspore.ops.TruncateMod mindspore.ops.Xdivy mindspore.ops.Xlogy Reduction Operator ^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Argmax mindspore.ops.ArgMaxWithValue mindspore.ops.Argmin mindspore.ops.ArgMinWithValue mindspore.ops.ReduceAll mindspore.ops.ReduceAny mindspore.ops.ReduceMax mindspore.ops.ReduceMean mindspore.ops.ReduceMin mindspore.ops.ReduceProd mindspore.ops.ReduceSum Comparison Operator ^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.ApproximateEqual mindspore.ops.CheckBprop mindspore.ops.Equal mindspore.ops.EqualCount mindspore.ops.Greater mindspore.ops.GreaterEqual mindspore.ops.InTopK mindspore.ops.IsFinite mindspore.ops.IsInf mindspore.ops.IsInstance mindspore.ops.IsNan mindspore.ops.IsSubClass mindspore.ops.Less mindspore.ops.LessEqual mindspore.ops.Maximum mindspore.ops.Minimum mindspore.ops.NotEqual mindspore.ops.SameTypeShape mindspore.ops.TopK Linear Algebraic Operator ^^^^^^^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.BatchMatMul mindspore.ops.BiasAdd mindspore.ops.Ger mindspore.ops.MatMul mindspore.ops.MatrixInverse Tensor Operation Operator -------------------------- Tensor Construction ^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Eps mindspore.ops.Eye mindspore.ops.Fill mindspore.ops.LinSpace mindspore.ops.OneHot mindspore.ops.Ones mindspore.ops.OnesLike mindspore.ops.Zeros mindspore.ops.ZerosLike Random Generation Operator ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Gamma mindspore.ops.Multinomial mindspore.ops.Poisson mindspore.ops.RandomCategorical mindspore.ops.RandomChoiceWithMask mindspore.ops.Randperm mindspore.ops.StandardLaplace mindspore.ops.StandardNormal mindspore.ops.UniformInt mindspore.ops.UniformReal Array Operation ^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.BatchToSpace mindspore.ops.BatchToSpaceND mindspore.ops.BroadcastTo mindspore.ops.Cast mindspore.ops.Concat mindspore.ops.CumProd mindspore.ops.CumSum mindspore.ops.DataFormatDimMap mindspore.ops.DepthToSpace mindspore.ops.DType mindspore.ops.DynamicShape mindspore.ops.ExpandDims mindspore.ops.FloatStatus mindspore.ops.Gather mindspore.ops.GatherD mindspore.ops.GatherNd mindspore.ops.HistogramFixedWidth mindspore.ops.Identity mindspore.ops.IndexAdd mindspore.ops.InplaceAdd mindspore.ops.InplaceSub mindspore.ops.InplaceUpdate mindspore.ops.InvertPermutation mindspore.ops.MaskedFill mindspore.ops.MaskedSelect mindspore.ops.Meshgrid mindspore.ops.ParallelConcat mindspore.ops.PopulationCount mindspore.ops.Range mindspore.ops.Rank mindspore.ops.Reshape mindspore.ops.ReverseSequence mindspore.ops.ReverseV2 mindspore.ops.ScatterNd 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.SparseGatherV2 mindspore.ops.Split mindspore.ops.SplitV mindspore.ops.Squeeze mindspore.ops.Stack mindspore.ops.StridedSlice mindspore.ops.TensorScatterAdd mindspore.ops.TensorScatterDiv mindspore.ops.TensorScatterMax mindspore.ops.TensorScatterMin mindspore.ops.TensorScatterMul mindspore.ops.TensorScatterSub mindspore.ops.TensorScatterUpdate mindspore.ops.TensorShape mindspore.ops.Tile mindspore.ops.Transpose mindspore.ops.Unique mindspore.ops.UniqueWithPad mindspore.ops.UnsortedSegmentMax mindspore.ops.UnsortedSegmentMin mindspore.ops.UnsortedSegmentProd mindspore.ops.UnsortedSegmentSum mindspore.ops.Unstack Type Conversion ^^^^^^^^^^^^^^^ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.ScalarCast mindspore.ops.ScalarToArray mindspore.ops.ScalarToTensor mindspore.ops.TupleToArray Parameter Operation Operator ---------------------------- .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Assign mindspore.ops.AssignAdd mindspore.ops.AssignSub mindspore.ops.ScatterAdd mindspore.ops.ScatterDiv mindspore.ops.ScatterMax mindspore.ops.ScatterMin mindspore.ops.ScatterMul mindspore.ops.ScatterNdAdd mindspore.ops.ScatterNdSub mindspore.ops.ScatterNdUpdate mindspore.ops.ScatterNonAliasingAdd mindspore.ops.ScatterSub mindspore.ops.ScatterUpdate Data Operation Operator ----------------------- .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.GetNext Communication Operator ---------------------- Note that the APIs in the following list need to preset communication environment variables. For the Ascend devices, users need to prepare the rank table, set rank_id and device_id. Please see the `Ascend tutorial \ `_ for more details. For the GPU device, users need to prepare the host file and mpi, please see the `GPU tutorial \ `_. .. msplatformautosummary:: :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 Debugging Operator ------------------ .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.HistogramSummary mindspore.ops.ImageSummary mindspore.ops.ScalarSummary mindspore.ops.TensorSummary mindspore.ops.Print mindspore.ops.NPUAllocFloatStatus mindspore.ops.NPUClearFloatStatus mindspore.ops.NPUGetFloatStatus Sparse Operator --------------- .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.SparseTensorDenseMatmul mindspore.ops.SparseToDense Other Operators --------------- .. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Depend mindspore.ops.GradOperation mindspore.ops.HookBackward mindspore.ops.HyperMap mindspore.ops.InsertGradientOf mindspore.ops.Map mindspore.ops.MultitypeFuncGraph mindspore.ops.Partial Operator Information Registration --------------------------------- .. autosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.AiCPURegOp mindspore.ops.CustomRegOp mindspore.ops.DataType mindspore.ops.TBERegOp mindspore.ops.get_vm_impl_fn Customizing Operator -------------------- .. autosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst mindspore.ops.Custom