mindspore 2.1.0__cp39-cp39-win_amd64.whl → 2.2.10__cp39-cp39-win_amd64.whl

mindspore/common/sparse_tensor.py

@@ -79,17 +79,16 @@ class RowTensor(RowTensorInner):
     """
     A sparse representation of a set of tensor slices at given indices.
 
-    An RowTensor is typically used to represent a subset of a larger
-    tensor dense of shape :math:`(L0, D1, .., DN)` where L0 >> D0.
+    When the `values` of a RowTensor has a shape of :math:`(d_0, d_1, ..., d_n)`, then this RowTensor is used to
+    represent a subset of a larger dense tensor of shape :math:`(l_0, d_1, ..., d_n)`, where :math:`d_i` is the size of
+    i-th axis in RowTensor, :math:`l_0` is the size of 0-th axis of dense tensor and it satisfies :math:`l_0 > d_0`.
 
-    The values in indices are the indices in the first dimension of the slices
-    that have been extracted from the larger tensor.
-
-    The dense tensor dense represented by an RowTensor slices has
-    `dense[slices.indices[i], :, :, :, ...] = slices.values[i, :, :, :, ...]`.
+    The parameter `indices` is used to specify locations from which the `RowTensor` is sliced in the first dimension of
+    the dense tensor, which means the parameters `indices` and `values` have the following relationship
+    :math:`dense[indices[i], :, :, :, ...] = values[i, :, :, :, ...]`.
 
     For example, if indices is [0], values is [[1, 2]], shape is
-     :math:`(3, 2)` , then the dense representation of the row tensor will be:
+    :math:`(3, 2)` , then the dense representation of the row tensor will be:
 
     .. code-block::
 
@@ -101,8 +100,8 @@ class RowTensor(RowTensorInner):
         This is an experimental API that is subjected to change or deletion.
 
     Args:
-        indices (Tensor): A 1-D integer Tensor of shape :math:`(D0)` . Default: ``None``.
-        values (Tensor): A Tensor of any dtype of shape :math:`(D0, D1, ..., Dn)` . Default: ``None``.
+        indices (Tensor): A 1-D integer Tensor of shape :math:`(d_0)` . Default: ``None``.
+        values (Tensor): A Tensor of any dtype of shape :math:`(d_0, d_1, ..., d_n)` . Default: ``None``.
         shape (tuple(int)): An integer tuple which contains the shape
             of the corresponding dense tensor. Default: ``None``.
         row_tensor (RowTensor): A RowTensor object. Default: ``None``.
@@ -151,7 +150,7 @@ class SparseTensor(COOTensor_):
 
     Note:
         The interface is deprecated from version 1.7 and will be removed in a future version.
-        Please use 'COOTensor' instead.
+        Please use :class:`mindspore.COOTensor` instead.
 
     Args:
         indices (Tensor): A 2-D integer Tensor of shape :math:`(N, ndims)`,
@@ -159,7 +158,7 @@ class SparseTensor(COOTensor_):
             the SparseTensor, respectively.
         values (Tensor): A 1-D tensor of any type and shape :math:`(N)`, which
             supplies the values for each element in `indices`.
-        shape (tuple(int)): An integer tuple of size `ndims`,
+        shape (tuple(int)): An integer tuple of size :math:`(ndims)`,
             which specifies the shape of the sparse tensor.
 
     Returns:
@@ -227,7 +226,7 @@ class COOTensor(COOTensor_):
 
     Common arithmetic operations include: addition (+), subtraction (-), multiplication (*),
     and division (/). For details about operations supported by `COOTensor`, see
-    `operators <https://www.mindspore.cn/docs/en/r2.1/note/static_graph_syntax_support.html#operators>`_.
+    `operators <https://www.mindspore.cn/docs/en/r2.2/note/static_graph_syntax_support.html#operators>`_.
 
     .. warning::
         - This is an experimental API that is subject to change or deletion.
@@ -561,7 +560,7 @@ class CSRTensor(CSRTensor_):
 
     Common arithmetic operations include: addition (+), subtraction (-), multiplication (*),
     and division (/). For details about operations supported by `CSRTensor`, see
-    `operators <https://www.mindspore.cn/docs/en/r2.1/note/static_graph_syntax_support.html#operators>`_.
+    `operators <https://www.mindspore.cn/docs/en/r2.2/note/static_graph_syntax_support.html#operators>`_.
 
     .. warning::
         - This is an experimental API that is subjected to change.