modify functional pagedisplay

This commit is contained in:
huodagu 2022-03-31 16:40:42 +08:00
parent 8dcfafda1a
commit 1a5433fa24
2 changed files with 298 additions and 173 deletions

View File

@ -33,6 +33,27 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
# True
# Tensor[Int32]
神经网络层算子
----------------
激活函数
^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.tanh
- Refer to :class:`mindspore.ops.Tanh`.
数学运算算子
----------------
逐元素运算
^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
@ -53,12 +74,6 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
- 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
@ -70,117 +85,81 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
* - 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`.
- Refer to :class:`mindspore.ops.BitwiseXor`.
* - 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.invert
- Refer to :class:`mindspore.ops.Invert`.
* - 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.sin
- Refer to :class:`mindspore.ops.Sin`.
* - mindspore.ops.sinh
- Refer to :class:`mindspore.ops.Sinh`.
* - mindspore.ops.sqrt
- Refer to :class:`mindspore.ops.Sqrt`.
* - mindspore.ops.square
- Refer to :class:`mindspore.ops.Square`.
* - mindspore.ops.sub
- Refer to :class:`mindspore.ops.Sub`.
* - mindspore.ops.tan
- Refer to :class:`mindspore.ops.Tan`.
* - 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_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_sub
- Refer to :class:`mindspore.ops.Sub`.
Reduction算子
^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.reduce_max
- Refer to :class:`mindspore.ops.ReduceMax`.
* - mindspore.ops.reduce_mean
@ -191,14 +170,241 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
- 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`.
比较算子
^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.check_bprop
- Refer to :class:`mindspore.ops.CheckBprop`.
* - mindspore.ops.equal
- Refer to :class:`mindspore.ops.Equal`.
* - mindspore.ops.ge
- Refer to :class:`mindspore.ops.GreaterEqual`.
* - mindspore.ops.gt
- Refer to :class:`mindspore.ops.Greater`.
* - mindspore.ops.le
- Refer to :class:`mindspore.ops.LessEqual`.
* - mindspore.ops.less
- Refer to :class:`mindspore.ops.Less`.
* - 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.maximum
- Refer to :class:`mindspore.ops.Maximum`.
* - mindspore.ops.minimum
- Refer to :class:`mindspore.ops.Minimum`.
* - mindspore.ops.not_equal
- Refer to :class:`mindspore.ops.NotEqual`.
* - 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.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`.
线性代数算子
^^^^^^^^^^^^^
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.matmul
Parameter操作算子
--------------------
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - 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.scatter_nd_update
- Refer to :class:`mindspore.ops.ScatterNdUpdate`.
* - mindspore.ops.scatter_update
- Refer to :class:`mindspore.ops.ScatterUpdate`.
调试算子
----------------
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.print\_
- Refer to :class:`mindspore.ops.Print`.
Tensor操作算子
----------------
Tensor创建
^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.eye
- Refer to :class:`mindspore.ops.Eye`.
* - mindspore.ops.fill
- Refer to :class:`mindspore.ops.Fill`.
* - mindspore.ops.ones_like
- Refer to :class:`mindspore.ops.OnesLike`.
* - mindspore.ops.zeros_like
- Refer to :class:`mindspore.ops.ZerosLike`.
随机生成算子
^^^^^^^^^^^^^^^^
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.gamma
mindspore.ops.multinomial
mindspore.ops.poisson
Array操作
^^^^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.cast
- Refer to :class:`mindspore.ops.Cast`.
* - mindspore.ops.cumprod
- Refer to :class:`mindspore.ops.CumProd`.
* - mindspore.ops.cumsum
- Refer to :class:`mindspore.ops.CumSum`.
* - mindspore.ops.dtype
- Refer to :class:`mindspore.ops.DType`.
* - mindspore.ops.expand_dims
- Refer to :class:`mindspore.ops.ExpandDims`.
* - 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.rank
- Refer to :class:`mindspore.ops.Rank`.
* - mindspore.ops.reshape
- Refer to :class:`mindspore.ops.Reshape`.
* - mindspore.ops.scatter_nd
- Refer to :class:`mindspore.ops.ScatterNd`.
* - mindspore.ops.shape
- Refer to :class:`mindspore.ops.Shape`.
* - mindspore.ops.size
- Refer to :class:`mindspore.ops.Size`.
* - mindspore.ops.sort
- Refer to :class:`mindspore.ops.Sort`.
* - mindspore.ops.squeeze
- Refer to :class:`mindspore.ops.Squeeze`.
* - mindspore.ops.stack
- Refer to :class:`mindspore.ops.Stack`.
* - mindspore.ops.strided_slice
- Refer to :class:`mindspore.ops.StridedSlice`.
* - 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.tile
- Refer to :class:`mindspore.ops.Tile`.
* - mindspore.ops.transpose
- Refer to :class:`mindspore.ops.Transpose`.
.. mscnplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst
mindspore.ops.select
mindspore.ops.unique
类型转换
^^^^^^^^^^^^^^^^
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - mindspore.ops.scalar_cast
- Refer to :class:`mindspore.ops.ScalarCast`.
* - mindspore.ops.scalar_to_array
- Refer to :class:`mindspore.ops.ScalarToArray`.
* - mindspore.ops.scalar_to_tensor
- Refer to :class:`mindspore.ops.ScalarToTensor`.
* - mindspore.ops.tuple_to_array
- Refer to :class:`mindspore.ops.TupleToArray`.
其他算子
----------------
.. list-table::
:widths: 50 50
:header-rows: 1
* - functional
- Description
* - 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.depend
- Refer to :class:`mindspore.ops.Depend`.
* - 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.not_in_dict
- Determine whether the object is not in the dict.
* - mindspore.ops.partial
- Refer to :class:`mindspore.ops.Partial`.
* - mindspore.ops.scalar_add
- Get the sum of two numbers. (Usage is the same as "+" in Python)
* - 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
@ -225,96 +431,20 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
- 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/beginner/autograd.html#stopping-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`.
.. mscnplatformautosummary::
:toctree: ops
@ -329,19 +459,13 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
mindspore.ops.count_nonzero
mindspore.ops.cummin
mindspore.ops.dot
mindspore.ops.gamma
mindspore.ops.grad
mindspore.ops.jvp
mindspore.ops.laplace
mindspore.ops.matmul
mindspore.ops.multinomial
mindspore.ops.narrow
mindspore.ops.normal
mindspore.ops.poisson
mindspore.ops.repeat_elements
mindspore.ops.select
mindspore.ops.sequence_mask
mindspore.ops.tensor_dot
mindspore.ops.uniform
mindspore.ops.vjp
mindspore.ops.unique

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, reuse_result=True)
创建PrimiveWithInfer算子用于在编译时推断值。可以用它定义函数从而使用构造函数中的常量计算出常量值。
@ -9,4 +9,5 @@ mindspore.ops.constexpr
- **fn** (function) - `fn` 用作输出算子的infer_value。默认值None。
- **get_instance** (bool) - 如果为True返回算子的实例否则返回算子的类。默认值True。
- **name** (str) - 定义算子的名称。如果 `name` 为None则使用函数名称作为算子名称。默认值None。
- **name** (str) - 定义算子的名称。如果 `name` 为None则使用函数名称作为算子名称。默认值None。
- **reuse_result** (bool) - 如果为True仅实际执行算子一次后续调用会直接返回结果。否则每次都实际执行算子来获取结果。默认值True。