mindspore 2.0.0a0__cp37-none-any.whl → 2.0.0rc1__cp37-none-any.whl

mindspore/ops/function/sparse_unary_func.py

@@ -28,7 +28,7 @@ def csr_cos(x: CSRTensor) -> CSRTensor:
         out_i = cos(x_i)
 
     .. warning::
-        If use Float64, there may be a problem of missing precision.
+        Currently support data types float16 and float32. If use Float64, there may be a problem of missing precision.
 
     Args:
         x (CSRTensor): Input CSRTensor.
@@ -78,7 +78,7 @@ def coo_cos(x: COOTensor) -> COOTensor:
     Raises:
         TypeError: If `x` is not a COOTensor.
         TypeError: If dtype of `x` is not float16, float32 or float64, complex64,
-    complex128.
+            complex128.
 
     Supported Platforms:
         ``Ascend`` ``GPU`` ``CPU``
@@ -115,7 +115,7 @@ def csr_tan(x: CSRTensor) -> CSRTensor:
         TypeError: If `x` is not a CSRTensor.
 
     Supported Platforms:
-        ``Ascend`` ``CPU`` ``GPU``
+        ``Ascend`` ``GPU`` ``CPU``
 
     Examples:
         >>> indptr = Tensor([0, 1, 2, 2], dtype=mstype.int32)
@@ -150,7 +150,7 @@ def coo_tan(x: COOTensor) -> COOTensor:
         TypeError: If `x` is not a COOTensor.
 
     Supported Platforms:
-        ``Ascend`` ``CPU`` ``GPU``
+        ``Ascend`` ``GPU`` ``CPU``
 
     Examples:
         >>> indices = Tensor([[0, 1], [1, 2]], dtype=mstype.int64)
@@ -175,7 +175,7 @@ def csr_exp(x: CSRTensor) -> CSRTensor:
         out_i = e^{x_i}
 
     Args:
-        x (CSRTensor): The input CSRTensor, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor.
 
     Returns:
         CSRTensor, has the same shape and dtype as the `x`.
