mindspore 2.6.0__cp311-cp311-win_amd64.whl → 2.7.0__cp311-cp311-win_amd64.whl

mindspore/common/_tensor_docs.py

@@ -72,7 +72,7 @@ Note:
     - When `self` and `other` have different shapes,
       they must be able to broadcast to a common shape.
     - `self` and `other` can not be bool type at the same time,
-      [True, Tensor(True, bool\_), Tensor(np.array([True]), bool\_)] are all considered bool type.
+      [True, Tensor(True), Tensor(np.array([True]))] are all considered bool type.
     - `self` and `other` comply with the implicit type conversion rules to make the data types
       consistent.
     - The dimension of `self` should be greater than or equal to 1.
@@ -80,7 +80,7 @@ Note:
 Args:
     other (Union[Tensor, number.Number, bool]): `other` is a number.Number or a bool or a tensor whose data type is
         `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ or
-        `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
+        `bool <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
 
 Returns:
     Tensor with a shape that is the same as the broadcasted shape of `self` and `other`,
@@ -131,7 +131,7 @@ Note:
 Args:
     other (Union[Tensor, number.Number, bool]): `other` is a number.Number or a bool or a tensor whose data type is
         `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ or
-        `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
+        `bool <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
     
 Keyword Args:
     alpha (number.Number): A scaling factor applied to `other`, default 1.
@@ -319,39 +319,7 @@ Examples:
 .. method:: Tensor.any(dim=None, keepdim=False) -> Tensor
     :noindex:
 
-Tests if any element in tensor evaluates to `True` along the given axes.
-
-Args:
-    dim (Union[int, tuple(int), list(int), Tensor], optional): The dimensions to reduce. If ``None`` ,
-          all dimensions are reduced. Default ``None`` .
-    keepdim (bool, optional): Whether the output tensor has dim retained or not. Default ``False`` .
-
-Returns:
-    Tensor
-
-Supported Platforms:
-    ``Ascend`` ``GPU`` ``CPU``
-
-Examples:
-    >>> import mindspore
-    >>> x = mindspore.tensor([[True, False], [True, True]])
-    >>>
-    >>> # case 1:  By default, mindspore.Tensor.any tests along all the axes.
-    >>> x.any()
-    Tensor(shape=[], dtype=Bool, value= True)
-    >>>
-    >>> # case 2: Reduces a dimension along dim 1, with keepdim False.
-    >>> x.any(dim=1)
-    Tensor(shape=[2], dtype=Bool, value= [ True,  True])
-    >>>
-    >>> # case 3: Reduces a dimension along dim (0, 1), with keepdim False.
-    >>> x.any(dim=(0,1))
-    Tensor(shape=[], dtype=Bool, value= True)
-    >>>
-    >>> # case 4: Reduces a dimension along dim [0, 1], with keepdim True.
-    >>> x.any(dim=[0,1], keepdim=True)
-    Tensor(shape=[1, 1], dtype=Bool, value=
-    [[ True]])
+For details, please refer to :func:`mindspore.mint.any`.
 """)
 attach_docstr("arccosh", r"""arccosh() -> Tensor
 
@@ -718,7 +686,7 @@ Examples:
 attach_docstr("ceil", r"""ceil() -> Tensor
 
 For details, please refer to :func:`mindspore.ops.ceil`.""")
-attach_docstr("chunk", r"""chunk(chunks, dim=0) -> Tuple of Tensors
+attach_docstr("chunk", r"""chunk(chunks, dim=0) -> tuple[Tensor]
 
 Cut the self Tensor into `chunks` sub-tensors along the specified dimension.
 
@@ -756,7 +724,7 @@ Examples:
         Tensor(shape=[3], dtype=Float32, value= [ 3.00000000e+00,  4.00000000e+00,  5.00000000e+00]),
         Tensor(shape=[3], dtype=Float32, value= [ 6.00000000e+00,  7.00000000e+00,  8.00000000e+00]))
 
-.. method:: Tensor.chunk(chunks, axis=0) -> Tuple of Tensors
+.. method:: Tensor.chunk(chunks, axis=0) -> tuple[Tensor]
     :noindex:
 
 Cut the self Tensor into `chunks` sub-tensors along the specified axis.
@@ -829,11 +797,17 @@ Copies the elements from `src` into `self` tensor and returns `self`.
 
 .. warning::
     This is an experimental API that is subject to change or deletion.
-    The `src` tensor must be broadcastable with the `self` tensor. It may be of a different data type.
+
+    If Copying is performed between Ascend and Ascend, the `src` tensor must be broadcastable with the `self` tensor,
+    and they can be of different data types.
+    Copying is performed between CPU and Ascend or CPU and CPU are only supported if `self` and `src` have
+    the same shape and data type and they are all contiguous.
 
 Args:
     src (Tensor): the source tensor to copy from.
-    non_blocking (bool, optional): no effect currently. Default: ``False``.
+    non_blocking (bool, optional): If ``True`` and copying is performed between CPU and Ascend, and `self` and `src`
+        have the same shape and data type and are contiguous. The copy may occur asynchronously with respect to the
+        host. For other cases, this argument has no effect. Default: ``False``.
 
 Returns:
     Return self Tensor.
@@ -911,7 +885,7 @@ Args:
     keep_dims (bool, optional): Whether to maintain dimensions specified by `axis`.
         If true, keep these reduced dimensions and the length is 1.
         If false, don't keep these dimensions. Default: ``False`` .
-    dtype (Union[Number, mindspore.bool\_], optional): The data type of the output tensor.
+    dtype (Union[Number, mindspore.bool], optional): The data type of the output tensor.
         Default: ``None`` .
 
 Returns:
@@ -1512,7 +1486,7 @@ where params represents the input `input_params`, and indices represents the ind
       On CPU and GPU, an error is raised if an out of bound indice is found. On Ascend, the results may be
       undefined.
     - The data type of self cannot be
-      `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ on Ascend
+      `bool <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ on Ascend
       platform currently.
 
 Args:
@@ -1933,13 +1907,13 @@ Examples:
     >>> import mindspore
     >>> import numpy as np
     >>> from mindspore import Tensor
-    >>> input = Tensor(np.array([True, False, True]), mindspore.bool_)
-    >>> other = Tensor(np.array([True, True, False]), mindspore.bool_)
+    >>> input = Tensor(np.array([True, False, True]), mindspore.bool)
+    >>> other = Tensor(np.array([True, True, False]), mindspore.bool)
     >>> output = input.logical_xor(other)
     >>> print(output)
     [ False True True]
-    >>> x = Tensor(1, mindspore.bool_)
-    >>> other = Tensor(0, mindspore.bool_)
+    >>> x = Tensor(1, mindspore.bool)
+    >>> other = Tensor(0, mindspore.bool)
     >>> output = input.logical_xor(other)
     >>> print(output)
     True
@@ -1973,6 +1947,43 @@ In-place version of :func:`mindspore.Tensor.masked_fill`.
 .. warning::
     This is an experimental API that is subject to change or deletion.
 """)
+attach_docstr("masked_scatter", r"""masked_scatter(mask, source) -> Tensor
+
+Returns a Tensor. Updates the value in the "self Tensor" with the `tensor` value according to the mask.
+The shape of `mask` and the shape of the "self Tensor" must be the same or `mask` is broadcastable.
+
+.. warning::
+    This is an experimental API that is subject to change or deletion.
+
+Args:
+    mask (Tensor[bool]): A bool tensor with a shape broadcastable to the "self Tensor".
+    source (Tensor): A tensor with the same data type as the "self Tensor". The number
+        of elements must be greater than or equal to the number of True's in `mask`.
+
+Returns:
+    Tensor, with the same type and shape as the "self Tensor".
+
+Raises:
+    TypeError: If `mask` or `source` is not a Tensor.
+    TypeError: If data type of the "self Tensor" is not be supported.
+    TypeError: If dtype of `mask` is not bool.
+    TypeError: If the dim of the "self Tensor" is less than the dim of `mask`.
+    ValueError: If `mask` can not be broadcastable to the "self Tensor".
+    ValueError: If the number of elements in `source` is less than the number of elements to be updated in the tensor.
+
+Supported Platforms:
+    ``Ascend`` ``CPU``
+
+Examples:
+    >>> import numpy as np
+    >>> import mindspore
+    >>> from mindspore import Tensor
+    >>> source = Tensor(np.array([1., 2., 3., 4.]), mindspore.float32)
+    >>> mask = Tensor(np.array([True, True, False, True]), mindspore.bool_)
+    >>> tensor = Tensor(np.array([5., 6., 7.]), mindspore.float32)
+    >>> output = source.masked_scatter(mask, tensor)
+    >>> print(output)
+    [5. 6. 3. 7.]""")
 attach_docstr("masked_select", r"""masked_select(mask) -> Tensor
 
 For details, please refer to :func:`mindspore.ops.masked_select`.""")
@@ -2234,7 +2245,7 @@ Examples:
 
 For details, please refer to :func:`mindspore.ops.mean` .
 """)