@@ -203,14 +203,14 @@ def csr_exp(x: CSRTensor) -> CSRTensor:
 
 def coo_exp(x: COOTensor) -> COOTensor:
     """
-    Returns coo_exponential of a COOTensor element-wise.
+    Returns the element-wise exponential of a COOTensor.
 
     .. math::
 
         out_i = e^{x_i}
 
     Args:
-        x (COOTensor): The input COOTensor, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor.
 
     Returns:
         COOTensor, has the same shape and dtype as the `x`.
@@ -323,7 +323,7 @@ def csr_relu(x: CSRTensor) -> CSRTensor:
         x (CSRTensor): Input CSRTensor.
 
     Returns:
-        CSRTensor of shape :math:`(N, *)`, with the same dtype and shape as the `x`.
+        CSRTensor, with the same dtype and shape as the `x`.
 
     Raises:
         TypeError: If dtype of `x` is not a number.
@@ -348,10 +348,10 @@ def csr_relu(x: CSRTensor) -> CSRTensor:
 
 
 def coo_relu(x: COOTensor) -> COOTensor:
-    """
+    r"""
     Computes ReLU (Rectified Linear Unit activation function) of input coo_tensors element-wise.
 
-    It returns max(x, 0) element-wise. Specially, the neurons with the negative output
+    It returns :math:`\max(x,\  0)` element-wise. Specially, the neurons with the negative output
     will be suppressed and the active neurons will stay the same.
 
     .. math::
@@ -363,10 +363,12 @@ def coo_relu(x: COOTensor) -> COOTensor:
         output one more Mask.
 
     Args:
-        x (COOTensor): Input COOTensor.
+        x (COOTensor): Input COOTensor with shape :math:`(N, *)`, where :math:`*`
+            means any number of additional dimensions. Its dtype is
+            `number <https://www.mindspore.cn/docs/en/r2.0/api_python/mindspore.html#mindspore.dtype>`_.
 
     Returns:
-        COOTensor of shape :math:`(N, *)`, with the same dtype and shape as the `x`.
+        COOTensor, has the same shape and dtype as the `x`.
 
     Raises:
         TypeError: If dtype of `x` is not a number.
@@ -398,7 +400,7 @@ def csr_expm1(x: CSRTensor) -> CSRTensor:
         out_i = e^{x_i} - 1
 
     Args:
-        x (CSRTensor): The input CSRTensor with a dtype of float16 or float32, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor with a dtype of float16 or float32.
 
     Returns:
         CSRTensor, has the same shape as the `x`.
@@ -434,7 +436,7 @@ def coo_expm1(x: COOTensor) -> COOTensor:
         out_i = e^{x_i} - 1
 
     Args:
-        x (COOTensor): The input COOTensor with a dtype of float16 or float32, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor with a dtype of float16 or float32.
 
     Returns:
         COOTensor, has the same shape as the `x`.
@@ -544,14 +546,15 @@ def csr_asin(x: CSRTensor) -> CSRTensor:
         out_i = sin^{-1}(x_i)
 
     Args:
-        x (CSRTensor): Input CSRTensor.
+        x (CSRTensor): Input CSRTensor. The data types should be one of the following types:
+            float16, float32, float64.
 
     Returns:
         CSRTensor, has the same shape and dtype as `x`.
 
     Raises:
         TypeError: If `x` is not a CSRTensor.
-        TypeError: If dtype of `x` is not float16, float32, float64, complex64, complex128.
+        TypeError: If dtype of `x` is not float16, float32, float64.
 
     Supported Platforms:
         ``Ascend`` ``GPU`` ``CPU``
@@ -580,7 +583,9 @@ def coo_asin(x: COOTensor) -> COOTensor:
         out_i = sin^{-1}(x_i)
 
     Args:
-        x (COOTensor): Input COOTensor.
+        x (COOTensor): Input COOTensor. The shape of COOTensor is :math:`(N,*)` ,
+            where :math:`*` means,any number of additional dimensions.
+            The data type should be one of the following types: float16, float32, float64, complex64, complex128.
 
     Returns:
         COOTensor, has the same shape and dtype as `x`.
@@ -615,7 +620,7 @@ def csr_sqrt(x: CSRTensor) -> CSRTensor:
         out_{i} = \sqrt{x_{i}}
 
     Args:
-        x (CSRTensor): The input CSRTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor with a dtype of Number.
 
     Returns:
         CSRTensor, has the same shape and dtype as the `x`.
@@ -650,7 +655,7 @@ def coo_sqrt(x: COOTensor) -> COOTensor:
         out_{i} = \sqrt{x_{i}}
 
     Args:
-        x (COOTensor): The input COOTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor with a dtype of Number.
 
     Returns:
         COOTensor, has the same shape and dtype as the `x`.
@@ -914,8 +919,7 @@ def csr_floor(x: CSRTensor) -> CSRTensor:
         out_i = \lfloor x_i \rfloor
 
     Args:
-        x (CSRTensor): The input CSRTensor, its rank must be in [0, 7] inclusive
-            and data type must be float16, float32 or float64.
+        x (CSRTensor): The input CSRTensor, its data type must be float16, float32 or float64.
 
     Returns:
         CSRTensor, has the same shape as `x`.
@@ -951,8 +955,7 @@ def coo_floor(x: COOTensor) -> COOTensor:
         out_i = \lfloor x_i \rfloor
 
     Args:
-        x (COOTensor): The input COOTensor, its rank must be in [0, 7] inclusive
-            and data type must be float16, float32 or float64.
+        x (COOTensor): The input COOTensor, its data type must be float16, float32 or float64.
 
     Returns:
         COOTensor, has the same shape as `x`.
@@ -1058,7 +1061,7 @@ def csr_square(x: CSRTensor) -> CSRTensor:
         out_{i} = (x_{i})^2
 
     Args:
-        x (CSRTensor): The input CSRTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor with a dtype of Number.
 
     Returns:
         CSRTensor, has the same shape and dtype as the `x`.
@@ -1093,7 +1096,7 @@ def coo_square(x: COOTensor) -> COOTensor:
         out_{i} = (x_{i})^2
 
     Args:
-        x (COOTensor): The input COOTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor with a dtype of Number.
 
     Returns:
         COOTensor, has the same shape and dtype as the `x`.
@@ -1202,7 +1205,7 @@ def csr_sinh(x: CSRTensor) -> CSRTensor:
         out_i = \sinh(x_i)
 
     Args:
-        x (CSRTensor): The input CSRTensor of hyperbolic sine function, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor of hyperbolic sine function.
 
     Returns:
         CSRTensor, has the same shape as `x`.
@@ -1237,7 +1240,7 @@ def coo_sinh(x: COOTensor) -> COOTensor:
         out_i = \sinh(x_i)
 
     Args:
-        x (COOTensor): The input COOTensor of hyperbolic sine function, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor of hyperbolic sine function.
 
     Returns:
         COOTensor, has the same shape as `x`.
@@ -1271,7 +1274,7 @@ def csr_ceil(x: CSRTensor) -> CSRTensor:
         out_i = \lceil x_i \rceil = \lfloor x_i \rfloor + 1
 
     Args:
-        x (CSRTensor): The input CSRTensor with a dtype of float16 or float32, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor with a dtype of float16 or float32.
 
     Returns:
         CSRTensor, has the same shape as the `x`.
@@ -1342,8 +1345,8 @@ def csr_cosh(x: CSRTensor) -> CSRTensor:
         out_i = \cosh(x_i)
 
     Args:
-        x (CSRTensor): The input CSRTensor of hyperbolic cosine function, its rank must be in [0, 7] inclusive
-            and data type must be float16, float32, float64, complex64 or complex128.
+        x (CSRTensor): The input CSRTensor of hyperbolic cosine function, its data type
+            must be float16, float32, float64, complex64 or complex128.
 
     Returns:
         CSRTensor, has the same shape as `x`.
@@ -1380,8 +1383,8 @@ def coo_cosh(x: COOTensor) -> COOTensor:
         out_i = \cosh(x_i)
 
     Args:
-        x (COOTensor): The input COOTensor of hyperbolic cosine function, its rank must be in [0, 7] inclusive
-            and data type must be float16, float32, float64, complex64 or complex128.
+        x (COOTensor): The input COOTensor of hyperbolic cosine function, its data type
+            must be float16, float32, float64, complex64 or complex128.
 
     Returns:
         COOTensor, has the same shape as `x`.
@@ -1525,7 +1528,8 @@ def coo_log1p(x: COOTensor) -> COOTensor:
         out_i = {log_e}(x_i + 1)
 
     Args:
-        x (COOTensor): The input COOTensor. With float16 or float32 data type.
+        x (COOTensor): The input COOTensor, should have dtype of float16 or float32
+            and its value should be greater than -1.
 
     Returns:
         COOTensor, has the same shape as the `x`.
@@ -1552,7 +1556,7 @@ def coo_log1p(x: COOTensor) -> COOTensor:
 
 
 def csr_round(x: CSRTensor) -> CSRTensor:
-    r"""
+    """
     Returns half to even of a CSRTensor element-wise.
 
     .. math::
@@ -1592,7 +1596,7 @@ def coo_round(x: COOTensor) -> COOTensor:
 
     .. math::
 
-        out_i \\approx x_i
+        out_i \approx x_i
 
     Args:
         x (COOTensor): The input COOTensor.
@@ -1704,7 +1708,7 @@ def csr_asinh(x: CSRTensor) -> CSRTensor:
         out_i = \sinh^{-1}(input_i)
 
     Args:
-        x (CSRTensor): The input CSRTensor of inverse hyperbolic sine function, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor of inverse hyperbolic sine function.
 
     Returns:
         CSRTensor, has the same shape and type as `x`.
@@ -1739,7 +1743,7 @@ def coo_asinh(x: COOTensor) -> COOTensor:
         out_i = \sinh^{-1}(input_i)
 
     Args:
-        x (COOTensor): The input COOTensor of inverse hyperbolic sine function, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor of inverse hyperbolic sine function.
 
     Returns:
         COOTensor, has the same shape and type as `x`.
@@ -1773,7 +1777,7 @@ def csr_neg(x: CSRTensor) -> CSRTensor:
         out_{i} = - x_{i}
 
     Args:
-        x (CSRTensor): The input CSRTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor with a dtype of Number.
 
     Returns:
         CSRTensor, has the same shape and dtype as input.
@@ -1808,7 +1812,7 @@ def coo_neg(x: COOTensor) -> COOTensor:
         out_{i} = - x_{i}
 
     Args:
-        x (COOTensor): The input COOTensor with a dtype of Number, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor with a dtype of Number.
 
     Returns:
         COOTensor, has the same shape and dtype as input.
@@ -1841,12 +1845,8 @@ def csr_acosh(x: CSRTensor) -> CSRTensor:
 
         out_i = \cosh^{-1}(input_i)
 
-    .. warning::
-        Given an input CSRTensor x, the function computes inverse hyperbolic cosine of every element.
-        Input range is [1, inf].
-
     Args:
-        x (CSRTensor): The input CSRTensor of inverse hyperbolic cosine function, its rank must be in [0, 7] inclusive.
+        x (CSRTensor): The input CSRTensor of inverse hyperbolic cosine function, its element must be in range [1, inf].
 
     Returns:
         CSRTensor, has the same shape and type as `x`.
@@ -1885,7 +1885,7 @@ def coo_acosh(x: COOTensor) -> COOTensor:
         Input range is [1, inf].
 
     Args:
-        x (COOTensor): The input COOTensor of inverse hyperbolic cosine function, its rank must be in [0, 7] inclusive.
+        x (COOTensor): The input COOTensor of inverse hyperbolic cosine function.
 
     Returns:
         COOTensor, has the same shape and type as `x`.
@@ -1933,7 +1933,7 @@ def csr_isinf(x: CSRTensor) -> CSRTensor:
         TypeError: If `x` is not a CSRTensor.
 
     Supported Platforms:
-        ``CPU`` ``GPU``
+        ``GPU`` ``CPU``
 
     Examples:
         >>> indptr = Tensor([0, 1, 2, 2], dtype=mstype.int32)
@@ -1961,7 +1961,7 @@ def coo_isinf(x: COOTensor) -> COOTensor:
         & \text{ if } x_{i} \ne \text{Inf},\ \ False
         \end{cases}
 
-    where :math:`Inf` means not a number.
+    where :math:`Inf` means infinitity or negative infinitity.
 
     Args:
         x (COOTensor): The input COOTensor.
@@ -1973,7 +1973,7 @@ def coo_isinf(x: COOTensor) -> COOTensor:
         TypeError: If `x` is not a COOTensor.
 
     Supported Platforms:
-        ``CPU`` ``GPU``
+        ``GPU`` ``CPU``
 
     Examples:
         >>> indices = Tensor([[0, 1], [1, 2]], dtype=mstype.int64)
@@ -1998,10 +1998,11 @@ def csr_atanh(x: CSRTensor) -> CSRTensor:
         out_i = \tanh^{-1}(x_{i})
 
     .. warning::
-        This is an experimental prototype that is subject to change and/or deletion.
+        This is an experimental API that is subject to change or deletion.
 
     Args:
-        x (CSRTensor): Input CSRTensor.
+        x (CSRTensor): Input CSRTensor. The shape is :math:`(N, *)` where :math:`*` means,
+            any number of additional dimensions.
             The data type should be one of the following types: float16, float32.
 
     Returns:
@@ -2035,10 +2036,10 @@ def coo_atanh(x: COOTensor) -> COOTensor:
 
     .. math::
 
-        out_i = \tanh^{-1}(x_{i})
+        out_i = tanh^{-1}(x_{i})
 
     .. warning::
-        This is an experimental prototype that is subject to change and/or deletion.
+        This is an experimental API that is subject to change or deletion.
 
     Args:
         x (COOTensor): Input COOTensor.
@@ -2270,7 +2271,7 @@ def coo_sin(x: COOTensor) -> COOTensor:
     Raises:
         TypeError: If `x` is not a COOTensor.
         TypeError: If dtype of `x` is not float16, float32 or float64, complex64,
-    complex128.
+            complex128.
 
     Supported Platforms:
         ``Ascend`` ``GPU`` ``CPU``

mindspore/ops/function/spectral_func.py

@@ -22,29 +22,30 @@ from .._primitive_cache import _get_cache_prim
 
 def blackman_window(window_length, periodic=True, *, dtype=None):
     r"""