-attach_docstr("median", r"""median(axis=-1, keepdims=False) -> Tuple of Tensors
+attach_docstr("median", r"""median(axis=-1, keepdims=False) -> tuple[Tensor]
 
 Computes the median and indices of input tensor.
 
@@ -2283,7 +2294,7 @@ Returns:
 Supported Platforms:
     ``Ascend``
 
-.. method:: Tensor.median(dim=-1, keepdim=False) -> Tuple of Tensors
+.. method:: Tensor.median(dim=-1, keepdim=False) -> tuple[Tensor]
     :noindex:
 
 Output the median on the specified dimension ``dim`` and its corresponding index.
@@ -2499,7 +2510,7 @@ Note:
     - When `self` and `other` have different shapes,
       `other` be able to broadcast to a `self`.
     - `self` and `other` can not be bool type at the same time,
-      [True, Tensor(True, bool\_), Tensor(np.array([True]), bool\_)] are all considered bool type.
+      [True, Tensor(True), Tensor(np.array([True]))] are all considered bool type.
 
 Args:
     other (Union[Tensor, number.Number, bool]): `other` is a number.Number or
@@ -2664,6 +2675,77 @@ attach_docstr("neg", r"""neg() -> Tensor
 
 For details, please refer to :func:`mindspore.ops.neg`.
 """)
+attach_docstr("new_empty", r"""new_empty(size, *, dtype=None, device=None) -> Tensor
+
+Returns an uninitialized Tensor. Its shape is specified by `size`, its dtype is specified by `dtype` and its
+device is specified by `device`.
+
+.. warning::
+    This is an experimental API that is subject to change or deletion.
+
+Args:
+    size (Union[tuple[int], list[int], int]): The specified shape of output tensor. Only positive integer or
+        tuple or list containing positive integers are allowed.
+
+Keyword Args:
+    dtype (:class:`mindspore.dtype`, optional): The specified dtype of the output tensor. If `dtype = None`,
+        the tensor will have the same dtype as `self`. Default ``None``.
+    device (string, optional): The specified device of the output tensor. In PyNative mode, ``"Ascend"``, ``"npu"``,
+        ``"cpu"`` and ``"CPU"`` are supported. In graph mode O0, ``"Ascend"`` and ``"npu"`` are supported. If `device = None`,
+        the value set by :func:`mindspore.set_device` will be used. Default ``None``.
+
+Returns:
+    Tensor, whose shape, dtype and device are defined by input but with uninitialized data (May be a random value).
+
+Raises:
+    TypeError: If `size` is neither an int nor a tuple or list of int.
+
+Supported Platforms:
+    ``Ascend`` ``CPU``
+
+Examples:
+    >>> import mindspore
+    >>> from mindspore import Tensor
+    >>> x = Tensor([[1, 2, 3], [4, 5, 6]])
+    >>> output1 = x.new_empty((2, 3))
+    >>> print(output1)
+    [[0 0 0]
+     [0 0 0]]
+    >>> output2 = x.new_empty((2, 3), dtype=mindspore.float64)
+    >>> print(output2)
+    [[0. 0. 0.]
+     [0. 0. 0.]]
+""")
+attach_docstr("new_full", r"""new_full(size, fill_value, *, dtype=None) -> Tensor
+
+Return a tensor of `size` filled with `fill_value`.
+
+Args:
+    size (Union[tuple(int), list(int)]): The output shape.
+    fill_value (Union[Number, bool]): The value to fill the output tensor.
+
+Keyword Args:
+    dtype (:class:`mindspore.dtype`, optional): The desired data type of returned Tensor. If None, the returned tensor has the same dtype as `self`. Default: ``None``.
+
+Returns:
+    Tensor, the shape and dtype is defined above and filled with `fill_value`.
+
+Raises:
+    TypeError: If `size` is not a tuple or list of int.
+    TypeError: If `dtype` is not a MindSpore dtype.
+    ValueError: If `size` contains negative values.
+
+Supported Platforms:
+    ``Ascend``
+
+Examples:
+    >>> from mindspore import Tensor
+    >>> x = Tensor([1, 2, 3, 4], mindspore.int32)
+    >>> output = x.new_full((2, 3), 3)
+    >>> print(output)
+    [[3 3 3]
+     [3 3 3]]
+""")
 attach_docstr("new_ones", r"""new_ones(size, dtype=None) -> Tensor
 
 Return a tensor of `size` filled with ones.
@@ -2874,11 +2956,11 @@ Supports broadcasting to a common shape and implicit type promotion.
 
     The dividend `self` is a tensor whose data type is
     `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ or
-    `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
+    `bool <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
 
 Args:
     other (Union[Tensor, numbers.Number, bool]): The divisor is a numbers.Number or
-        a bool or a tensor whose data type is number or bool\_ when the dividend is a tensor.
+        a bool or a tensor whose data type is number or bool when the dividend is a tensor.
 
 Returns:
     Tensor, with dtype promoted and shape broadcasted.
@@ -2946,6 +3028,49 @@ Examples:
     >>> print(output)
     [2.  1.  0.]
 """)
+attach_docstr("remainder_", r"""remainder_(other) -> Tensor
+
+Computes the remainder of `self` divided by `other` element-wise. The result has the same sign as the divisor `other`
+and its absolute value is less than that of `other`.
+
+.. code-block::
+
+    remainder(self, other) == self - self.div(other, rounding_mode="floor") * other
+
+.. warning::
+    This is an experimental API that is subject to change or deletion.
+
+Note:
+    - Complex inputs are not supported.
+    - The dividend `self` is a tensor whose data type is
+      `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
+    - When `self` and `other` have different shapes, `other` should be able to broadcast to a `self`.
+
+Args:
+    other (Union[Tensor, number, bool]): The divisor is a number or
+        a bool or a tensor whose data type is number or bool.
+
+Returns:
+    Tensor, the shape and the data type are the same as those of `self` .
+
+Raises:
+    RuntimeError: If `other` cannot be broadcast to `self`.
+
+Supported Platforms:
+    ``Ascend``
+
+Examples:
+    >>> import mindspore
+    >>> from mindspore import Tensor
+    >>> import numpy as np
+    >>> x = Tensor(np.array([2, 4, -1]), mindspore.int32)
+    >>> other = Tensor(np.array([3, -6, -2]), mindspore.int32)
+    >>> output = x.remainder_(other)
+    >>> print(output)
+    [ 2 -2 -1]
+    >>> print(x)
+    [ 2 -2 -1]
+""")
 attach_docstr("repeat", r"""repeat(*repeats)
 
 Copy the elements in each dimension of a Tensor based on the specified number of repetition times.
@@ -4044,7 +4169,7 @@ Args:
     other (Union[Tensor, number.Number, bool]): The second self, is a number.Number or
         a bool or a tensor whose data type is
         `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_ or
-        `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
+        `bool <https://www.mindspore.cn/docs/en/master/api_python/mindspore/mindspore.dtype.html>`_.
 
 Keyword Args:
     alpha (number.Number, optional): A scaling factor applied to `other`, default ``1``.

mindspore/common/_utils.py

@@ -1,6 +1,6 @@
 # This is the Python adaptation and derivative work of Myia (https://github.com/mila-iqia/myia/).
 #
-# Copyright 2022 Huawei Technologies Co., Ltd
+# Copyright 2022-2025 Huawei Technologies Co., Ltd
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import os
 import math
+import types
 import ctypes
 import functools
 
@@ -46,6 +47,13 @@ def is_dim_unknown(shape):
     return False
 
 
+def get_func(func):
+    """Get function object"""
+    if isinstance(func, types.MethodType):
+        return func.__func__
+    return func
+
+
 def get_slice_num(dtype, shape):
     """Check whether size of data is too huge, and cut it to a smaller one, return slice num."""
     slice_num = 1