-    Blackman window function.
+    Blackman window function, usually used to extract finite signal segment for FFT.
 
-    The input `window_length` is a tensor with datatype int,
-    it determines the returned window size. In particular, if `window_length` is equal to `1`,
-    the returned window contains a single value `1`.
-    Attr `periodic` determines whether the returned window trims off the last duplicate value
-    from the symmetric window and is ready to be used as a periodic window with functions.
-    Therefore, if attr `periodic` is true, the :math:`N` in formula is in fact :math:`window\_length + 1`.
+    The `window_length` is a input tensor which determines the returned window size, and its data should be
+    an integer. In particular, if `window_length` is equal to `1`, only a single value `1` exists in the
+    returned window.
+
+    Attr `periodic` determines whether the returned window removes the last duplicate value
+    from the symmetric window and prepares to be a periodic window with functions.
+    Therefore, if attr `periodic` is true, the :math:`N` in formula is :math:`window\_length + 1`.
 
     .. math::
 
         w[n] = 0.42 - 0.5 cos(\frac{2\pi n}{N - 1}) + 0.08 cos(\frac{4\pi n}{N - 1})
 
-    where N is the full window size, and n is natural number less than N:[0, 1, ..., N-1].
+    where :math:`N` is the full window size, and n is natural number less than :math:`N` :[0, 1, ..., N-1].
 
     Args:
-        window_length (Tensor): the size of returned window, with data type int32, int64.
+        window_length (Tensor): The size of returned window, with data type int32, int64.
             The input data should be an integer with a value of [0, 1000000].
-        periodic (bool, optional): If True, returns a window to be used as periodic function.
-            If False, return a symmetric window. Default: True.
+        periodic (bool, optional): Indicates whether to returns a window to be used as periodic function or
+            a symmetric window. Default: True.
 
     Keyword Args:
-        dtype (mindspore.dtype, optional): the desired data type of returned tensor.
+        dtype (mindspore.dtype, optional): The data type of returned tensor.
             Only float16, float32 and float64 is allowed. Default: None.
 
     Returns:
@@ -60,7 +61,7 @@ def blackman_window(window_length, periodic=True, *, dtype=None):
         ValueError: If the dimension of `window_length` is not 0.
 
     Supported Platforms:
-        ``GPU`` ``CPU``
+        ``Ascend`` ``GPU`` ``CPU``
 
     Examples:
         >>> window_length = Tensor(10, mindspore.int32)
@@ -79,14 +80,16 @@ def blackman_window(window_length, periodic=True, *, dtype=None):
 
 def bartlett_window(window_length, periodic=True, *, dtype=None):
     r"""
-    Bartlett window function.
+    Bartlett window function is a triangular-shaped weighting function used for smoothing or frequency analysis of
+    signals in digital signal processing.
 
-    The input `window_length` is a tensor that datatype must be a integer, which controlling the returned window size.
-    In particular, if `window_length` = 1, the returned window contains a single value 1.
+    The `window_length` is a input tensor which determines the returned window size, and its data should be
+    an integer. In particular, if `window_length` is equal to `1`, only a single value 1 exists in the
+    returned window.
 
-    Attr `periodic` determines whether the returned window trims off the last duplicate value from the symmetric
-    window and is ready to be used as a periodic window with functions. Therefore, if attr `periodic` is true,
-    the "N" in formula is in fact `window_length` + 1.
+    Attr `periodic` determines whether the returned window removes the last duplicate value from the symmetric
+    window and prepares to be a periodic window with functions. Therefore, if attr `periodic` is true,
+    the :math:`N` in formula is :math:`window\_length + 1`.
 
     .. math::
 
@@ -95,16 +98,16 @@ def bartlett_window(window_length, periodic=True, *, dtype=None):
         2 - \frac{2n}{N - 1} & \text{if } \frac{N - 1}{2} < n < N \\
         \end{cases},
 
-        \text{where : N is the full window size.}
+    where N is the full window size.
 
     Args:
         window_length (Tensor): The size of returned window, with data type int32, int64.
             The input data should be an integer with a value of [0, 1000000].
-        periodic (bool, optional): If True, returns a window to be used as periodic function.
-            If False, return a symmetric window. Default: True.
+        periodic (bool, optional): Indicates whether to returns a window to be used as periodic function or
+            a symmetric window. Default: True.
 
     Keyword Args:
-        dtype (mindspore.dtype, optional): The desired datatype of returned tensor.
+        dtype (mindspore.dtype, optional): The datatype of returned tensor.
             Only float16, float32 and float64 are allowed. Default: None.
 
     Returns:
@@ -120,7 +123,7 @@ def bartlett_window(window_length, periodic=True, *, dtype=None):
         ValueError: If the dimension of `window_length` is not 0.
 
     Supported Platforms:
-        ``GPU`` ``CPU``
+        ``Ascend`` ``GPU`` ``CPU``
 
     Examples:
         >>> window_length = Tensor(5, mstype.int32)

mindspore/ops/function/vmap_func.py

@@ -14,6 +14,7 @@
 # ============================================================================
 """Defines vmap function."""
 from mindspore.ops.composite import _Vmap
+from mindspore._c_expression import VmapGeneralPreprocess_, VmapGeneralRulePyAdapter_
 
 __all__ = ['vmap']
 vmap_instance = _Vmap()
@@ -25,12 +26,12 @@ def vmap(fn, in_axes=0, out_axes=0):
 
     Vmap is pioneered by Jax and it removes the restriction of batch dimension on the operator, and provides a
     more convenient and unified operator expression. Moreover, it allows users to composite with other functional
-    modules such as :func:`mindspore.ops.grad`, to improve the development efficiency. In addition, the vectorizing
+    modules such as :func:`mindspore.grad`, to improve the development efficiency. In addition, the vectorizing
     map does not execute loops outside the function, but sinks loops into the primitive operations of the function
     for better performance. When combined with `Graph Kernel Fusion`, operational efficiency would be further improved.
 
     .. warning::
-        This is an experimental prototype that is subject to change and/or delete.
+        This is an experimental API that is subject to change or deletion.
 
     Note:
         1. The power of vmap comes from the implementation of VmapRules of primitives. Although we have designed a
@@ -92,3 +93,22 @@ def vmap(fn, in_axes=0, out_axes=0):
          [ 8  9 10]]
     """
     return vmap_instance(fn, in_axes, out_axes)
+
+
+class _VmapGeneralPreprocess(VmapGeneralPreprocess_):
+    """
+    General preprocessing of VmapRules. If the source axes of all inputs are `None`,
+    means that vectorization is not performed, taking out the original input and call
+    the primitive directly.
+    """
+    def __init__(self):
+        VmapGeneralPreprocess_.__init__(self, "VmapGeneralPreprocess")
+
+
+class _VmapGeneralRule(VmapGeneralRulePyAdapter_):
+    """
+    General rule python adapter is a adapter for general rule in c++. Some operators can
+    implement loop-stack method in their vmaprule by calling this adapter.
+    """
+    def __init__(self, prim, axis_size):
+        VmapGeneralRulePyAdapter_.__init__(self, 'vmapgeneralrule', prim, axis_size)