From ae76eacc9f9a781362f8b03a6d13c3477da51cc6 Mon Sep 17 00:00:00 2001 From: huodagu Date: Mon, 1 Aug 2022 14:14:24 +0800 Subject: [PATCH] modify format --- .../mindspore/Tensor/mindspore.Tensor.T.rst | 7 + .../mindspore/Tensor/mindspore.Tensor.abs.rst | 9 + .../Tensor/mindspore.Tensor.addcdiv.rst | 17 + .../Tensor/mindspore.Tensor.addcmul.rst | 17 + .../mindspore/Tensor/mindspore.Tensor.all.rst | 13 + .../mindspore/Tensor/mindspore.Tensor.any.rst | 13 + .../mindspore.Tensor.approximate_equal.rst | 27 + .../Tensor/mindspore.Tensor.argmax.rst | 15 + .../Tensor/mindspore.Tensor.argmin.rst | 15 + .../mindspore.Tensor.argmin_with_value.rst | 29 + .../Tensor/mindspore.Tensor.asnumpy.rst | 9 + .../Tensor/mindspore.Tensor.assign_value.rst | 12 + .../Tensor/mindspore.Tensor.astype.rst | 16 + .../Tensor/mindspore.Tensor.atan2.rst | 21 + .../Tensor/mindspore.Tensor.bernoulli.rst | 24 + .../Tensor/mindspore.Tensor.bitwise_and.rst | 14 + .../Tensor/mindspore.Tensor.bitwise_or.rst | 14 + .../Tensor/mindspore.Tensor.bitwise_xor.rst | 14 + .../Tensor/mindspore.Tensor.broadcast_to.rst | 18 + .../Tensor/mindspore.Tensor.ceil.rst | 12 + .../Tensor/mindspore.Tensor.choose.rst | 20 + .../Tensor/mindspore.Tensor.clip.rst | 24 + .../Tensor/mindspore.Tensor.col2im.rst | 21 + .../Tensor/mindspore.Tensor.copy.rst | 12 + .../Tensor/mindspore.Tensor.cosh.rst | 12 + .../Tensor/mindspore.Tensor.cummax.rst | 21 + .../Tensor/mindspore.Tensor.cummin.rst | 21 + .../Tensor/mindspore.Tensor.cumsum.rst | 19 + .../Tensor/mindspore.Tensor.diag.rst | 14 + .../Tensor/mindspore.Tensor.diagonal.rst | 17 + .../Tensor/mindspore.Tensor.dtype.rst | 7 + .../mindspore/Tensor/mindspore.Tensor.erf.rst | 13 + .../Tensor/mindspore.Tensor.erfc.rst | 13 + .../Tensor/mindspore.Tensor.expand_as.rst | 12 + .../Tensor/mindspore.Tensor.expand_dims.rst | 16 + .../Tensor/mindspore.Tensor.fill.rst | 18 + .../Tensor/mindspore.Tensor.fills.rst | 20 + .../Tensor/mindspore.Tensor.flatten.rst | 16 + .../mindspore.Tensor.flush_from_cache.rst | 6 + .../Tensor/mindspore.Tensor.from_numpy.rst | 13 + .../Tensor/mindspore.Tensor.gather.rst | 21 + .../mindspore.Tensor.gather_elements.rst | 31 + .../Tensor/mindspore.Tensor.gather_nd.rst | 24 + .../mindspore/Tensor/mindspore.Tensor.ger.rst | 19 + .../Tensor/mindspore.Tensor.hardshrink.rst | 24 + .../Tensor/mindspore.Tensor.has_init.rst | 7 + .../Tensor/mindspore.Tensor.index_fill.rst | 27 + .../Tensor/mindspore.Tensor.init_data.rst | 16 + .../mindspore.Tensor.inplace_update.rst | 21 + .../mindspore/Tensor/mindspore.Tensor.inv.rst | 17 + .../Tensor/mindspore.Tensor.invert.rst | 17 + .../Tensor/mindspore.Tensor.isclose.rst | 24 + .../Tensor/mindspore.Tensor.item.rst | 18 + .../Tensor/mindspore.Tensor.itemset.rst | 19 + .../Tensor/mindspore.Tensor.itemsize.rst | 7 + .../Tensor/mindspore.Tensor.lerp.rst | 26 + .../Tensor/mindspore.Tensor.log1p.rst | 16 + ...indspore.Tensor.log_matrix_determinant.rst | 19 + .../Tensor/mindspore.Tensor.logit.rst | 31 + .../Tensor/mindspore.Tensor.masked_fill.rst | 21 + .../Tensor/mindspore.Tensor.masked_select.rst | 15 + .../mindspore.Tensor.matrix_determinant.rst | 17 + .../mindspore/Tensor/mindspore.Tensor.max.rst | 18 + .../Tensor/mindspore.Tensor.mean.rst | 13 + .../mindspore/Tensor/mindspore.Tensor.min.rst | 18 + .../Tensor/mindspore.Tensor.narrow.rst | 22 + .../Tensor/mindspore.Tensor.nbytes.rst | 7 + .../Tensor/mindspore.Tensor.ndim.rst | 7 + .../Tensor/mindspore.Tensor.nonzero.rst | 9 + .../Tensor/mindspore.Tensor.norm.rst | 28 + .../mindspore/Tensor/mindspore.Tensor.pow.rst | 24 + .../Tensor/mindspore.Tensor.prod.rst | 17 + .../mindspore/Tensor/mindspore.Tensor.ptp.rst | 19 + .../mindspore.Tensor.random_categorical.rst | 19 + .../Tensor/mindspore.Tensor.ravel.rst | 9 + .../Tensor/mindspore.Tensor.renorm.rst | 20 + .../Tensor/mindspore.Tensor.repeat.rst | 17 + .../Tensor/mindspore.Tensor.reshape.rst | 16 + .../Tensor/mindspore.Tensor.resize.rst | 15 + .../Tensor/mindspore.Tensor.round.rst | 9 + .../Tensor/mindspore.Tensor.scatter_add.rst | 22 + .../Tensor/mindspore.Tensor.scatter_div.rst | 23 + .../Tensor/mindspore.Tensor.scatter_max.rst | 22 + .../Tensor/mindspore.Tensor.scatter_min.rst | 22 + .../Tensor/mindspore.Tensor.scatter_mul.rst | 22 + .../Tensor/mindspore.Tensor.scatter_sub.rst | 22 + .../Tensor/mindspore.Tensor.searchsorted.rst | 17 + .../Tensor/mindspore.Tensor.select.rst | 26 + .../Tensor/mindspore.Tensor.shape.rst | 7 + .../Tensor/mindspore.Tensor.size.rst | 7 + .../Tensor/mindspore.Tensor.soft_shrink.rst | 26 + .../Tensor/mindspore.Tensor.split.rst | 20 + .../Tensor/mindspore.Tensor.squeeze.rst | 16 + .../mindspore/Tensor/mindspore.Tensor.std.rst | 20 + .../Tensor/mindspore.Tensor.strides.rst | 7 + .../mindspore/Tensor/mindspore.Tensor.sum.rst | 22 + .../mindspore/Tensor/mindspore.Tensor.svd.rst | 20 + .../Tensor/mindspore.Tensor.swapaxes.rst | 17 + .../Tensor/mindspore.Tensor.take.rst | 21 + .../mindspore/Tensor/mindspore.Tensor.tan.rst | 16 + .../Tensor/mindspore.Tensor.to_coo.rst | 19 + .../Tensor/mindspore.Tensor.to_csr.rst | 20 + .../Tensor/mindspore.Tensor.to_tensor.rst | 21 + .../Tensor/mindspore.Tensor.top_k.rst | 34 + .../Tensor/mindspore.Tensor.trace.rst | 18 + .../Tensor/mindspore.Tensor.transpose.rst | 22 + .../mindspore.Tensor.unique_consecutive.rst | 19 + .../mindspore.Tensor.unique_with_pad.rst | 20 + .../mindspore.Tensor.unsorted_segment_max.rst | 21 + .../mindspore.Tensor.unsorted_segment_min.rst | 21 + ...mindspore.Tensor.unsorted_segment_prod.rst | 21 + .../mindspore/Tensor/mindspore.Tensor.var.rst | 21 + .../Tensor/mindspore.Tensor.view.rst | 12 + .../Tensor/mindspore.Tensor.xdivy.rst | 24 + .../Tensor/mindspore.Tensor.xlogy.rst | 25 + .../api_python/mindspore/mindspore.Tensor.rst | 2222 +---------------- .../ops/mindspore.ops.func_grid_sample.rst | 20 +- .../ops/mindspore.ops.func_log1p.rst | 2 +- docs/api/api_python_en/Tensor_list.rst | 153 ++ 119 files changed, 2338 insertions(+), 2107 deletions(-) create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.T.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.abs.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcdiv.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcmul.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.all.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.any.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.approximate_equal.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmax.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin_with_value.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.asnumpy.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.assign_value.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.astype.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.atan2.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bernoulli.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_and.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_or.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_xor.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.broadcast_to.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ceil.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.choose.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.clip.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.col2im.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.copy.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cosh.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummax.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummin.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cumsum.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diag.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diagonal.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.dtype.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erf.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erfc.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_as.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_dims.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fill.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fills.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flatten.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flush_from_cache.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.from_numpy.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_elements.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_nd.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ger.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hardshrink.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.has_init.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.index_fill.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.init_data.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inplace_update.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inv.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.invert.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.isclose.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.item.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemset.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemsize.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.lerp.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log1p.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log_matrix_determinant.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.logit.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_fill.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_select.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.matrix_determinant.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.max.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.mean.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.min.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.narrow.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nbytes.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ndim.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nonzero.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.norm.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.pow.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.prod.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ptp.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.random_categorical.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ravel.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.renorm.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.repeat.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.reshape.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.resize.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.round.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_add.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_div.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_max.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_min.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_mul.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_sub.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.searchsorted.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.select.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.shape.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.size.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.soft_shrink.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.split.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.squeeze.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.std.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.strides.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.sum.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.svd.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.swapaxes.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.take.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.tan.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_coo.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_csr.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_tensor.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.top_k.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.trace.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.transpose.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_consecutive.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_with_pad.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_max.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_min.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_prod.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.var.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.view.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xdivy.rst create mode 100644 docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst create mode 100644 docs/api/api_python_en/Tensor_list.rst diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.T.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.T.rst new file mode 100644 index 00000000000..74afbc80ad7 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.T.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.T +================== + +.. py:method:: mindspore.Tensor.T + :property: + + 返回转置后的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.abs.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.abs.rst new file mode 100644 index 00000000000..797c087520c --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.abs.rst @@ -0,0 +1,9 @@ +mindspore.Tensor.abs +==================== + +.. py:method:: mindspore.Tensor.abs() + + 返回每个元素的绝对值。 + + 返回： + Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcdiv.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcdiv.rst new file mode 100644 index 00000000000..699205e2894 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcdiv.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.addcdiv +======================== + +.. py:method:: mindspore.Tensor.addcdiv(x1, x2, value) + + 逐元素执行x1除以x2，将结果乘以标量value并将其添加到输入。 + + .. math:: + y[i] = input\_data[i] + value[i] * (x1[i] / x2[i]) + + 参数： + - **x1** (Tensor) - 分子张量。 + - **x2** (Tensor) - 分母张量。 + - **value** (Tensor) - x1/x2的倍数。 + + 返回： + Tensor，shape和数据类型与当前Tensor相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcmul.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcmul.rst new file mode 100644 index 00000000000..ade890e6c52 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.addcmul.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.addcmul +======================== + +.. py:method:: mindspore.Tensor.addcmul(x1, x2, value) + + 逐元素执行x1乘以x2，将结果乘以标量value并将其添加到输入。 + + .. math:: + y[i] = input\_data[i] + value[i] * (x1[i] * x2[i]) + + 参数： + - **x1** (Tensor) - 要相乘的张量。 + - **x2** (Tensor) - 要相乘的张量。 + - **value** (Tensor) - x1*x2的倍数。 + + 返回： + Tensor，shape和数据类型与当前Tensor相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.all.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.all.rst new file mode 100644 index 00000000000..eebf2cb275b --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.all.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.all +==================== + +.. py:method:: mindspore.Tensor.all(axis=(), keep_dims=False) + + 检查在指定轴上所有元素是否均为True。 + + 参数： + - **axis** (Union[None, int, tuple(int)) - 计算all的维度。 当 `axis` 为None或者空元组的时候，计算所有维度。当 `axis` 为int或tuple(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 + - **keep_dims** (bool) - 计算结果是否保留维度。 默认值： False。 + + 返回： + Tensor。如果在指定轴方向上所有数组元素都为True，则其值为True，否则其值为False。如果轴为None或空元组，则默认降维。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.any.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.any.rst new file mode 100644 index 00000000000..e2e6601825b --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.any.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.any +==================== + +.. py:method:: mindspore.Tensor.any(axis=(), keep_dims=False) + + 检查在指定轴方向上是否存在任意为True的Tensor元素。 + + 参数： + - **axis** (Union[None, int, tuple(int)) - 计算any的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int或tuple(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 + - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 + + 返回： + Tensor。如果在指定轴方向上所有Tensor元素都为True，则其值为True，否则其值为False。如果轴为None或空元组，则默认降维。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.approximate_equal.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.approximate_equal.rst new file mode 100644 index 00000000000..ba0235241be --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.approximate_equal.rst @@ -0,0 +1,27 @@ +mindspore.Tensor.approximate_equal +================================== + +.. py:method:: mindspore.Tensor.approximate_equal(y, tolerance=1e-5) + + 逐元素计算abs(x-y)，如果小于tolerance则为True，否则为False。 + + .. math:: + out_i = \begin{cases} + & \text{ if } \left | x_{i} - y_{i} \right | < \text{tolerance},\ \ True \\ + & \text{ if } \left | x_{i} - y_{i} \right | \ge \text{tolerance},\ \ False + \end{cases} + + `x` 为当前Tensor。 + `tolerance` 为相等的两元素间最大偏差。 + `x` 和 `y` 会通过隐式数据类型转换使数据类型保持一致。如果数据类型不同，低精度的数据类型会被自动转换到高精度的数据类型。 + + 参数： + - **y** (Tensor) - 输入Tensor，shape与数据类型和当前Tensor相同。 + - **tolerance** (float) - 两元素可被视为相等的最大偏差。默认值：1e-05。 + + 返回： + Tensor，shape与当前Tensor相同，bool类型。 + + 异常： + - **TypeError** - `tolerance` 不是float类型。 + - **RuntimeError** - `variable` 与 `value` 之间的类型转换不被支持。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmax.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmax.rst new file mode 100644 index 00000000000..3486eb51c41 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmax.rst @@ -0,0 +1,15 @@ +mindspore.Tensor.argmax +======================= + +.. py:method:: mindspore.Tensor.argmax(axis=None) + + 返回指定轴上最大值的索引。 + + 参数： + - **axis** (int, optional) - 默认情况下，返回扁平化Tensor的最大值序号，否则返回指定轴方向上。 + + 返回： + Tensor，最大值的索引。它与原始Tensor具有相同的shape，但移除了轴方向上的维度。 + + 异常： + - **ValueError** - 入参axis的设定值超出了范围。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin.rst new file mode 100644 index 00000000000..18fc0e5f316 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin.rst @@ -0,0 +1,15 @@ +mindspore.Tensor.argmin +======================= + +.. py:method:: mindspore.Tensor.argmin(axis=None) + + 返回指定轴上最小值的索引。 + + 参数： + - **axis** (int, optional) - 返回扁平化Tensor的最小值序号，否则返回指定轴方向上的最小值序号。默认值: None。 + + 返回： + Tensor，最小Tensor的索引。它与原始Tensor具有相同的shape，但移除了轴方向上的维度。 + + 异常： + - **ValueError** - 入参axis的设定值超出了范围。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin_with_value.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin_with_value.rst new file mode 100644 index 00000000000..a3892ba692d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.argmin_with_value.rst @@ -0,0 +1,29 @@ +mindspore.Tensor.argmin_with_value +=================================== + +.. py:method:: mindspore.Tensor.argmin_with_value(axis=0, keep_dims=False) + + 根据指定的索引计算最小值，并返回索引和值。 + + 在给定轴上计算输入Tensor的最小值，并且返回最小值和索引。 + + .. note:: + 在auto_parallel和semi_auto_parallel模式下，不能使用第一个输出索引。 + + .. warning:: + - 如果有多个最小值，则取第一个最小值的索引。 + - `axis` 的取值范围为[-dims, dims - 1]。`dims` 为输入Tensor的维度长度。 + + 参数： + - **axis** (int) - 指定计算维度。默认值：0。 + - **keep_dims** (bool) - 表示是否减少维度。如果为True，则输出维度和输入维度相同。如果为False，则减少输出维度。默认值：False。 + + 返回： + tuple (Tensor)，表示2个Tensor组成的tuple，包含对应的索引和输入Tensor的最小值。 + + - **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True，则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则，shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。 + - **output_x** (Tensor) - 输入Tensor的最小值，其shape与索引相同。 + + 异常： + - **TypeError** - `keep_dims` 不是bool。 + - **TypeError** - `axis` 不是int。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.asnumpy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.asnumpy.rst new file mode 100644 index 00000000000..1ef387429d2 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.asnumpy.rst @@ -0,0 +1,9 @@ +mindspore.Tensor.asnumpy +======================== + +.. py:method:: mindspore.Tensor.asnumpy() + + 将张量转换为NumPy数组。该方法会将Tensor本身转换为NumPy的ndarray。这个Tensor和函数返回的ndarray共享内存地址。对Tensor本身的修改会反映到相应的ndarray上。 + + 返回： + NumPy的ndarray，该ndarray与Tensor共享内存地址。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.assign_value.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.assign_value.rst new file mode 100644 index 00000000000..6251adfe93e --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.assign_value.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.assign_value +============================= + +.. py:method:: mindspore.Tensor.assign_value(value) + + 将另一个Tensor的值赋给当前Tensor。 + + 参数： + - **value** (Tensor) - 用于赋值的Tensor。 + + 返回： + Tensor，赋值后的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.astype.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.astype.rst new file mode 100644 index 00000000000..9b068e70b32 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.astype.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.astype +======================= + +.. py:method:: mindspore.Tensor.astype(dtype, copy=True) + + 将Tensor转为指定数据类型，可指定是否返回副本。 + + 参数： + - **dtype** (Union[`mindspore.dtype` , `numpy.dtype` , str]) - 指定的Tensor数据类型，可以是: `mindspore.dtype.float32` , `numpy.float32` 或 `float32` 的格式。默认值：`mindspore.dtype.float32` 。 + - **copy** (bool, optional) - 默认情况下，astype返回新拷贝的Tensor。如果该参数设为False，则返回输入Tensor而不是副本。默认值：True。 + + 返回： + Tensor，指定数据类型的Tensor。 + + 异常： + - **TypeError** - 指定了无法解析的类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.atan2.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.atan2.rst new file mode 100644 index 00000000000..ce56eedd852 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.atan2.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.atan2 +====================== + +.. py:method:: mindspore.Tensor.atan2(y) + + 逐元素计算x/y的反正切值。 + + `x` 指的当前 Tensor。 + + 返回 :math:`\theta\ \in\ [-\pi, \pi]` ，使得 :math:`x = r*\sin(\theta), y = r*\cos(\theta)` ， 其中 :math:`r = \sqrt{x^2 + y^2}` 。 + 输入 `x` 和 `y` 会通过隐式数据类型转换使数据类型保持一致。如果数据类型不同，低精度的数据类型会被转换到高精度的数据类型。 + + 参数： + - **y** (Tensor) - 输入Tensor，shape应能在广播后与 `x` 相同，或 `x` 的shape在广播后与 `y` 相同。 + + 返回： + Tensor，与广播后的输入shape相同，和 `x` 数据类型相同。 + + 异常： + - **TypeError** - `x` 或 `y` 不是Tensor。 + - **RuntimeError** - `x` 与 `y` 之间的数据类型转换不被支持 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bernoulli.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bernoulli.rst new file mode 100644 index 00000000000..d5338429cd2 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bernoulli.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.bernoulli +========================== + +.. py:method:: mindspore.Tensor.bernoulli(p=0.5, seed=-1) + + 以p的概率随机将输出的元素设置为0或1，服从伯努利分布。 + + .. math:: + + out_{i} \sim Bernoulli(p_{i}) + + 参数： + - **p** (Union[Tensor, float], 可选) - shape需要可以被广播到当前Tensor。其数据类型为float32或float64。`p` 中每个值代表输出Tensor中对应广播位置为1的概率，数值范围在0到1之间。默认值：0.5。 + - **seed** (int, 可选) - 随机种子，用于生成随机数，数值范围是-1或正整数。默认值：-1，代表取当前时间戳。 + + 返回： + Tensor，shape和数据类型与当前Tensor相同。 + + 异常： + - **TypeError** - 当前Tensor的数据类型不在int8, uint8, int16, int32，int64，bool, float32和float64中。 + - **TypeError** - `p` 的数据类型既不是float32也不是float64。 + - **TypeError** - `seed` 不是int。 + - **ValueError** - `seed` 是负数且不为-1。 + - **ValueError** - `p` 数值范围不在0到1之间。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_and.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_and.rst new file mode 100644 index 00000000000..7be1f62444a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_and.rst @@ -0,0 +1,14 @@ +mindspore.Tensor.bitwise_and +============================ + +.. py:method:: mindspore.Tensor.bitwise_and(x) + + 逐元素执行两个Tensor的与运算。 + + 更多细节参考 :func:`mindspore.ops.bitwise_and`。 + + 参数： + - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 + + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_or.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_or.rst new file mode 100644 index 00000000000..76c9a11a736 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_or.rst @@ -0,0 +1,14 @@ +mindspore.Tensor.bitwise_or +=========================== + +.. py:method:: mindspore.Tensor.bitwise_or(x) + + 逐元素执行两个Tensor的或运算。 + + 更多细节参考 :func:`mindspore.ops.bitwise_or`。 + + 参数： + - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 + + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_xor.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_xor.rst new file mode 100644 index 00000000000..e7bf2e7fb4e --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.bitwise_xor.rst @@ -0,0 +1,14 @@ +mindspore.Tensor.bitwise_xor +============================ + +.. py:method:: mindspore.Tensor.bitwise_xor(x) + + 逐元素执行两个Tensor的异或运算。 + + 更多细节参考 :func:`mindspore.ops.bitwise_xor`。 + + 参数： + - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 + + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.broadcast_to.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.broadcast_to.rst new file mode 100644 index 00000000000..19a445f7a61 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.broadcast_to.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.broadcast_to +============================= + +.. py:method:: mindspore.Tensor.broadcast_to(shape) + + 将输入shape广播到目标shape。 + + 更多细节请参考 :func:`mindspore.ops.broadcast_to` 。 + + 参数： + - **shape** (tuple) - 要广播的目标形状。可以由用户指定，或在要广播的维度上指定-1，它将被该位置的输入张量形状替换。 + + 返回： + Tensor， 形状为用户指定的 `shape`，类型和 `self` 相同。 + + 异常： + - **TypeError** - 如果输入的 `shape` 参数不是tuple类型。 + - **ValueError** - 如果输入的 `shape` 与 `self` 的形状不兼容，或者目标 `shape` 中的-1位于无效位置。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ceil.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ceil.rst new file mode 100644 index 00000000000..fb87e6684da --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ceil.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.ceil +===================== + +.. py:method:: mindspore.Tensor.ceil() + + 向上取整。 + + 返回： + Tensor。向上取整的结果。 + + 异常： + - **TypeError** - 如果当前Tensor的数据类型不是float16或者float32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.choose.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.choose.rst new file mode 100644 index 00000000000..704b8baaea9 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.choose.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.choose +======================= + +.. py:method:: mindspore.Tensor.choose(choices, mode='clip') + + 根据原始Tensor数组和一个索引数组构造一个新的Tensor。 + + 参数： + - **choices** (Union[tuple, list, Tensor]) - 索引选择数组。原始输入Tensor和 `choices` 的广播维度必须相同。如果 `choices` 本身是一个Tensor，则其最外层的维度（即，对应于第0维的维度）被用来定义 `choices` 数组。 + - **mode** ('raise', 'wrap', 'clip', optional) - 指定如何处理 `[0, n-1]` 外部的索引： + + - **raise** - 引发异常（默认）； + - **wrap** - 原值映射为对n取余后的值； + - **clip** - 大于n-1的值会被映射为n-1。该模式下禁用负数索引。 + + 返回： + Tensor，合并后的结果。 + + 异常： + - **ValueError** - 输入Tensor和任一 `choices` 无法广播。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.clip.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.clip.rst new file mode 100644 index 00000000000..4530d2a980a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.clip.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.clip +===================== + +.. py:method:: mindspore.Tensor.clip(xmin, xmax, dtype=None) + + 裁剪Tensor中的值。 + + 给定一个区间，区间外的值将被裁剪到区间边缘。 + 例如，如果指定的间隔为 :math:`[0, 1]` ，则小于0的值将变为0，大于1的值将变为1。 + + .. note:: + 目前不支持裁剪 `xmin=nan` 或 `xmax=nan` 。 + + 参数： + - **xmin** (Tensor, scalar, None) - 最小值。如果值为None，则不在间隔的下边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。 + - **xmax** (Tensor, scalar, None) - 最大值。如果值为None，则不在间隔的上边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。如果 `xmin` 或 `xmax` 是Tensor，则三个Tensor将被广播进行shape匹配。 + - **dtype** (`mindspore.dtype` , optional) - 覆盖输出Tensor的dtype。默认值为None。 + + 返回： + Tensor，含有输入Tensor的元素，其中values < `xmin` 被替换为 `xmin` ，values > `xmax` 被替换为 `xmax` 。 + + 异常： + - **TypeError** - 输入的类型与Tensor不一致。 + - **ValueError** - 输入与Tensor的shape不能广播，或者 `xmin` 和 `xmax` 都是 `None` 。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.col2im.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.col2im.rst new file mode 100644 index 00000000000..dbbae6ff01f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.col2im.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.col2im +======================= + +.. py:method:: mindspore.Tensor.col2im(output_size, kernel_size, dilation, padding_value, stride) + + 将一组滑动的局部块组合成一个大张量。 + + 参数： + - **output_size** (Tensor) - 输出张量的后两维的shape。 + - **kernel_size** (Union[int, tuple[int], list[int]]) - 滑动窗口的大小。 + - **dilation** (Union[int, tuple[int], list[int]]) - 滑动窗口扩张的大小。 + - **padding_value** (Union[int, tuple[int], list[int]]) - 填充的大小。 + - **stride** (Union[int, tuple[int], list[int]]) - 步长的大小。 + + 返回： + Tensor，输出的张量，维度和类型和输入一致。 + + 异常： + - **TypeError** - 如果 `kernel_size`，`dilation`，`padding_value`，`stride` 不属于 Union[int, tuple[int], list[int]]。 + - **ValueError** - 如果 `kernel_size`，`dilation`，`stride` 值小于等于0或者个数大于2。 + - **ValueError** - 如果 `padding_value` 值小于0或者个数大于2。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.copy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.copy.rst new file mode 100644 index 00000000000..8e6abb70c14 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.copy.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.copy +===================== + +.. py:method:: mindspore.Tensor.copy() + + 复制一个Tensor并返回。 + + .. note:: + 当前实现不支持类似NumPy的 `order` 参数。 + + 返回： + 复制的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cosh.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cosh.rst new file mode 100644 index 00000000000..6d5bb189926 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cosh.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.cosh +===================== + +.. py:method:: mindspore.Tensor.cosh() + + 逐元素计算双曲余弦值。 + + .. math:: + out_i = cosh(x_i) + + 返回： + Tensor，数据类型和shape与 `x` 相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummax.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummax.rst new file mode 100644 index 00000000000..7eab7c6b5bb --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummax.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.cummax +======================= + +.. py:method:: mindspore.Tensor.cummax(axis) + + 返回一个元组（最值、索引），其中最值是输入张量 `x` 沿维度 `axis` 的累积最大值，索引是每个最大值的索引位置。 + + .. math:: + \begin{array}{ll} \\ + y{i} = max(x{1}, x{2}, ... , x{i}) + \end{array} + + 参数： + - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 + + 返回： + 一个包含两个Tensor的元组，分别表示累积最大值和对应索引。 + + 异常： + - **TypeError** - 如果 `axis` 不是int。 + - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummin.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummin.rst new file mode 100644 index 00000000000..277f94a0fd3 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cummin.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.cummin +======================= + +.. py:method:: mindspore.Tensor.cummin(axis) + + 返回一个元组（最值、索引），其中最值是输入张量 `x` 沿维度 `axis` 的累积最小值，索引是每个最小值的索引位置。 + + .. math:: + \begin{array}{ll} \\ + y{i} = min(x{1}, x{2}, ... , x{i}) + \end{array} + + 参数： + - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 + + 返回： + 一个包含两个Tensor的元组，分别表示累积最小值和对应索引。 + + 异常： + - **TypeError** - 如果 `axis` 不是int。 + - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cumsum.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cumsum.rst new file mode 100644 index 00000000000..21831c54bc5 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.cumsum.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.cumsum +======================= + +.. py:method:: mindspore.Tensor.cumsum(axis=None, dtype=None) + + 返回指定轴方向上元素的累加值。 + + .. note:: + 如果 `dtype` 为 `int8` , `int16` 或 `bool` ，则结果 `dtype` 将提升为 `int32` ，不支持 `int64` 。 + + 参数： + - **axis** (int, optional) - 轴，在该轴方向上的累积和。默认情况下，计算所有元素的累加和。 + - **dtype** (`mindspore.dtype` , optional) - 如果未指定参数值，则保持与原始Tensor相同，除非参数值是一个精度小于 `float32` 的整数。在这种情况下，使用 `float32` 。默认值：None。 + + 异常： + - **ValueError** - 轴超出范围。 + + 返回： + Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diag.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diag.rst new file mode 100644 index 00000000000..8bb30b44a80 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diag.rst @@ -0,0 +1,14 @@ +mindspore.Tensor.diag +===================== + +.. py:method:: mindspore.Tensor.diag() + + 用给定的对角线值构造对角线张量。 + + 假设输入Tensor维度为 :math:`[D_1,... D_k]` ，则输出是一个rank为2k的tensor，其维度为 :math:`[D_1,..., D_k, D_1,..., D_k]` ，其中 :math:`output[i_1,..., i_k, i_1,..., i_k] = self[i_1,..., i_k]` 并且其他位置的值为0。 + + 返回： + Tensor，具有与输入Tensor相同的数据类型。 + + 异常： + - **ValueError** - 输入Tensor的rank小于1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diagonal.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diagonal.rst new file mode 100644 index 00000000000..6ed2f21d64b --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.diagonal.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.diagonal +========================= + +.. py:method:: mindspore.Tensor.diagonal(offset=0, axis1=0, axis2=1) + + 返回指定的对角线。 + + 参数： + - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 + - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 + - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 + + 返回： + Tensor，如果Tensor是二维，则返回值是一维数组。 + + 异常： + - **ValueError** - 输入Tensor的维度少于2。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.dtype.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.dtype.rst new file mode 100644 index 00000000000..2190064cbc4 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.dtype.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.dtype +====================== + +.. py:method:: mindspore.Tensor.dtype + :property: + + 返回张量的数据类型（:class:`mindspore.dtype`）。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erf.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erf.rst new file mode 100644 index 00000000000..905591e430a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erf.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.erf +==================== + +.. py:method:: mindspore.Tensor.erf() + + 逐元素计算原Tensor的高斯误差函数。 + 更多细节参考 :func:`mindspore.ops.erf`。 + + 返回： + Tensor，具有与原Tensor相同的数据类型和shape。 + + 异常： + - **TypeError** - 原Tensor的数据类型既不是float16也不是float32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erfc.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erfc.rst new file mode 100644 index 00000000000..59e8989773c --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.erfc.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.erfc +===================== + +.. py:method:: mindspore.Tensor.erfc() + + 逐元素计算原Tensor的互补误差函数。 + 更多细节参考 :func:`mindspore.ops.erfc`。 + + 返回： + Tensor，具有与原Tensor相同的数据类型和shape。 + + 异常： + - **TypeError** - 原Tensor的数据类型既不是float16也不是float32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_as.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_as.rst new file mode 100644 index 00000000000..efe064646af --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_as.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.expand_as +========================== + +.. py:method:: mindspore.Tensor.expand_as(x) + + 将目标张量的维度扩展为输入张量的维度。 + + 参数： + - **x** (Tensor) - 输入的张量。 + + 返回： + 维度与输入张量的相同的Tensor。输出张量的维度必须遵守广播规则。广播规则指输出张量的维度需要扩展为输入张量的维度，如果目标张量的维度大于输入张量的维度，则不满足广播规则。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_dims.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_dims.rst new file mode 100644 index 00000000000..4708e83d5cd --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.expand_dims.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.expand_dims +============================ + +.. py:method:: mindspore.Tensor.expand_dims(axis) + + 沿指定轴扩展Tensor维度。 + + 参数： + - **axis** (int) - 扩展维度指定的轴。 + + 返回： + Tensor，指定轴上扩展的维度为1。 + + 异常： + - **TypeError** - axis不是int类型。 + - **ValueError** - axis的取值不在[-self.ndim - 1, self.ndim + 1)。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fill.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fill.rst new file mode 100644 index 00000000000..daf85347f22 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fill.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.fill +===================== + +.. py:method:: mindspore.Tensor.fill(value) + + 用标量值填充数组。 + + .. note:: + 与NumPy不同，Tensor.fill()将始终返回一个新的Tensor，而不是填充原来的Tensor。 + + 参数： + - **value** (Union[None, int, float, bool]) - 所有元素都被赋予这个值。 + + 返回： + Tensor，与原来的dtype和shape相同的Tensor。 + + 异常： + - **TypeError** - 输入参数具有前面未指定的类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fills.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fills.rst new file mode 100644 index 00000000000..15c1ea5f4e1 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.fills.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.fills +====================== + +.. py:method:: mindspore.Tensor.fills(value) + + 创建一个与当前Tensor具有相同shape和type的Tensor，并用标量值填充。 + + .. note:: + 与NumPy不同，Tensor.fills()将始终返回一个新的Tensor，而不是填充原来的Tensor。 + + 参数： + - **value** (Union[int, float, Tensor]) - 用来填充输出Tensor的值。数据类型为int，float或0-维Tensor。 + + 返回： + Tensor，与当前Tensor具有相同的shape和type。 + + 异常： + - **TypeError** - `value` 具有前面未指定的类型。 + - **RuntimeError** - `value` 不能转换为与当前Tensor相同的类型。 + - **ValueError** - `value` 是非0维Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flatten.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flatten.rst new file mode 100644 index 00000000000..bc03043ed1a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flatten.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.flatten +======================== + +.. py:method:: mindspore.Tensor.flatten(order='C') + + 返回展开成一维的Tensor的副本。 + + 参数： + - **order** (str, optional) - 可以在'C'和'F'之间进行选择。'C'表示按行优先（C风格）顺序展开。'F'表示按列优先顺序（Fortran风格）进行扁平化。仅支持'C'和'F'。默认值：'C'。 + + 返回： + Tensor，具有与输入相同的数据类型。 + + 异常： + - **TypeError** - `order` 不是字符串类型。 + - **ValueError** - `order` 是字符串类型，但不是'C'或'F'。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flush_from_cache.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flush_from_cache.rst new file mode 100644 index 00000000000..6e919294ae0 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.flush_from_cache.rst @@ -0,0 +1,6 @@ +mindspore.Tensor.flush_from_cache +================================= + +.. py:method:: mindspore.Tensor.flush_from_cache() + + 如果Tensor开启缓存作用，则将缓存数据刷新到host侧。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.from_numpy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.from_numpy.rst new file mode 100644 index 00000000000..344a5bf1dfa --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.from_numpy.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.from_numpy +=========================== + +.. py:method:: mindspore.Tensor.from_numpy(array) + :staticmethod: + + 通过不复制数据的方式将Numpy数组转换为张量。 + + 参数： + - **array** (numpy.array) - 输入数组。 + + 返回： + 与输入的张量具有相同的数据类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather.rst new file mode 100644 index 00000000000..0bd577d6a19 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.gather +======================= + +.. py:method:: mindspore.Tensor.gather(input_indices, axis) + + 返回指定 `axis` 上 `input_indices` 的元素对应的输入Tensor切片，输入Tensor的形状是 :math:`(x_1, x_2, ..., x_R)`。为了方便描述，对于输入Tensor记为 `input_params`。 + + .. note:: + 1. input_indices 的值必须在 `[0, input_params.shape[axis])` 的范围内，结果未定义超出范围。 + 2. 当前在Ascend平台，input_params的值不能是 `bool_ `_ 类型。 + + 参数： + - **input_indices** (Tensor) - 待切片的索引张量，其形状为 :math:`(y_1, y_2, ..., y_S)`，代表指定原始张量元素的索引，其数据类型包括：int32，int64。 + - **axis** (int) - 指定维度索引的轴以搜集切片。 + + 返回： + Tensor，其中shape维度为 :math:`input\_params.shape[:axis] + input\_indices.shape + input\_params.shape[axis + 1:]`。 + + 异常： + - **TypeError** - 如果 `axis` 不是一个整数。 + - **TypeError** - 如果 `input_indices` 不是一个整数类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_elements.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_elements.rst new file mode 100644 index 00000000000..564c1028944 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_elements.rst @@ -0,0 +1,31 @@ +mindspore.Tensor.gather_elements +================================ + +.. py:method:: mindspore.Tensor.gather_elements(dim, index) + + 获取指定轴的元素。 + + 对于三维Tensor，输出为： + + .. code-block:: + + output[i][j][k] = x[index[i][j][k]][j][k] # if dim == 0 + + output[i][j][k] = x[i][index[i][j][k]][k] # if dim == 1 + + output[i][j][k] = x[i][j][index[i][j][k]] # if dim == 2 + + `index` 与当前Tensor拥有一样的维度长度，且除 `dim` 维外其他维度一致。如果维度 `dim` 为i，当前Tensor是shape为 :math:`(z_0, z_1, ..., z_i, ..., z_{n-1})` 的n维Tensor，则 `index` 必须是shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})` 的n维Tensor，其中 `y` 大于等于1。输出的shape与 `index` 相同。 + + 参数： + - **dim** (int) - 获取元素的轴。数据类型为int32或int64。取值范围为[-self.ndim, self.ndim)。 + - **index** (Tensor) - 获取收集元素的索引。支持的数据类型包括：int32，int64。每个索引元素的取值范围为[-self.shape(dim), self.shape(dim))。 + + 返回： + Tensor，shape与 `index` 相同，即其shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})`，数据类型与 `self.dtype` 相同。 + + 异常： + - **TypeError** - `dim` 或 `index` 的数据类型既不是int32，也不是int64。 + - **ValueError** - `self` 和 `index` 的维度长度不一致。 + - **ValueError** - `self` 和 `index` 除 `dim` 维外的维度不一致。 + - **ValueError** - `dim` 的值不在合理范围内。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_nd.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_nd.rst new file mode 100644 index 00000000000..84313dbf60d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.gather_nd.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.gather_nd +========================== + +.. py:method:: mindspore.Tensor.gather_nd(indices) + + 按索引从输入Tensor中获取切片。 + 使用给定的索引从具有指定形状的输入Tensor中搜集切片。 + 输入Tensor的shape是 :math:`(N,*)` ，其中 :math:`*` 表示任意数量的附加维度。下文中的 `input_x` 代指输入Tensor本身。 + `indices` 是一个K维的整数张量，假定它的K-1维张量中的每一个元素是输入Tensor的切片，那么有： + + .. math:: + output[(i_0, ..., i_{K-2})] = input\_x[indices[(i_0, ..., i_{K-2})]] + + `indices` 的最后一维不能超过输入Tensor的秩： + :math:`indices.shape[-1] <= input\_x.rank`。 + + 参数： + - **indices** (Tensor) - 获取收集元素的索引张量，其数据类型包括：int32，int64。 + + 返回： + Tensor，具有与输入Tensor相同的数据类型，shape维度为 :math:`indices\_shape[:-1] + input\_x\_shape[indices\_shape[-1]:]`。 + + 异常： + - **ValueError** - 如果输入Tensor的shape长度小于 `indices` 的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ger.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ger.rst new file mode 100644 index 00000000000..5353bbb7609 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ger.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.ger +==================== + +.. py:method:: mindspore.Tensor.ger(x) + + 计算两个Tensor的外积，即计算此Tensor 和 `x` 的外积。如果此Tensor shape为 :math:`(m,)` ，`x` shape为 :math:`(n,)` ， + 那么输出就是一个shape为 :math:`(m, n)` 的Tensor。 + + .. note:: + Ascend平台暂不支持float64数据格式的输入。 + + 更多参考详见 :func:`mindspore.ops.ger`。 + + 参数： + - **x** (Tensor) - 输入Tensor，数据类型为float16、float32或者float64。 + + 返回： + Tensor，是一个与此Tensor相同数据类型的输出矩阵。当此Tensor shape为 :math:`(m,)` ， `x` shape为 :math:`(n,)` ， + 那么输出shape为 :math:`(m, n)` 。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hardshrink.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hardshrink.rst new file mode 100644 index 00000000000..6ec071a025e --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hardshrink.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.hardshrink +=========================== + +.. py:method:: mindspore.Tensor.hardshrink(lambd=0.5) + + Hard Shrink激活函数，按输入元素计算输出，公式定义如下： + + .. math:: + \text{HardShrink}(x) = + \begin{cases} + x, & \text{ if } x > \lambda \\ + x, & \text{ if } x < -\lambda \\ + 0, & \text{ otherwise } + \end{cases} + + 参数： + - **lambd** (float) - Hard Shrink公式定义的阈值 :math:`\lambda` 。默认值：0.5。 + + 返回： + Tensor，shape和数据类型与输入相同。 + + 异常： + - **TypeError** - `lambd` 不是float。 + - **TypeError** - 原始Tensor的dtype既不是float16也不是float32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.has_init.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.has_init.rst new file mode 100644 index 00000000000..32c214ef4dc --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.has_init.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.has_init +========================= + +.. py:method:: mindspore.Tensor.has_init + :property: + + Tensor是否已经初始化。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.index_fill.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.index_fill.rst new file mode 100644 index 00000000000..8efab0049fc --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.index_fill.rst @@ -0,0 +1,27 @@ +mindspore.Tensor.index_fill +=========================== + +.. py:method:: mindspore.Tensor.index_fill(dim, index, value) + + 按 `index` 中给定的顺序选择索引，将输入 `value` 值填充到当前Tensor的所有 `dim` 维元素。 + + 参数： + - **dim** (Union[int, Tensor]) - 填充输入Tensor的维度，要求是一个int或者数据类型为int32或int64的0维Tensor。 + - **index** (Tensor) - 填充输入Tensor的索引，数据类型为int32。 + - **value** (Union[bool, int, float, Tensor]) - 填充输入Tensor的值。如果 `value` 是Tensor，那么 `value` 要求是数据类型与当前Tensor相同的0维Tensor。否则，该值会自动转化为一个数据类型与当前Tensor相同的0维Tensor。 + + 返回： + 填充后的Tensor。shape和数据类型与当前Tensor相同。 + + 异常： + - **TypeError** - `dim` 的类型不是int或者Tensor。 + - **TypeError** - 当 `dim` 是Tensor时， `dim` 的数据类型不是int32或者int64。 + - **TypeError** - `index` 的类型不是Tensor。 + - **TypeError** - `index` 的数据类型不是int32。 + - **TypeError** - `value` 的类型不是bool、int、float或者Tensor。 + - **TypeError** - 当 `value` 是Tensor时， `value` 的数据类型和当前Tensor的数据类型不相同。 + - **ValueError** - 当 `dim` 是Tensor时， `dim` 的维度不等于0。 + - **ValueError** - `index` 的维度大于1。 + - **ValueError** - 当 `value` 是Tensor时， `value` 的维度不等于0。 + - **RuntimeError** - `dim` 值超出范围[-self.ndim, self.ndim - 1]。 + - **RuntimeError** - `index` 存在值超出范围[-self.shape[dim], self.shape[dim]-1]。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.init_data.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.init_data.rst new file mode 100644 index 00000000000..baadf187dbf --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.init_data.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.init_data +========================== + +.. py:method:: mindspore.Tensor.init_data(slice_index=None, shape=None, opt_shard_group=None) + + 获取此Tensor的数据。 + + .. note:: 对于同一个Tensor，只可以调用一次 `init_data` 函数。 + + 参数： + - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 + - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 + - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数的切片。默认值：None。 + + 返回： + 初始化的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inplace_update.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inplace_update.rst new file mode 100644 index 00000000000..ce759397ad2 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inplace_update.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.inplace_update +=============================== + +.. py:method:: mindspore.Tensor.inplace_update(v, indices) + + 根据 `indices` 以 `v` 来更新Tensor中的值。 + + .. note:: + `indices` 只能沿着最高轴进行索引。 + + 参数： + - **v** (Tensor) - 用来更新的值。有相同的数据类型和除第一维外相同的shape。第一维的大小应该与 `indices` 大小相同。 + - **indices** (Union[int, tuple]) - 待更新值在原Tensor中的索引。 + + 返回： + Tensor，更新后的Tensor。 + + 异常： + - **TypeError** - `indices` 不是int或tuple。 + - **TypeError** - `indices` 是元组，但是其中的元素不是int。 + - **ValueError** - Tensor的shape与 `v` 的shape不同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inv.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inv.rst new file mode 100644 index 00000000000..df6a1dc7156 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.inv.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.inv +==================== + +.. py:method:: mindspore.Tensor.inv() + + 计算当前Tensor的倒数。 + + .. math:: + out_i = \frac{1}{x_{i} } + + 其中 `x` 表示当前Tensor。 + + 返回： + Tensor，shape和类型与当前Tensor相同。 + + 异常： + - **TypeError** - 当前Tensor的数据类型不为float16、float32或int32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.invert.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.invert.rst new file mode 100644 index 00000000000..1f42bf844e7 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.invert.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.invert +======================= + +.. py:method:: mindspore.Tensor.invert() + + 按位翻转当前Tensor。 + + .. math:: + out_i = \sim x_{i} + + 其中 `x` 表示当前Tensor。 + + 返回： + Tensor，shape和类型与当前Tensor相同。 + + 异常： + - **TypeError** - 当前Tensor的数据类型不为int16或uint16。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.isclose.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.isclose.rst new file mode 100644 index 00000000000..3dab3905345 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.isclose.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.isclose +======================== + +.. py:method:: mindspore.Tensor.isclose(x2, rtol=1e-05, atol=1e-08, equal_nan=False) + + 返回一个布尔型Tensor，表示当前Tensor与 `x2` 的对应元素的差异是否在容忍度内相等。 + + 参数： + - **x2** (Tensor) - 对比的第二个输入，支持的类型有float32，float16，int32。 + - **rtol** (float, optional) - 相对容忍度。默认值：1e-05。 + - **atol** (float, optional) - 绝对容忍度。默认值：1e-08。 + - **equal_nan** (bool, optional) - IsNan的输入，任意维度的Tensor。默认值：False。 + + 返回： + Tensor，shape与广播后的shape相同，数据类型是布尔型。 + + 异常： + - **TypeError** - 当前Tensor和 `x2` 中的任何一个不是Tensor。 + - **TypeError** - 当前Tensor和 `x2` 的数据类型不是float16、float32或int32之一。 + - **TypeError** - `atol` 和 `rtol` 中的任何一个不是float。 + - **TypeError** - `equal_nan` 不是bool。 + - **TypeError** - 当前Tensor和 `x2` 的数据类型不同。 + - **ValueError** - 当前Tensor和 `x2` 无法广播。 + - **ValueError** - `atol` 和 `rtol` 中的任何一个小于零。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.item.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.item.rst new file mode 100644 index 00000000000..6b37203548f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.item.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.item +===================== + +.. py:method:: mindspore.Tensor.item(index=None) + + 获取Tensor中指定索引的元素。 + + .. note:: + Tensor.item返回的是Tensor标量，而不是Python标量。 + + 参数： + - **index** (Union[None, int, tuple(int)]) - Tensor的索引。默认值：None。 + + 返回： + Tensor标量，dtype与原始Tensor的相同。 + + 异常： + - **ValueError** - `index` 的长度不等于Tensor的ndim。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemset.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemset.rst new file mode 100644 index 00000000000..151fcc3d7c3 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemset.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.itemset +======================== + +.. py:method:: mindspore.Tensor.itemset(*args) + + 将标量插入到Tensor（并将标量转换为Tensor的数据类型）。 + + 至少有1个参数，并且最后一个参数被定义为设定值。 + Tensor.itemset(\*args)等同于 :math:`Tensor[args] = item` 。 + + 参数： + - **args** (Union[(numbers.Number), (int/tuple(int), numbers.Number)]) - 指定索引和值的参数。如果 `args` 包含一个参数（标量），则其仅在Tensor大小为1的情况下使用。如果 `args` 包含两个参数，则最后一个参数是要设置的值且必须是标量，而第一个参数指定单个Tensor元素的位置。参数值是整数或者元组。 + + 返回： + 一个新的Tensor，其值为 :math:`Tensor[args] = item` 。 + + 异常： + - **ValueError** - 第一个参数的长度不等于Tensor的ndim。 + - **IndexError** - 只提供了一个参数，并且原来的Tensor不是标量。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemsize.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemsize.rst new file mode 100644 index 00000000000..dd6ad62c2f8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.itemsize.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.itemsize +========================= + +.. py:method:: mindspore.Tensor.itemsize + :property: + + 返回一个Tensor元素的长度（以字节为单位）。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.lerp.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.lerp.rst new file mode 100644 index 00000000000..e2e463f49e8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.lerp.rst @@ -0,0 +1,26 @@ +mindspore.Tensor.lerp +===================== + +.. py:method:: mindspore.Tensor.lerp(end, weight) + + 基于某个浮点数Scalar或权重Tensor的值， 计算当前Tensor和 `end` Tensor之间的线性插值。 + + 如果参数 `weight` 是一个Tensor，那么另两个输入的维度信息可以被广播到当前Tensor。 + 如果参数 `weight` 是一个Scalar， 那么 `end` 的维度信息可以被广播到当前Tensor。 + + 参数： + - **end** (Tensor) - 进行线性插值的Tensor结束点，其数据类型必须为float16或者float32。 + - **weight** (Union[float, Tensor]) - 线性插值公式的权重参数。当为Scalar时，其数据类型为float，当为Tensor时，其数据类型为float16或者float32。 + + 返回： + 返回新的Tensor，其数据类型和维度必须和输入中的当前Tensor保持一致。 + + 异常： + - **TypeError** - 如果 `end` 不是Tensor。 + - **TypeError** - 如果 `weight` 不是float类型Scalar或者Tensor。 + - **TypeError** - 如果 `end` 的数据类型不是float16或者float32。 + - **TypeError** - 如果 `weight` 为Tensor且 `weight` 不是float16或者float32。 + - **TypeError** - 如果当前Tensor和 `end` 的数据类型不一致。 + - **TypeError** - 如果 `weight` 为Tensor且 `end` 、 `weight` 和当前Tensor数据类型不一致。 + - **ValueError** - 如果 `end` 的维度信息无法相互广播到当前Tensor。 + - **ValueError** - 如果 `weight` 为Tensor且 `weight` 的维度信息无法广播到当前Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log1p.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log1p.rst new file mode 100644 index 00000000000..f036203091f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log1p.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.log1p +====================== + +.. py:method:: mindspore.Tensor.log1p() + + 对当前Tensor逐元素加一后计算自然对数。 + + .. math:: + out_i = {log_e}(x_i + 1) + + 返回： + Tensor，与 `x` 的shape相同。 + + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型非float16或float32。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log_matrix_determinant.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log_matrix_determinant.rst new file mode 100644 index 00000000000..47455c4780f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.log_matrix_determinant.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.log_matrix_determinant +======================================= + +.. py:method:: mindspore.Tensor.log_matrix_determinant() + + 计算一个或多个平方矩阵行列式绝对值的对数的符号和绝对值的对数。 + + `x` 指的当前 Tensor。 + + 返回： + Tensor，行列式的绝对值的对数的符号， 形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 + + Tensor，行列式的绝对值的对数， 形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 + + 异常： + - **TypeError** - `x` 不为 Tensor。 + - **TypeError** - `x` 的数据类型不为以下类型： mstype.float32、 mstype.float64、 mstype.complex64 和 mstype.complex128。 + - **ValueError** - `x` 的最后两个维度大小不同。 + - **ValueError** - `x` 的维数小于2。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.logit.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.logit.rst new file mode 100644 index 00000000000..4b3c126c506 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.logit.rst @@ -0,0 +1,31 @@ +mindspore.Tensor.logit +====================== + +.. py:method:: mindspore.Tensor.logit(eps=None) + + 逐元素计算张量的logit值，当 eps 不是 None 时， `x` 中的元素被截断到范围[eps, 1-eps]内。 + 当 eps 为 None 时，输入 `x` 不进行数值截断。 + + `x` 指的当前 Tensor。 + + .. math:: + \begin{align} + y_{i} & = \ln(\frac{z_{i}}{1 - z_{i}}) \\ + z_{i} & = \begin{cases} + x_{i} & \text{if eps is None} \\ + \text{eps} & \text{if } x_{i} \lt \text{eps} \\ + x_{i} & \text{if } \text{eps} \leq x_{i} \leq 1 - \text{eps} \\ + 1 - \text{eps} & \text{if } x_{i} \gt 1 - \text{eps} + \end{cases} + \end{align} + + 参数： + - **eps** (float) - epsilon值。输入的数值界限被定义[eps, 1-eps]。 默认值：None。 + + 返回： + Tensor，具有与 `x` 相同的shape。 + + 异常： + - **TypeError** - `eps` 不是float类型。 + - **TypeError** - `x` 不是Tensor类型。 + - **TypeError** - `x` 的数据类型不是float16、float32或float64。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_fill.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_fill.rst new file mode 100644 index 00000000000..c118e61612a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_fill.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.masked_fill +============================ + +.. py:method:: mindspore.Tensor.masked_fill(mask, value) + + 将掩码位置为True的位置填充指定的值。该Tensor和 `mask` 的shape需相同或可广播。 + + 参数： + - **mask** (Tensor[bool]) - mask矩阵，值为bool类型的Tensor。 + - **value** (Union[float, Tensor]) - 填充值，其数据类型与该Tensor相同。 + + 返回： + Tensor，shape和dtype与该Tensor相同。 + + 异常： + - **TypeError** - `mask` 不是Tensor。 + - **TypeError** - `mask` 的数据类型不是bool。 + - **ValueError** - 该Tensor和 `mask` 的shape不可广播。 + - **TypeError** - 该Tensor 或 `value` 的数据类型不是float16、float32、int8、或int32。 + - **TypeError** - `value` 的数据类型与该Tensor不同。 + - **TypeError** - `value` 既不是float也不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_select.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_select.rst new file mode 100644 index 00000000000..5a0572e97b6 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.masked_select.rst @@ -0,0 +1,15 @@ +mindspore.Tensor.masked_select +============================== + +.. py:method:: mindspore.Tensor.masked_select(mask) + + 返回一个一维张量，其中的内容是此张量中对应于 `mask` 张量中True位置的值。`mask` 张量的shape与此张量的shape不需要一样，但必须符合广播规则。 + + 参数： + - **mask** (Tensor[bool]) - 值为bool类型的张量。 + + 返回： + 一个一维张量，类型与此张量相同。 + + 异常： + - **TypeError** - `mask` 不是bool类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.matrix_determinant.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.matrix_determinant.rst new file mode 100644 index 00000000000..7e30bed5e43 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.matrix_determinant.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.matrix_determinant +=================================== + +.. py:method:: mindspore.Tensor.matrix_determinant() + + 计算一个或多个方阵的行列式。 + + `x` 指的当前 Tensor。 + + 返回： + Tensor，形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 + + 异常： + - **TypeError** - `x` 不为 Tensor。 + - **TypeError** - `x` 的数据类型不为以下类型： mstype.float32、 mstype.float64、 mstype.complex64 和 mstype.complex128。 + - **ValueError** - `x` 的最后两个维度大小不同。 + - **ValueError** - `x` 的维数小于2。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.max.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.max.rst new file mode 100644 index 00000000000..100638c6f88 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.max.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.max +==================== + +.. py:method:: mindspore.Tensor.max(axis=None, keepdims=False, initial=None, where=True) + + 返回Tensor的最大值或轴方向上的最大值。 + + 参数： + - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最大值，而不是在单个轴或所有轴上进行选择。默认值：None。 + - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 + - **initial** (scalar, optional) - 输出元素的最小值。如果对空切片进行计算，则该参数必须设置。默认值：None。 + - **where** (bool Tensor, optional) - 一个bool数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 + + 返回： + Tensor或标量，输入Tensor的最大值。如果 `axis` 为None，则结果是一个标量值。如果提供了 `axis` ，则结果是Tensor ndim - 1维度的一个数组。 + + 异常： + - **TypeError** - 参数具有前面未指定的类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.mean.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.mean.rst new file mode 100644 index 00000000000..1da09f17e7f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.mean.rst @@ -0,0 +1,13 @@ +mindspore.Tensor.mean +===================== + +.. py:method:: mindspore.Tensor.mean(axis=(), keep_dims=False) + + 返回指定维度上所有元素的均值，并降维。 + + 参数： + - **axis** (Union[None, int, tuple(int), list(int)]) - 计算mean的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int、tuple(int)或list(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 + - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 + + 返回： + 与输入的张量具有相同的数据类型的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.min.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.min.rst new file mode 100644 index 00000000000..43c8b5f3466 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.min.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.min +==================== + +.. py:method:: mindspore.Tensor.min(axis=None, keepdims=False, initial=None, where=True) + + 返回Tensor的最小值或轴方向上的最小值。 + + 参数： + - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最小值，而不是在单个轴或所有轴上进行选择。默认值：None。 + - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 + - **initial** (scalar, optional) - 输出元素的最大值。如果对空切片进行计算，则该参数必须设置。默认值：None。 + - **where** (bool Tensor, optional) - 一个布尔数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 + + 返回： + Tensor或标量，输入Tensor的最小值。如果轴为None，则结果为一个标量值。如果提供了 `axis` ，则结果是Tensor.ndim - 1维度的一个数组。 + + 异常： + - **TypeError** - 参数具有前面未指定的类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.narrow.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.narrow.rst new file mode 100644 index 00000000000..69d3f0b7372 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.narrow.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.narrow +======================= + +.. py:method:: mindspore.Tensor.narrow(axis, start, length) + + 沿指定轴，指定起始位置获取指定长度的Tensor。 + + 参数： + - **axis** (int) - 指定的轴。 + - **start** (int) - 指定的起始位置。 + - **length** (int) - 指定的长度。 + + 返回： + Tensor。 + + 异常： + - **TypeError** - axis不是int类型。 + - **TypeError** - start不是int类型。 + - **TypeError** - length不是int类型。 + - **ValueError** - axis取值不在[0, ndim-1]范围内。 + - **ValueError** - start取值不在[0, shape[axis]-1]范围内。 + - **ValueError** - start+length超出Tensor的维度范围shape[axis]-1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nbytes.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nbytes.rst new file mode 100644 index 00000000000..d200b09f113 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nbytes.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.nbytes +======================= + +.. py:method:: mindspore.Tensor.nbytes + :property: + + 返回Tensor占用的总字节数。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ndim.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ndim.rst new file mode 100644 index 00000000000..48f64415a06 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ndim.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.ndim +===================== + +.. py:method:: mindspore.Tensor.ndim + :property: + + 返回Tensor维度的数量。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nonzero.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nonzero.rst new file mode 100644 index 00000000000..8288fb79700 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.nonzero.rst @@ -0,0 +1,9 @@ +mindspore.Tensor.nonzero +======================== + +.. py:method:: mindspore.Tensor.nonzero() + + 计算x中非零元素的下标。 + + 返回： + Tensor，维度为2，类型为int64，表示输入中所有非零元素的下标。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.norm.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.norm.rst new file mode 100644 index 00000000000..5f55c1caf05 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.norm.rst @@ -0,0 +1,28 @@ +mindspore.Tensor.norm +===================== + +.. py:method:: mindspore.Tensor.norm(axis, p=2, keep_dims=False, epsilon=1e-12) + + 返回给定Tensor的矩阵范数或向量范数。 + + .. math:: + output = sum(abs(input)**p)**(1/p) + + 参数： + - **axis** (Union[int, list, tuple]) - 指定要计算范数的输入维度。 + - **p** (int) - 范数的值。默认值：2。 `p` 大于等于0。 + - **keep_dims** (bool) - 输出Tensor是否保留原有的维度。默认值：False。 + - **epsilon** (float) - 用于保持数据稳定性的常量。默认值：1e-12。 + + 返回： + Tensor，其数据类型与当前Tensor相同，其维度信息取决于 `axis` 轴以及参数 `keep_dims` 。例如如果输入的大小为 `(2,3,4)` 轴为 `[0,1]` ，输出的维度为 `(4，)` 。 + + 异常： + - **TypeError** - 当前Tensor的数据类型不是float16或者float32。 + - **TypeError** - `axis` 不是int，tuple或者list。 + - **TypeError** - `p` 不是int。 + - **TypeError** - `axis` 是tuple或者list但其元素不是int。 + - **TypeError** - `keep_dims` 不是bool。 + - **TypeError** - `epsilon` 不是float。 + - **ValueError** - `axis` 的元素超出范围 `[-len(input_x.shape, len(input_x.shape)]` ，其中 `input_x` 指当前Tensor。 + - **ValueError** - `axis` 的维度rank大于当前Tensor的维度rank。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.pow.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.pow.rst new file mode 100644 index 00000000000..cf2a66a9ed2 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.pow.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.pow +==================== + +.. py:method:: mindspore.Tensor.pow(power) + + 计算Tensor中每个元素的 `power` 次幂。 + + .. math:: + + out_{i} = x_{i} ^{ y_{i}} + + .. note:: + - Tensor和 `power` 遵循 `隐式类型转换规则 `_ ，使数据类型保持一致。 + - 当前的Tensor和 `power` 的数据类型不能同时是bool，并保证其shape可以广播。 + + 参数： + - **power** (Union[Tensor, number.Number, bool]) - 幂值，是一个number.Number或bool值，或数据类型为number或bool_的Tensor。 + + 返回： + Tensor，shape与广播后的shape相同，数据类型为 `Tensor` 与 `power` 中精度较高的类型。 + + 异常： + - **TypeError** - `power` 不是Tensor、number.Number或bool。 + - **ValueError** - 当Tensor和 `power` 都为Tensor时，它们的shape不相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.prod.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.prod.rst new file mode 100644 index 00000000000..825dd11f8e1 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.prod.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.prod +===================== + +.. py:method:: mindspore.Tensor.prod(axis=(), keep_dims=False) + + 默认情况下，通过将维度中的所有元素相乘来减少张量的维度。并且还可以沿轴减小"x"的维度。通过控制 `keep_dims` 判断输出和输入的维度是否相同。 + + 参数： + - **axis** (Union[None, int, tuple(int), list(int)]) - 计算prod的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int、tuple(int)或list(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 + - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 + + 返回： + 与输入的张量具有相同的数据类型的Tensor。 + + 异常： + - **TypeError** - 如果 `axis` 不是以下数据类型之一：int、tuple 或 list。 + - **TypeError** - 如果 `x` 不是Tensor类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ptp.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ptp.rst new file mode 100644 index 00000000000..ebf974ba27f --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ptp.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.ptp +==================== + +.. py:method:: mindspore.Tensor.ptp(axis=None, keepdims=False) + + 该函数名称是"peak to peak"的缩写。计算沿着axis的最大值与最小值的差值。 + + .. note:: + 不支持NumPy参数 `dtype` 和 `out` 。 + + 参数： + - **axis** (Union[None, int, tuple(int)]) - 轴，在轴方向上可以计算范围。默认计算扁平数组的方差。默认值：None。 + - **keepdims** (bool) - 如果设为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果将针对输入数组正确传递。默认值为False。 + + 返回： + Tensor。 + + 异常： + - **TypeError** - `self` 不是Tensor，或者 `axis` 和 `keepdims` 具有前面未指定的类型。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.random_categorical.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.random_categorical.rst new file mode 100644 index 00000000000..ddb738eb2ba --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.random_categorical.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.random_categorical +=================================== + +.. py:method:: mindspore.Tensor.random_categorical(num_sample, seed=0, dtype=mstype.int64) + + 从分类分布中抽取样本。 + + 参数： + - **num_sample** (int): 要抽取的样本数。只允许使用常量值。 + - **seed** (int): 随机种子。只允许使用常量值。默认值：0。 + - **dtype** (mindspore.dtype): 输出的类型。它的值必须是 mindspore.int16、mindspore.int32 和 mindspore.int64 之一。默认值：mindspore.int64。 + + 返回： + Tensor，Shape为 :math:`(batch_size, num_samples)` 的输出Tensor。 + + 异常： + - **TypeError** - 如果 `dtype` 不是以下之一：mindspore.int16、mindspore.int32、mindspore.int64。 + - **TypeError** - 如果 `logits` 不是Tensor。 + - **TypeError** - 如果 `num_sample` 或者 `seed` 不是 int。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ravel.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ravel.rst new file mode 100644 index 00000000000..7d8d41c0183 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.ravel.rst @@ -0,0 +1,9 @@ +mindspore.Tensor.ravel +====================== + +.. py:method:: mindspore.Tensor.ravel() + + 返回一个展开的一维Tensor。 + + 返回： + 一维Tensor，含有与输入相同的元素。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.renorm.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.renorm.rst new file mode 100644 index 00000000000..ede23d0d10c --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.renorm.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.renorm +======================= + +.. py:method:: mindspore.Tensor.renorm(p, dim, maxnorm) + + 沿维度 `dim` 重新规范Tensor的子张量，并且每个子张量的p范数不超过给定的最大范数 `maxnorm` 。 如果子张量的p范数小于 `maxnorm` ，则当前子张量不需要修改；否则该子张量需要修改为对应位置的原值除以该子张量的p范数，然后再乘上 `maxnorm` 。 + + 参数： + - **p** (int) - 范数计算的幂。 + - **dim** (int) - 获得子张量的维度。 + - **maxnorm** (float32) - 给定的最大范数。 + + 返回： + Tensor，shape和type与输入Tensor一致。 + + 异常： + - **TypeError** - `p` 不是int类型。 + - **TypeError** - `dim` 不是int类型。 + - **TypeError** - `maxnorm` 不是float32类型。 + - **ValueError** - `p` 小于等于0。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.repeat.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.repeat.rst new file mode 100644 index 00000000000..6deb4f415ca --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.repeat.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.repeat +======================= + +.. py:method:: mindspore.Tensor.repeat(repeats, axis=None) + + 对数组中的元素进行重复复制。 + + 参数： + - **repeats** (Union[int, tuple, list]) - 每个元素的重复次数，`repeats` 被广播以适应指定轴的shape。 + - **axis** (int, optional) - 轴方向上的重复值。默认情况下，使用展开的输入Tensor，并返回一个展开的输出Tensor。 + + 返回： + Tensor，除了维度外，与输入Tensor具有相同的shape。 + + 异常： + - **ValueError** - 维度超出范围。 + - **TypeError** - 参数类型不匹配。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.reshape.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.reshape.rst new file mode 100644 index 00000000000..9cfaef5a453 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.reshape.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.reshape +======================== + +.. py:method:: mindspore.Tensor.reshape(*shape) + + 不改变数据的情况下，将Tensor的shape改为输入的新shape。 + + 参数： + - **shape** (Union[int, tuple(int), list(int)]) - 新的shape应与原来的shape兼容。如果参数值为整数，则结果是该长度的一维数组。shape的维度可以为-1。在这种情况下，将根据数组的长度和剩下的维度计算出该值。 + + 返回： + Tensor，具有新shape的Tensor。 + + 异常： + - **TypeError** - 新shape不是整数、列表或元组。 + - **ValueError** - 新shape与原来Tensor的shape不兼容。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.resize.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.resize.rst new file mode 100644 index 00000000000..7690fad295d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.resize.rst @@ -0,0 +1,15 @@ +mindspore.Tensor.resize +======================= + +.. py:method:: mindspore.Tensor.resize(*new_shape) + + 将Tensor改为输入的新shape，并将不足的元素补0。 + + .. note:: + 此方法不更改输入数组的大小，也不返回NumPy中的任何内容，而是返回一个具有输入大小的新Tensor。不支持Numpy参数 `refcheck` 。 + + 参数： + - **new_shape** (Union[ints, tuple of ints]) - 指定Tensor的新shape。 + + 返回： + Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.round.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.round.rst new file mode 100644 index 00000000000..df34f5016a8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.round.rst @@ -0,0 +1,9 @@ +mindspore.Tensor.round +====================== + +.. py:method:: mindspore.Tensor.round() + + 将Tensor进行四舍五入到最接近的整数数值。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_add.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_add.rst new file mode 100644 index 00000000000..6eda87a110c --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_add.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.scatter_add +============================ + +.. py:method:: mindspore.Tensor.scatter_add(indices, updates) + + 根据指定的更新值和输入索引，通过加法进行运算，将结果赋值到输出Tensor中。当同一索引有不同值时，更新的结果将是所有值的总和。此操作几乎等同于使用 :class:`mindspore.ops.ScatterNdAdd` ，只是更新后的结果是通过算子output返回，而不是直接原地更新input。 + + `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。`updates` 的shape应该等于 `input_x[indices]` 的shape，其中 `input_x` 指当前Tensor。有关更多详细信息，请参见使用用例。 + + .. note:: + GPU平台上，如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误；CPU平台上直接抛出索引错误；Ascend平台不支持越界检查，若越界可能会造成未知错误。 + + 参数： + - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 + - **updates** (Tensor) - 指定与本Tensor相加操作的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_div.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_div.rst new file mode 100644 index 00000000000..72c4c8f0d61 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_div.rst @@ -0,0 +1,23 @@ +mindspore.Tensor.scatter_div +============================ + +.. py:method:: mindspore.Tensor.scatter_div(indices, updates) + + 根据索引，通过相除运算得到输出Tensor的值。更新后的结果是通过算子output返回，而不是直接原地更新当前Tensor。 + + `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。其中 `input_x` 指当前Tensor。 有关更多详细信息，请参见使用用例。 + + .. note:: + - 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新为当前Tensor，而不是抛出索引错误。 + - 算子无法处理除0异常, 用户需保证 `updates` 中没有0值。 + + 参数： + - **indices** (Tensor) - 该Tensor的索引，数据类型为int32或int64。其rank至少为2。 + - **updates** (Tensor) - 指定与当前Tensor相加操作的Tensor，其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]` ，其中 `input_x` 指当前Tensor。 + + 返回： + Tensor，shape和数据类型与该Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_max.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_max.rst new file mode 100644 index 00000000000..382a7db1110 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_max.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.scatter_max +============================ + +.. py:method:: mindspore.Tensor.scatter_max(indices, updates) + + 根据指定的更新值和输入索引，通过最大值运算，输出结果以Tensor形式返回。 + + 索引的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。有关更多详细信息，请参见下方样例。 + + .. note:: + 如果 `indices` 的某些值超出范围，则不会更新相应的 `updates`，同时也不会抛出索引错误。 + + 参数： + - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64的。其rank必须至少为2。 + - **updates** (Tensor) - 指定与本Tensor做最大值运算的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]`。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_min.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_min.rst new file mode 100644 index 00000000000..829b9c88e0a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_min.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.scatter_min +============================ + +.. py:method:: mindspore.Tensor.scatter_min(indices, updates) + + 根据指定的更新值和输入索引，通过最小值运算，将结果赋值到输出Tensor中。 + + 索引的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。有关更多详细信息，请参见下方样例。 + + .. note:: + 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误。 + + 参数： + - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 + - **updates** (Tensor) - 指定与本Tensor做最小值运算的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_mul.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_mul.rst new file mode 100644 index 00000000000..d523daa31e6 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_mul.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.scatter_mul +============================ + +.. py:method:: mindspore.Tensor.scatter_mul(indices, updates) + + 根据指定的索引，通过乘法进行计算，将结果赋值到输出Tensor中。更新后的结果是通过算子output返回，而不是直接原地更新当前Tensor。 + + `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。其中 `input_x` 指当前Tensor。 有关更多详细信息，请参见使用用例。 + + .. note:: + - 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新为当前Tensor，而不是抛出索引错误。 + + 参数： + - **indices** (Tensor) - 该Tensor的索引，数据类型为int32或int64的。其rank必须至少为2。 + - **updates** (Tensor) - 指定与当前Tensor相加操作的Tensor，其数据类型与输入相同。updates.shape应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`， 其中 `input_x` 代指当前Tensor本身。 + + 返回： + Tensor，shape和数据类型与该Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_sub.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_sub.rst new file mode 100644 index 00000000000..a6ae3c8ead4 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.scatter_sub.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.scatter_sub +============================ + +.. py:method:: mindspore.Tensor.scatter_sub(indices, updates) + + 根据指定的更新值和输入索引，通过减法进行运算，将结果赋值到输出Tensor中。当同一索引有不同值时，更新的结果将分别减去这些值。此操作几乎等同于使用 :class:`mindspore.ops.ScatterNdSub` ，只是更新后的结果是通过算子output返回，而不是直接原地更新input。 + + `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。`updates` 的shape应该等于 `input_x[indices]` 的shape，其中 `input_x` 指当前Tensor。有关更多详细信息，请参见使用用例。 + + .. note:: + GPU平台上，如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误；CPU平台上直接抛出索引错误；Ascend平台不支持越界检查，若越界可能会造成未知错误。 + + 参数： + - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 + - **updates** (Tensor) - 指定与本Tensor相减操作的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.searchsorted.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.searchsorted.rst new file mode 100644 index 00000000000..903af8586ab --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.searchsorted.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.searchsorted +============================= + +.. py:method:: mindspore.Tensor.searchsorted(v, side='left', sorter=None) + + 查找应插入元素以保存顺序的位置索引。 + + 参数： + - **v** (Union[int, float, bool, list, tuple, Tensor]) - 要插入元素的值。 + - **side** ('left', 'right', optional) - 如果参数值为'left'，则给出找到的第一个合适位置的索引。如果参数值为'right'，则返回最后一个这样的索引。如果没有合适的索引，则返回0或N（其中N是Tensor的长度）。默认值：'left'。 + - **sorter** (Union[int, float, bool, list, tuple, Tensor]) - 整数索引的可选一维数组，将Tensor按升序排序。它们通常是NumPy argsort方法的结果。默认值：None。 + + 返回： + Tensor，shape与 `v` 相同的插入点数组。 + + 异常： + - **ValueError** - `side` 或 `sorter` 的参数无效。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.select.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.select.rst new file mode 100644 index 00000000000..80c499e887d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.select.rst @@ -0,0 +1,26 @@ +mindspore.Tensor.select +======================= + +.. py:method:: mindspore.Tensor.select(condition, y) + + 根据条件判断Tensor中的元素的值，来决定输出中的相应元素是从当前Tensor（如果元素值为True）还是从 `y` （如果元素值为False）中选择。 + + 该算法可以被定义为： + + .. math:: + + out_i = \begin{cases} + tensor_i, & \text{if } condition_i \\ + y_i, & \text{otherwise} + \end{cases} + + 参数： + - **condition** (Tensor[bool]) - 条件Tensor，决定选择哪一个元素。shape与当前的Tensor相同。 + - **y** (Union[Tensor, int, float]) - 如果y是一个Tensor，那么shape与当前Tensor相同。如果y是int或者float，那么将会被转化为int32或者float32类型，并且被广播为与当前Tensor相同的shape。 + + 返回： + Tensor，与当前Tensor的shape相同。 + + 异常： + - **TypeError** - `y` 不是Tensor、int或者float。 + - **ValueError** - 输入的shape不相同。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.shape.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.shape.rst new file mode 100644 index 00000000000..9c6d972a2ac --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.shape.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.shape +====================== + +.. py:method:: mindspore.Tensor.shape + :property: + + 返回Tensor的shape。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.size.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.size.rst new file mode 100644 index 00000000000..171e5587c6a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.size.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.size +===================== + +.. py:method:: mindspore.Tensor.size + :property: + + 返回Tensor中的元素总数。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.soft_shrink.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.soft_shrink.rst new file mode 100644 index 00000000000..1f51df41e09 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.soft_shrink.rst @@ -0,0 +1,26 @@ +mindspore.Tensor.soft_shrink +============================ + +.. py:method:: mindspore.Tensor.soft_shrink(lambd=0.5) + + Soft Shrink激活函数，按输入元素计算输出，公式定义如下： + + .. math:: + \text{SoftShrink}(x) = + \begin{cases} + x - \lambda, & \text{ if } x > \lambda \\ + x + \lambda, & \text{ if } x < -\lambda \\ + 0, & \text{ otherwise } + \end{cases} + + 参数： + - **lambd** (float) - :math:`\lambda` 应大于等于0。默认值：0.5。 + + 返回： + Tensor，shape和数据类型与输入相同。 + + 异常： + - **TypeError** - `lambd` 不是float。 + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - 原始Tensor的dtype既不是float16也不是float32。 + - **ValueError** - `lambd` 小于0。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.split.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.split.rst new file mode 100644 index 00000000000..4edcb01a61a --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.split.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.split +====================== + +.. py:method:: mindspore.Tensor.split(axis=0, output_num=1) + + 根据指定的轴和分割数量对Tensor进行分割。 + + Tensor将被分割为相同shape的子Tensor，且要求 `self.shape(axis)` 可被 `output_num` 整除。 + + 参数： + - **axis** (int) - 指定分割轴。默认值：0。 + - **output_num** (int) - 指定分割数量。其值为正整数。默认值：1。 + + 返回： + tuple[Tensor]，每个输出Tensor的shape相同，即 :math:`(y_1, y_2, ..., y_S)` 。数据类型与Tensor相同。 + + 异常： + - **TypeError** - `axis` 或 `output_num` 不是int。 + - **ValueError** - `axis` 超出[-len(`self.shape`), len(`self.shape`))范围。或 `output_num` 小于或等于0。 + - **ValueError** - `self.shape(axis)` 不可被 `output_num` 整除。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.squeeze.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.squeeze.rst new file mode 100644 index 00000000000..0e16c0d7ee2 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.squeeze.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.squeeze +======================== + +.. py:method:: mindspore.Tensor.squeeze(axis=None) + + 从Tensor中删除shape为1的维度。 + + 参数： + - **axis** (Union[None, int, list(int), tuple(int)], optional) - 选择shape中长度为1的条目的子集。如果选择shape条目长度大于1的轴，则报错。默认值为None。 + + 返回： + Tensor，删除了长度为1的维度的全部子集或一个子集。 + + 异常： + - **TypeError** - 输入的参数类型有误。 + - **ValueError** - 指定维度的shape大于1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.std.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.std.rst new file mode 100644 index 00000000000..4e2b71a0c87 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.std.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.std +==================== + +.. py:method:: mindspore.Tensor.std(axis=None, ddof=0, keepdims=False) + + 计算指定维度的标准差。 + 标准差是方差的算术平方根，如：:math:`std = sqrt(mean(abs(x - x.mean())**2))` 。 + + 返回标准差。默认情况下计算展开数组的标准差，否则在指定维度上计算。 + + .. note:: + 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 + + 参数： + - **axis** (Union[None, int, tuple(int)]) - 在该维度上计算标准差。默认值：`None` 。如果为 `None` ，则计算展开数组的标准偏差。 + - **ddof** (int) - δ自由度。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。默认值：0。 + - **keepdims** - 默认值：`False`。 + + 返回： + 含有标准差数值的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.strides.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.strides.rst new file mode 100644 index 00000000000..35f290059d6 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.strides.rst @@ -0,0 +1,7 @@ +mindspore.Tensor.strides +======================== + +.. py:method:: mindspore.Tensor.strides + :property: + + Tensor上每个维度跨度的字节元组。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.sum.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.sum.rst new file mode 100644 index 00000000000..d8e50007f28 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.sum.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.sum +==================== + +.. py:method:: mindspore.Tensor.sum(axis=None, dtype=None, keepdims=False, initial=None) + + 返回指定维度上数组元素的总和。 + + .. note:: + 不支持NumPy参数 `out` 、 `where` 、 `casting` 、 `order` 、 `subok` 、 `signature` 和 `extobj` 。 + + 参数： + - **axis** (Union[None, int, tuple(int)]) - 指定维度，在该维度方向上进行求和运算。默认值：None。如果参数值为None，会计算输入数组中所有元素的和。如果axis为负数，则从最后一维开始往第一维计算。如果axis为整数元组，会对该元组指定的所有轴方向上的元素进行求和。 + - **dtype** (`mindspore.dtype`, optional) - 默认值为None。会覆盖输出Tensor的dtype。 + - **keepdims** (bool) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。如果设为默认值，那么 `keepdims` 不会被传递给ndarray子类的sum方法。但是任何非默认值都会被传递。如果子类的方法未实现 `keepdims` ，则引发异常。默认值：False。 + - **initial** (scalar) - 初始化的起始值。默认值：None。 + + 返回： + Tensor。具有与输入相同shape的Tensor，删除了指定的轴。如果输入Tensor是0维数组，或axis为None时，返回一个标量。 + + 异常： + - **TypeError** - input不是Tensor，`axis` 不是整数或整数元组，`keepdims` 不是整数，或者 `initial` 不是标量。 + - **ValueError** - 任意轴超出范围或存在重复的轴。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.svd.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.svd.rst new file mode 100644 index 00000000000..27fb7a94ae8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.svd.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.svd +==================== + +.. py:method:: mindspore.Tensor.svd(full_matrices=False, compute_uv=True) + + 更多参考详见 :func:`mindspore.ops.svd`。 + + 参数： + - **full_matrices** (bool, optional) - 如果这个参数为True，则计算完整的 :math:`U` 和 :math:`V` 。否则 :math:`U` 和 :math:`V` 的shape和P有关，P是M和N的较小值, M和N是输入矩阵的行和列。默认值：False。 + - **compute_uv** (bool, optional) - 如果这个参数为True，则计算 :math:`U` 和 :math:`V` ，否则只计算 :math:`S` 。默认值：True。 + + 返回： + - **s** (Tensor) - 奇异值。shape为 :math:`(*, P)`。 + - **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。 + - **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。 + + 异常： + - **TypeError** - `full_matrices` 或 `compute_uv` 不是bool类型。 + - **TypeError** - 输入的rank小于2。 + - **TypeError** - 输入的数据类型不为float32或float64。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.swapaxes.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.swapaxes.rst new file mode 100644 index 00000000000..d14bf35e5d3 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.swapaxes.rst @@ -0,0 +1,17 @@ +mindspore.Tensor.swapaxes +========================= + +.. py:method:: mindspore.Tensor.swapaxes(axis1, axis2) + + 交换Tensor的两个维度。 + + 参数： + - **axis1** (int) - 第一个维度。 + - **axis2** (int) - 第二个维度。 + + 返回： + 转化后的Tensor，与输入具有相同的数据类型。 + + 异常： + - **TypeError** - `axis1` 或 `axis2` 不是整数。 + - **ValueError** - `axis1` 或 `axis2` 不在 `[-ndim, ndim-1]` 范围内。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.take.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.take.rst new file mode 100644 index 00000000000..5c2aebf6d4d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.take.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.take +===================== + +.. py:method:: mindspore.Tensor.take(indices, axis=None, mode='clip') + + 在指定维度上获取Tensor中的元素。 + + 参数： + - **indices** (Tensor) - 待提取的值的shape为 `(Nj...)` 的索引。 + - **axis** (int, optional) - 在指定维度上选择值。默认情况下，使用展开的输入数组。默认值：None。 + - **mode** ('raise', 'wrap', 'clip', optional) + + - raise：抛出错误。 + - wrap：绕接。 + - clip：裁剪到范围。 `clip` 模式意味着所有过大的索引都会被在指定轴方向上指向最后一个元素的索引替换。注：这将禁用具有负数的索引。默认值：`clip` 。 + + 返回： + Tensor，索引的结果。 + + 异常： + - **ValueError** - `axis` 超出范围，或 `mode` 被设置为'raise'、'wrap'和'clip'以外的值。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.tan.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.tan.rst new file mode 100644 index 00000000000..4525aecefb7 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.tan.rst @@ -0,0 +1,16 @@ +mindspore.Tensor.tan +==================== + +.. py:method:: mindspore.Tensor.tan() + + 返回每个元素的正切值。 + + .. math:: + + out_i = tan(x_i) + + 返回： + Tensor。 + + 异常： + - **TypeError** - 当前输入不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_coo.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_coo.rst new file mode 100644 index 00000000000..3305f6db1d9 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_coo.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.to_coo +======================= + +.. py:method:: mindspore.Tensor.to_coo() + + 将常规Tensor转为稀疏化的COOTensor。 + + .. note:: + 现在只支持2维Tensor。 + + 返回： + 返回一个2维的COOTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： + + - **indices** (Tensor) - 二维整数张量，表示稀疏张量中 `values` 所处的位置索引。 + - **values** (Tensor) - 一维张量，用来给 `indices` 中的每个元素提供数值。 + - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 + + 异常： + - **ValueError** - Tensor的shape不是2维。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_csr.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_csr.rst new file mode 100644 index 00000000000..21b8b951932 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_csr.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.to_csr +======================= + +.. py:method:: mindspore.Tensor.to_csr() + + 将常规Tensor转为稀疏化的CSRTensor。 + + .. note:: + 现在只支持2维Tensor。 + + 返回： + 返回一个2维的CSRTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： + + - **indptr** (Tensor) - 一维整数张量，表示每行非零元素的在 `values` 中存储的起止位置。 + - **indices** (Tensor) - 一维整数张量，表示每个元素的列索引值。 + - **values** (Tensor) - 一维张量，用来表示索引对应的数值。 + - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 + + 异常： + - **ValueError** - Tensor的shape不是2维。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_tensor.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_tensor.rst new file mode 100644 index 00000000000..4f4c1217bbc --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.to_tensor.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.to_tensor +========================== + +.. py:method:: mindspore.Tensor.to_tensor(slice_index=None, shape=None, opt_shard_group=None) + + 返回init_data()的结果，并获取此Tensor的数据。 + + .. note:: + 不建议使用 `to_tensor` 。请使用 `init_data` 。 + + 参数： + - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 + - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 + - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数切片的分片。默认值：None。 + + 返回： + Tensor，shape和数据类型与原Tensor相同。 + + 异常： + - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 + - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.top_k.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.top_k.rst new file mode 100644 index 00000000000..5a03c1e2484 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.top_k.rst @@ -0,0 +1,34 @@ +mindspore.Tensor.top_k +====================== + +.. py:method:: mindspore.Tensor.top_k(k, sorted=True) + + 沿最后一个维度查找 `k` 个最大元素和对应的索引。 + + .. warning:: + - 如果 `sorted` 设置为'False'，它将使用aicpu运算符，性能可能会降低。 + + `x` 指的当前 Tensor。 + + 如果 `input_x` 是一维Tensor，则查找Tensor中 `k` 个最大元素，并将其值和索引输出为Tensor。因此， `values[k]` 是 `input_x` 中 `k` 个最大元素，其索引是 `indices[k]` 。 + + 对于多维矩阵，计算每行中最大的 `k` 个元素（沿最后一个维度的相应向量），因此： + + .. math:: + values.shape = indices.shape = input\_x.shape[:-1] + [k]. + + 如果两个比较的元素相同，则优先返回索引值较小的元素。 + + 参数： + - **k** (int) - 指定计算最大元素的数量，需要是常量。 + - **sorted** (bool, optional) - 如果为True，则获取的元素将按值降序排序。默认值：True。 + + 返回： + 2个Tensor组成的tuple， `values` 和 `indices` 。 + + - **values** (Tensor) - 最后一个维度的每个切片中的 `k` 最大元素。 + - **indices** (Tensor) - `k` 最大元素的对应索引。 + + 异常： + - **TypeError** - 如果 `k` 不是int。 + - **TypeError** - 如果 `sorted` 不是bool。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.trace.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.trace.rst new file mode 100644 index 00000000000..2958f7e7ea8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.trace.rst @@ -0,0 +1,18 @@ +mindspore.Tensor.trace +====================== + +.. py:method:: mindspore.Tensor.trace(offset=0, axis1=0, axis2=1, dtype=None) + + 在Tensor的对角线方向上的总和。 + + 参数： + - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 + - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 + - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 + - **dtype** (`mindspore.dtype` , optional) - 默认值为None。覆盖输出Tensor的dtype。 + + 返回： + Tensor，对角线方向上的总和。 + + 异常： + **ValueError** - 输入Tensor的维度少于2。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.transpose.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.transpose.rst new file mode 100644 index 00000000000..049cd67012e --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.transpose.rst @@ -0,0 +1,22 @@ +mindspore.Tensor.transpose +========================== + +.. py:method:: mindspore.Tensor.transpose(*axes) + + 返回被转置后的Tensor。 + + - 对于一维Tensor，这没有影响，因为转置后的向量是相同的。 + - 对于二维Tensor，是标准的矩阵转置。 + - 对于n维Tensor，如果提供了维度，则它们的顺序代表维度的置换方式。 + + 如果未提供轴，且Tensor.shape等于(i[0], i[1],...i[n-2], i[n-1])，则Tensor.transpose().shape等于(i[n-1], i[n-2], ... i[1], i[0])。 + + 参数： + - **axes** (Union[None, tuple(int), list(int), int], optional) - 如果 `axes` 为None或未设置，则该方法将反转维度。如果 `axes` 为tuple(int)或list(int)，则Tensor.transpose()把Tensor转置为新的维度。如果 `axes` 为整数，则此表单仅作为元组/列表表单的备选。 + + 返回： + Tensor，具有与输入Tensor相同的维度，其中维度被准确的排列。 + + 异常： + - **TypeError** - 输入参数类型有误。 + - **ValueError** - `axes` 的数量不等于Tensor.ndim。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_consecutive.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_consecutive.rst new file mode 100644 index 00000000000..006664ab8ed --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_consecutive.rst @@ -0,0 +1,19 @@ +mindspore.Tensor.unique_consecutive +=================================== + +.. py:method:: mindspore.Tensor.unique_consecutive(return_idx=False, return_counts=False, axis=None) + + 返回输入张量中每个连续等效元素组中唯一的元素。 + + 参数： + - **return_idx** (bool, optional) - 是否返回原始输入中，各元素在返回的唯一列表中的结束位置的索引。默认值：False。 + - **return_counts** (bool, optional) - 是否返回每个唯一元素的计数。默认值：False。 + - **axis** (int, optional) - 维度。如果为None，对输入进行展平操作，返回其唯一性。如果指定，必须是int32或int64类型。默认值：None。 + + 返回： + Tensor或包含Tensor对象的元组（ `output` 、 `idx` 、 `counts` ）。 `output` 与输入张量具有相同的类型，用于表示唯一标量元素的输出列表。 + 如果 `return_idx` 为 True，则会有一个额外的返回张量 `idx`，它的形状与输入张量相同，表示原始输入中的元素映射到输出中的位置的索引。如果 + `return_idx` 为 True，则会有一个额外的返回张量 `counts`，表示每个唯一值或张量的出现次数。 + + 异常： + - **RuntimeError** - `axis` 不在 `[-ndim, ndim-1]` 范围内。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_with_pad.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_with_pad.rst new file mode 100644 index 00000000000..e69bc6ba9e8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unique_with_pad.rst @@ -0,0 +1,20 @@ +mindspore.Tensor.unique_with_pad +================================ + +.. py:method:: mindspore.Tensor.unique_with_pad(pad_num) + + 对当前一维张量中元素去重，返回一维张量中的唯一元素（使用pad_num填充）和相对索引。 + + 基本操作与unique相同，但unique_with_pad多了pad操作。 + unique运算符对张量处理后所返回的元组（ `y` ， `idx` ）， `y` 与 `idx` 的shape通常会有差别，因此，为了解决上述情况， + unique_with_pad操作符将用用户指定的 `pad_num` 填充 `y` 张量，使其具有与张量 `idx` 相同的形状。 + + 参数： + - **pad_num** (int) - 填充值。数据类型为int32或int64。 + + 返回： + Tuple， `(y, idx)` 。 `y` 是与当前张量形状和数据类型相同的Tensor，包含当前张量中去重后的元素，并用 `pad_num` 填充。 `idx` 为索引Tensor，包含当前张量中的元素在 `y` 中的索引，与当前张量的shape相同。 + + 异常： + - **TypeError** - 当前张量的数据类型既不是int32也不是int64。 + - **ValueError** - 当前张量不是一维张量。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_max.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_max.rst new file mode 100644 index 00000000000..ff08fb7a899 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_max.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.unsorted_segment_max +===================================== + +.. py:method:: mindspore.Tensor.unsorted_segment_max(segment_ids, num_segments) + + 沿分段计算输入Tensor的最大值。 + + .. note:: + - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用 `x` 的数据类型的最小值填充输出 `output[i]` 。 + - `segment_ids` 必须是一个非负Tensor。 + + 参数： + - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 + - **num_segments** (int) - 分段的数量。 + + 返回： + Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 + + 异常： + - **TypeError** - `num_segments` 不是int类型。 + - **ValueError** - `segment_ids` 的维度不等于1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_min.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_min.rst new file mode 100644 index 00000000000..c9dca0342fb --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_min.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.unsorted_segment_min +===================================== + +.. py:method:: mindspore.Tensor.unsorted_segment_min(segment_ids, num_segments) + + 沿分段计算输入Tensor的最小值。 + + .. note:: + - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用 `x` 的数据类型的最大值填充输出 `output[i]` 。 + - `segment_ids` 必须是一个非负Tensor。 + + 参数： + - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 + - **num_segments** (int) - 分段的数量。 + + 返回： + Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 + + 异常： + - **TypeError** - `num_segments` 不是int类型。 + - **ValueError** - `segment_ids` 的维度不等于1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_prod.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_prod.rst new file mode 100644 index 00000000000..9cd2bd503d3 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.unsorted_segment_prod.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.unsorted_segment_prod +====================================== + +.. py:method:: mindspore.Tensor.unsorted_segment_prod(segment_ids, num_segments) + + 沿分段计算输入Tensor元素的乘积。 + + .. note:: + - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用1填充输出 `output[i]` 。 + - `segment_ids` 必须是一个非负Tensor。 + + 参数： + - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 + - **num_segments** (int) - 分段的数量。 + + 返回： + Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 + + 异常： + - **TypeError** - `num_segments` 不是int类型。 + - **ValueError** - `segment_ids` 的维度不等于1。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.var.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.var.rst new file mode 100644 index 00000000000..5cf5f14e9f8 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.var.rst @@ -0,0 +1,21 @@ +mindspore.Tensor.var +==================== + +.. py:method:: mindspore.Tensor.var(axis=None, ddof=0, keepdims=False) + + 在指定维度上的方差。 + + 方差是平均值的平方偏差的平均值，即：:math:`var = mean(abs(x - x.mean())**2)` 。 + + 返回方差值。默认情况下计算展开Tensor的方差，否则在指定维度上计算。 + + .. note:: + 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 + + 参数： + - **axis** (Union[None, int, tuple(int)]) - 维度，在指定维度上计算方差。其默认值是展开Tensor的方差。默认值：None。 + - **ddof** (int) - δ自由度。默认值：0。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。 + - **keepdims** (bool) - 默认值：False。 + + 返回： + 含有方差值的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.view.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.view.rst new file mode 100644 index 00000000000..609157c6d0d --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.view.rst @@ -0,0 +1,12 @@ +mindspore.Tensor.view +===================== + +.. py:method:: mindspore.Tensor.view(*shape) + + 根据输入shape重新创建一个Tensor，与原Tensor数据相同。该方法与reshape方法相同，都是依靠底层reshape算子实现的。 + + 参数： + - **shape** (Union[tuple(int), int]) - 输出Tensor的维度。 + + 返回： + Tensor，具有与入参 `shape` 相同的维度。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xdivy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xdivy.rst new file mode 100644 index 00000000000..e35edcea13c --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xdivy.rst @@ -0,0 +1,24 @@ +mindspore.Tensor.xdivy +====================== + +.. py:method:: mindspore.Tensor.xdivy(y) + + 计算原Tensor除以输入的Tensor。当原Tensor为零时，则返回零。原Tensor的数据类型需要是float，complex或bool。 + 后面为了使表达清晰，使用 `x` 代替原Tensor。 + + .. math:: + out_i = x_{i}\y_{i} + + `x` 和 `y` 的输入遵循隐式类型转换规则，使数据类型一致。y是一个Tensor或Scalar。当y是Tensor时，x和y的数据类型不能同时是bool的，它们的shape可以广播。当y是Scalar时，只能是一个常量。 + + 参数： + - **y** (Union[Tensor, number.Number, bool]) - float、complex或bool类型的Tensor。`x` 和 `y` 不能同时为bool类型。 + + 返回： + Tensor，shape与广播后的shape相同，数据类型为两个输入中精度较高或数数值较高的类型。 + + 异常： + - **TypeError** - 如果 `y` 不是以下之一：Tensor、Number、bool。 + - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32、float64、complex64、complex128、bool。 + - **ValueError** - 如果 `x` 不能广播至 `y` 的shape。 + - **RuntimeError** - 如果Parameter的 `x` , `y` 需要进行数据类型转换，但是Parameter是不支持数据类型转换。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst new file mode 100644 index 00000000000..e0a8fde9423 --- /dev/null +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst @@ -0,0 +1,25 @@ +mindspore.Tensor.xlogy +====================== + +.. py:method:: mindspore.Tensor.xlogy(y) + + 计算原Tensor乘以输入Tensor的对数。当原Tensor为零时，则返回零。原Tensor的数据类型需要是 + `number `_ 或 + `bool_ `_。 + 后面为了使表达清晰，使用 `x` 代替原Tensor。 + + .. math:: + out_i = x_{i}\ln{y_{i}} + + `x` 和 `y` 的输入遵循隐式类型转换规则，使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时，它们的数据类型不能同时是bool的，它们的shape可以广播。当输入是一个Tensor和一个Scalar时，Scalar只能是一个常量。 + + 参数： + - **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时，则第二个输入是数值型或bool。当第一个输入是Scalar时，则第二个输入必须是数据类型为数值型或bool的Tensor。 + + 返回： + Tensor，shape与广播后的shape相同，数据类型为两个输入中精度较高或数数值较高的类型。 + + 异常： + - **TypeError** - 如果 `x` 和 `y` 不是数值型、bool或Tensor。 + - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32或float64。 + - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.Tensor.rst b/docs/api/api_python/mindspore/mindspore.Tensor.rst index c497803c1a6..ec60ca17fa3 100644 --- a/docs/api/api_python/mindspore/mindspore.Tensor.rst +++ b/docs/api/api_python/mindspore/mindspore.Tensor.rst @@ -5,2102 +5,132 @@ mindspore.Tensor 张量，即存储多维数组（n-dimensional array）的数据结构。 - **参数：** - - - **input_data** (Union[Tensor, float, int, bool, tuple, list, numpy.ndarray]) - 被存储的数据，可以是其它Tensor，也可以是Python基本数据（如int，float，bool等），或是一个NumPy对象。默认值：None。 - - **dtype** (:class:`mindspore.dtype`) - 用于定义该Tensor的数据类型，必须是 *mindspore.dtype* 中定义的类型。如果该参数为None，则数据类型与 `input_data` 一致，默认值：None。 - - **shape** (Union[tuple, list, int]) - 用于定义该Tensor的形状。如果指定了 `input_data` ，则无需设置该参数。默认值：None。 - - **init** (Initializer) - 用于在并行模式中延迟Tensor的数据的初始化，如果指定该参数，则 `dtype` 和 `shape` 也必须被指定。不推荐在非自动并行之外的场景下使用该接口。只有当调用 `Tensor.init_data` 时，才会使用指定的 `init` 来初始化Tensor数据。默认值：None。 - - **internal** (bool) - Tensor是否由框架创建。 如果为True，表示Tensor是由框架创建的，如果为False，表示Tensor是由用户创建的。默认值：False。 - - **输出：** - - Tensor。 - - .. py:method:: T - :property: - - 返回转置后的Tensor。 - - .. py:method:: abs() - - 返回每个元素的绝对值。 - - **返回：** + 参数： + - **input_data** (Union[Tensor, float, int, bool, tuple, list, numpy.ndarray]) - 被存储的数据，可以是其它Tensor，也可以是Python基本数据（如int，float，bool等），或是一个NumPy对象。默认值：None。 + - **dtype** (:class:`mindspore.dtype`) - 用于定义该Tensor的数据类型，必须是 *mindspore.dtype* 中定义的类型。如果该参数为None，则数据类型与 `input_data` 一致，默认值：None。 + - **shape** (Union[tuple, list, int]) - 用于定义该Tensor的形状。如果指定了 `input_data` ，则无需设置该参数。默认值：None。 + - **init** (Initializer) - 用于在并行模式中延迟Tensor的数据的初始化，如果指定该参数，则 `dtype` 和 `shape` 也必须被指定。不推荐在非自动并行之外的场景下使用该接口。只有当调用 `Tensor.init_data` 时，才会使用指定的 `init` 来初始化Tensor数据。默认值：None。 + - **internal** (bool) - Tensor是否由框架创建。 如果为True，表示Tensor是由框架创建的，如果为False，表示Tensor是由用户创建的。默认值：False。 + 输出： Tensor。 - .. py:method:: addcdiv(x1, x2, value) - - 逐元素执行x1除以x2，将结果乘以标量value并将其添加到输入。 - - .. math:: - y[i] = input\_data[i] + value[i] * (x1[i] / x2[i]) - - **参数：** - - - **x1** (Tensor) - 分子张量。 - - **x2** (Tensor) - 分母张量。 - - **value** (Tensor) - x1/x2的倍数。 - - **返回：** - - Tensor，shape和数据类型与当前Tensor相同。 - - .. py:method:: addcmul(x1, x2, value) - - 逐元素执行x1乘以x2，将结果乘以标量value并将其添加到输入。 - - .. math:: - y[i] = input\_data[i] + value[i] * (x1[i] * x2[i]) - - **参数：** - - - **x1** (Tensor) - 要相乘的张量。 - - **x2** (Tensor) - 要相乘的张量。 - - **value** (Tensor) - x1*x2的倍数。 - - **返回：** - - Tensor，shape和数据类型与当前Tensor相同。 - - .. py:method:: all(axis=(), keep_dims=False) - - 检查在指定轴上所有元素是否均为True。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)) - 计算all的维度。 当 `axis` 为None或者空元组的时候，计算所有维度。当 `axis` 为int或tuple(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 - - **keep_dims** (bool) - 计算结果是否保留维度。 默认值： False。 - - **返回：** - - Tensor。如果在指定轴方向上所有数组元素都为True，则其值为True，否则其值为False。如果轴为None或空元组，则默认降维。 - - .. py:method:: any(axis=(), keep_dims=False) - - 检查在指定轴方向上是否存在任意为True的Tensor元素。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)) - 计算any的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int或tuple(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 - - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 - - **返回：** - - Tensor。如果在指定轴方向上所有Tensor元素都为True，则其值为True，否则其值为False。如果轴为None或空元组，则默认降维。 - - .. py:methond:: approximate_equal(y, tolerance=1e-5) - - 逐元素计算abs(x-y)，如果小于tolerance则为True，否则为False。 - - .. math:: - out_i = \begin{cases} - & \text{ if } \left | x_{i} - y_{i} \right | < \text{tolerance},\ \ True \\ - & \text{ if } \left | x_{i} - y_{i} \right | \ge \text{tolerance},\ \ False - \end{cases} - - `x` 为当前Tensor。 - `tolerance` 为相等的两元素间最大偏差。 - `x` 和 `y` 会通过隐式数据类型转换使数据类型保持一致。如果数据类型不同，低精度的数据类型会被自动转换到高精度的数据类型。 - - **参数：** - - - **y** (Tensor) - 输入Tensor，shape与数据类型和当前Tensor相同。 - - **tolerance** (float) - 两元素可被视为相等的最大偏差。默认值：1e-05。 - - **返回：** - - Tensor，shape与当前Tensor相同，bool类型。 - - **异常：** - - - **TypeError** - `tolerance` 不是float类型。 - - **RuntimeError** - `variable` 与 `value` 之间的类型转换不被支持。 - - .. py:method:: arg_min_with_value(axis=0, keep_dims=False) - - 根据指定的索引计算最小值，并返回索引和值。 - - 在给定轴上计算输入Tensor的最小值，并且返回最小值和索引。 - - .. note:: - 在auto_parallel和semi_auto_parallel模式下，不能使用第一个输出索引。 - - .. warning:: - - 如果有多个最小值，则取第一个最小值的索引。 - - `axis` 的取值范围为[-dims, dims - 1]。`dims` 为输入Tensor的维度长度。 - - **参数：** - - - **axis** (int) - 指定计算维度。默认值：0。 - - **keep_dims** (bool) - 表示是否减少维度。如果为True，则输出维度和输入维度相同。如果为False，则减少输出维度。默认值：False。 - - **返回：** - - tuple (Tensor)，表示2个Tensor组成的tuple，包含对应的索引和输入Tensor的最小值。 - - - **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True，则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则，shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。 - - **output_x** (Tensor) - 输入Tensor的最小值，其shape与索引相同。 - - **异常：** - - - **TypeError** - `keep_dims` 不是bool。 - - **TypeError** - `axis` 不是int。 - - .. py:method:: argmax(axis=None) - - 返回指定轴上最大值的索引。 - - **参数：** - - - **axis** (int, optional) - 默认情况下，返回扁平化Tensor的最大值序号，否则返回指定轴方向上。 - - **返回：** - - Tensor，最大值的索引。它与原始Tensor具有相同的shape，但移除了轴方向上的维度。 - - **异常：** - - - **ValueError** - 入参axis的设定值超出了范围。 - - .. py:method:: argmin(axis=None) - - 返回指定轴上最小值的索引。 - - **参数：** - - - **axis** (int, optional) - 返回扁平化Tensor的最小值序号，否则返回指定轴方向上的最小值序号。默认值: None。 - - **返回：** - - Tensor，最小Tensor的索引。它与原始Tensor具有相同的shape，但移除了轴方向上的维度。 - - **异常：** - - - **ValueError** - 入参axis的设定值超出了范围。 - - .. py:method:: asnumpy() - - 将张量转换为NumPy数组。该方法会将Tensor本身转换为NumPy的ndarray。这个Tensor和函数返回的ndarray共享内存地址。对Tensor本身的修改会反映到相应的ndarray上。 - - **返回：** - - NumPy的ndarray，该ndarray与Tensor共享内存地址。 - - .. py:method:: assign_value(value) - - 将另一个Tensor的值赋给当前Tensor。 - - **参数：** - - - **value** (Tensor) - 用于赋值的Tensor。 - - **返回：** - - Tensor，赋值后的Tensor。 - - .. py:method:: astype(dtype, copy=True) - - 将Tensor转为指定数据类型，可指定是否返回副本。 - - **参数：** - - - **dtype** (Union[`mindspore.dtype` , `numpy.dtype` , str]) - 指定的Tensor数据类型，可以是: `mindspore.dtype.float32` , `numpy.float32` 或 `float32` 的格式。默认值：`mindspore.dtype.float32` 。 - - **copy** (bool, optional) - 默认情况下，astype返回新拷贝的Tensor。如果该参数设为False，则返回输入Tensor而不是副本。默认值：True。 - - **返回：** - - Tensor，指定数据类型的Tensor。 - - **异常：** - - - **TypeError** - 指定了无法解析的类型。 - - .. py:method:: atan2(y) - - 逐元素计算x/y的反正切值。 - - `x` 指的当前 Tensor。 - - 返回 :math:`\theta\ \in\ [-\pi, \pi]` ，使得 :math:`x = r*\sin(\theta), y = r*\cos(\theta)` ， 其中 :math:`r = \sqrt{x^2 + y^2}` 。 - 输入 `x` 和 `y` 会通过隐式数据类型转换使数据类型保持一致。如果数据类型不同，低精度的数据类型会被转换到高精度的数据类型。 - - **参数：** - - - **y** (Tensor) - 输入Tensor，shape应能在广播后与 `x` 相同，或 `x` 的shape在广播后与 `y` 相同。 - - **返回：** - - Tensor，与广播后的输入shape相同，和 `x` 数据类型相同。 - - **异常：** - - - **TypeError** - `x` 或 `y` 不是Tensor。 - - **RuntimeError** - `x` 与 `y` 之间的数据类型转换不被支持 - - .. py:method:: bernoulli(p=0.5, seed=-1) - - 以p的概率随机将输出的元素设置为0或1，服从伯努利分布。 - - .. math:: - - out_{i} \sim Bernoulli(p_{i}) - - **参数：** - - - **p** (Union[Tensor, float], 可选) - shape需要可以被广播到当前Tensor。其数据类型为float32或float64。`p` 中每个值代表输出Tensor中对应广播位置为1的概率，数值范围在0到1之间。默认值：0.5。 - - **seed** (int, 可选) - 随机种子，用于生成随机数，数值范围是-1或正整数。默认值：-1，代表取当前时间戳。 - - **返回：** - - Tensor，shape和数据类型与当前Tensor相同。 - - **异常：** - - - **TypeError** - 当前Tensor的数据类型不在int8, uint8, int16, int32，int64，bool, float32和float64中。 - - **TypeError** - `p` 的数据类型既不是float32也不是float64。 - - **TypeError** - `seed` 不是int。 - - **ValueError** - `seed` 是负数且不为-1。 - - **ValueError** - `p` 数值范围不在0到1之间。 - - .. py:method:: bitwise_and(x) - - 逐元素执行两个Tensor的与运算。 - - 更多细节参考 :func:`mindspore.ops.bitwise_and`。 - - **参数：** - - - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 - - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - .. py:method:: bitwise_or(x) - - 逐元素执行两个Tensor的或运算。 - - 更多细节参考 :func:`mindspore.ops.bitwise_or`。 - - **参数：** - - - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 - - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - .. py:method:: bitwise_xor(x) - - 逐元素执行两个Tensor的异或运算。 - - 更多细节参考 :func:`mindspore.ops.bitwise_xor`。 - - **参数：** - - - **x** (Tensor) - 输入Tensor，是一个数据类型为uint16、int16或int32的Tensor。 - - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - .. py:method:: broadcast_to(shape) - - 将输入shape广播到目标shape。 - - 更多细节请参考 :func:`mindspore.ops.broadcast_to` 。 - - **参数：** - - - **shape** (tuple) - 要广播的目标形状。可以由用户指定，或在要广播的维度上指定-1，它将被该位置的输入张量形状替换。 - - **返回：** - - Tensor， 形状为用户指定的 `shape`，类型和 `self` 相同。 - - **异常：** - - - **TypeError** - 如果输入的 `shape` 参数不是tuple类型。 - - **ValueError** - 如果输入的 `shape` 与 `self` 的形状不兼容，或者目标 `shape` 中的-1位于无效位置。 - - .. py:method:: ceil() - - 向上取整。 - - **返回：** - - Tensor。向上取整的结果。 - - **异常：** - - - **TypeError** - 如果当前Tensor的数据类型不是float16或者float32。 - - .. py:method:: choose(choices, mode='clip') - - 根据原始Tensor数组和一个索引数组构造一个新的Tensor。 - - **参数：** - - - **choices** (Union[tuple, list, Tensor]) - 索引选择数组。原始输入Tensor和 `choices` 的广播维度必须相同。如果 `choices` 本身是一个Tensor，则其最外层的维度（即，对应于第0维的维度）被用来定义 `choices` 数组。 - - **mode** ('raise', 'wrap', 'clip', optional) - 指定如何处理 `[0, n-1]` 外部的索引： - - - **raise** - 引发异常（默认）； - - **wrap** - 原值映射为对n取余后的值； - - **clip** - 大于n-1的值会被映射为n-1。该模式下禁用负数索引。 - - **返回：** - - Tensor，合并后的结果。 - - **异常：** - - - **ValueError** - 输入Tensor和任一 `choices` 无法广播。 - - .. py:method:: clip(xmin, xmax, dtype=None) - - 裁剪Tensor中的值。 - - 给定一个区间，区间外的值将被裁剪到区间边缘。 - 例如，如果指定的间隔为 :math:`[0, 1]` ，则小于0的值将变为0，大于1的值将变为1。 - - .. note:: - 目前不支持裁剪 `xmin=nan` 或 `xmax=nan` 。 - - **参数：** - - - **xmin** (Tensor, scalar, None) - 最小值。如果值为None，则不在间隔的下边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。 - - **xmax** (Tensor, scalar, None) - 最大值。如果值为None，则不在间隔的上边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。如果 `xmin` 或 `xmax` 是Tensor，则三个Tensor将被广播进行shape匹配。 - - **dtype** (`mindspore.dtype` , optional) - 覆盖输出Tensor的dtype。默认值为None。 - - **返回：** - - Tensor，含有输入Tensor的元素，其中values < `xmin` 被替换为 `xmin` ，values > `xmax` 被替换为 `xmax` 。 - - **异常：** - - - **TypeError** - 输入的类型与Tensor不一致。 - - **ValueError** - 输入与Tensor的shape不能广播，或者 `xmin` 和 `xmax` 都是 `None` 。 - - .. py:method:: col2im(output_size, kernel_size, dilation, padding_value, stride) - - 将一组滑动的局部块组合成一个大张量。 - - **参数：** - - - **output_size** (Tensor) - 输出张量的后两维的shape。 - - **kernel_size** (Union[int, tuple[int], list[int]]) - 滑动窗口的大小。 - - **dilation** (Union[int, tuple[int], list[int]]) - 滑动窗口扩张的大小。 - - **padding_value** (Union[int, tuple[int], list[int]]) - 填充的大小。 - - **stride** (Union[int, tuple[int], list[int]]) - 步长的大小。 - - **返回：** - - Tensor，输出的张量，维度和类型和输入一致。 - - **异常：** - - - **TypeError** - 如果 `kernel_size`，`dilation`，`padding_value`，`stride` 不属于 Union[int, tuple[int], list[int]]。 - - **ValueError** - 如果 `kernel_size`，`dilation`，`stride` 值小于等于0或者个数大于2。 - - **ValueError** - 如果 `padding_value` 值小于0或者个数大于2。 - - .. py:method:: copy() - - 复制一个Tensor并返回。 - - .. note:: - 当前实现不支持类似NumPy的 `order` 参数。 - - **返回：** - - 复制的Tensor。 - - .. py:method:: cosh() - - 逐元素计算双曲余弦值。 - - .. math:: - out_i = cosh(x_i) - - **返回：** - - Tensor，数据类型和shape与 `x` 相同。 - - .. py:method:: cummax(axis) - - 返回一个元组（最值、索引），其中最值是输入张量 `x` 沿维度 `axis` 的累积最大值，索引是每个最大值的索引位置。 - - .. math:: - \begin{array}{ll} \\ - y{i} = max(x{1}, x{2}, ... , x{i}) - \end{array} - - **参数：** - - - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 - - **返回：** - - 一个包含两个Tensor的元组，分别表示累积最大值和对应索引。 - - **异常：** - - - **TypeError** - 如果 `axis` 不是int。 - - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 - - .. py:method:: cummin(axis) - - 返回一个元组（最值、索引），其中最值是输入张量 `x` 沿维度 `axis` 的累积最小值，索引是每个最小值的索引位置。 - - .. math:: - \begin{array}{ll} \\ - y{i} = min(x{1}, x{2}, ... , x{i}) - \end{array} - - **参数：** - - - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 - - **返回：** - - 一个包含两个Tensor的元组，分别表示累积最小值和对应索引。 - - **异常：** - - - **TypeError** - 如果 `axis` 不是int。 - - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 - - .. py:method:: cumsum(axis=None, dtype=None) - - 返回指定轴方向上元素的累加值。 - - .. note:: - 如果 `dtype` 为 `int8` , `int16` 或 `bool` ，则结果 `dtype` 将提升为 `int32` ，不支持 `int64` 。 - - **参数：** - - - **axis** (int, optional) - 轴，在该轴方向上的累积和。默认情况下，计算所有元素的累加和。 - - **dtype** (`mindspore.dtype` , optional) - 如果未指定参数值，则保持与原始Tensor相同，除非参数值是一个精度小于 `float32` 的整数。在这种情况下，使用 `float32` 。默认值：None。 - - **异常：** - - - **ValueError** - 轴超出范围。 - - **返回：** - - Tensor。 - - .. py:method:: diag() - - 用给定的对角线值构造对角线张量。 - - 假设输入Tensor维度为 :math:`[D_1,... D_k]` ，则输出是一个rank为2k的tensor，其维度为 :math:`[D_1,..., D_k, D_1,..., D_k]` ，其中 :math:`output[i_1,..., i_k, i_1,..., i_k] = self[i_1,..., i_k]` 并且其他位置的值为0。 - - **返回：** - - Tensor，具有与输入Tensor相同的数据类型。 - - **异常：** - - - **ValueError** - 输入Tensor的rank小于1。 - - .. py:method:: diagonal(offset=0, axis1=0, axis2=1) - - 返回指定的对角线。 - - **参数：** - - - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 - - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 - - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 - - **返回：** - - Tensor，如果Tensor是二维，则返回值是一维数组。 - - **异常：** - - - **ValueError** - 输入Tensor的维度少于2。 - - .. py:method:: dtype - :property: - - 返回张量的数据类型（:class:`mindspore.dtype`）。 - - .. py:method:: expand_as(x) - - 将目标张量的维度扩展为输入张量的维度。 - - **参数：** - - - **x** (Tensor) - 输入的张量。 - - **返回：** - - 维度与输入张量的相同的Tensor。输出张量的维度必须遵守广播规则。广播规则指输出张量的维度需要扩展为输入张量的维度，如果目标张量的维度大于输入张量的维度，则不满足广播规则。 - - .. py:method:: expand_dims(axis) - - 沿指定轴扩展Tensor维度。 - - **参数：** - - - **axis** (int) - 扩展维度指定的轴。 - - **返回：** - - Tensor，指定轴上扩展的维度为1。 - - **异常：** - - - **TypeError** - axis不是int类型。 - - **ValueError** - axis的取值不在[-self.ndim - 1, self.ndim + 1)。 - - .. py:method:: erf() - - 逐元素计算原Tensor的高斯误差函数。 - 更多细节参考 :func:`mindspore.ops.erf`。 - - **返回：** - - Tensor，具有与原Tensor相同的数据类型和shape。 - - **异常：** - - - **TypeError** - 原Tensor的数据类型既不是float16也不是float32。 - - .. py:method:: erfc() - - 逐元素计算原Tensor的互补误差函数。 - 更多细节参考 :func:`mindspore.ops.erfc`。 - - **返回：** - - Tensor，具有与原Tensor相同的数据类型和shape。 - - **异常：** - - - **TypeError** - 原Tensor的数据类型既不是float16也不是float32。 - - .. py:method:: fill(value) - - 用标量值填充数组。 - - .. note:: - 与NumPy不同，Tensor.fill()将始终返回一个新的Tensor，而不是填充原来的Tensor。 - - **参数：** - - - **value** (Union[None, int, float, bool]) - 所有元素都被赋予这个值。 - - **返回：** - - Tensor，与原来的dtype和shape相同的Tensor。 - - **异常：** - - - **TypeError** - 输入参数具有前面未指定的类型。 - - .. py:method:: fills(value) - - 创建一个与当前Tensor具有相同shape和type的Tensor，并用标量值填充。 - - .. note:: - 与NumPy不同，Tensor.fills()将始终返回一个新的Tensor，而不是填充原来的Tensor。 - - **参数：** - - - **value** (Union[int, float, Tensor]) - 用来填充输出Tensor的值。数据类型为int，float或0-维Tensor。 - - **返回：** - - Tensor，与当前Tensor具有相同的shape和type。 - - **异常：** - - - **TypeError** - `value` 具有前面未指定的类型。 - - **RuntimeError** - `value` 不能转换为与当前Tensor相同的类型。 - - **ValueError** - `value` 是非0维Tensor。 - - .. py:method:: flatten(order='C') - - 返回展开成一维的Tensor的副本。 - - **参数：** - - - **order** (str, optional) - 可以在'C'和'F'之间进行选择。'C'表示按行优先（C风格）顺序展开。'F'表示按列优先顺序（Fortran风格）进行扁平化。仅支持'C'和'F'。默认值：'C'。 - - **返回：** - - Tensor，具有与输入相同的数据类型。 - - **异常：** - - - **TypeError** - `order` 不是字符串类型。 - - **ValueError** - `order` 是字符串类型，但不是'C'或'F'。 - - .. py:method:: flush_from_cache() - - 如果Tensor开启缓存作用，则将缓存数据刷新到host侧。 - - .. py:method:: from_numpy(array) - :staticmethod: - - 通过不复制数据的方式将Numpy数组转换为张量。 - - **参数：** - - - **array** (numpy.array) - 输入数组。 - - **返回：** - - 与输入的张量具有相同的数据类型的Tensor。 - - .. py:method:: gather(input_indices, axis) - - 返回指定 `axis` 上 `input_indices` 的元素对应的输入Tensor切片，输入Tensor的形状是 :math:`(x_1, x_2, ..., x_R)`。为了方便描述，对于输入Tensor记为 `input_params`。 - - .. note:: - 1. input_indices 的值必须在 `[0, input_params.shape[axis])` 的范围内，结果未定义超出范围。 - 2. 当前在Ascend平台，input_params的值不能是 `bool_ `_ 类型。 - - **参数：** - - - **input_indices** (Tensor) - 待切片的索引张量，其形状为 :math:`(y_1, y_2, ..., y_S)`，代表指定原始张量元素的索引，其数据类型包括：int32，int64。 - - **axis** (int) - 指定维度索引的轴以搜集切片。 - - **返回：** - - Tensor，其中shape维度为 :math:`input\_params.shape[:axis] + input\_indices.shape + input\_params.shape[axis + 1:]`。 - - **异常：** - - - **TypeError** - 如果 `axis` 不是一个整数。 - - **TypeError** - 如果 `input_indices` 不是一个整数类型的Tensor。 - - .. py:method:: gather_elements(dim, index) - - 获取指定轴的元素。 - - 对于三维Tensor，输出为： - - .. code-block:: - - output[i][j][k] = x[index[i][j][k]][j][k] # if dim == 0 - - output[i][j][k] = x[i][index[i][j][k]][k] # if dim == 1 - - output[i][j][k] = x[i][j][index[i][j][k]] # if dim == 2 - - `index` 与当前Tensor拥有一样的维度长度，且除 `dim` 维外其他维度一致。如果维度 `dim` 为i，当前Tensor是shape为 :math:`(z_0, z_1, ..., z_i, ..., z_{n-1})` 的n维Tensor，则 `index` 必须是shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})` 的n维Tensor，其中 `y` 大于等于1。输出的shape与 `index` 相同。 - - **参数：** - - - **dim** (int) - 获取元素的轴。数据类型为int32或int64。取值范围为[-self.ndim, self.ndim)。 - - **index** (Tensor) - 获取收集元素的索引。支持的数据类型包括：int32，int64。每个索引元素的取值范围为[-self.shape(dim), self.shape(dim))。 - - **返回：** - - Tensor，shape与 `index` 相同，即其shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})`，数据类型与 `self.dtype` 相同。 - - **异常：** - - - **TypeError** - `dim` 或 `index` 的数据类型既不是int32，也不是int64。 - - **ValueError** - `self` 和 `index` 的维度长度不一致。 - - **ValueError** - `self` 和 `index` 除 `dim` 维外的维度不一致。 - - **ValueError** - `dim` 的值不在合理范围内。 - - .. py:method:: gather_nd(indices) - - 按索引从输入Tensor中获取切片。 - 使用给定的索引从具有指定形状的输入Tensor中搜集切片。 - 输入Tensor的shape是 :math:`(N,*)` ，其中 :math:`*` 表示任意数量的附加维度。下文中的 `input_x` 代指输入Tensor本身。 - `indices` 是一个K维的整数张量，假定它的K-1维张量中的每一个元素是输入Tensor的切片，那么有： - - .. math:: - output[(i_0, ..., i_{K-2})] = input\_x[indices[(i_0, ..., i_{K-2})]] - - `indices` 的最后一维不能超过输入Tensor的秩： - :math:`indices.shape[-1] <= input\_x.rank`。 - - **参数：** - - - **indices** (Tensor) - 获取收集元素的索引张量，其数据类型包括：int32，int64。 - - **返回：** - - Tensor，具有与输入Tensor相同的数据类型，shape维度为 :math:`indices\_shape[:-1] + input\_x\_shape[indices\_shape[-1]:]`。 - - **异常：** - - - **ValueError** - 如果输入Tensor的shape长度小于 `indices` 的最后一个维度。 - - .. py:method:: ger(x) - - 计算两个Tensor的外积，即计算此Tensor 和 `x` 的外积。如果此Tensor shape为 :math:`(m,)` ，`x` shape为 :math:`(n,)` ， - 那么输出就是一个shape为 :math:`(m, n)` 的Tensor。 - - .. note:: - Ascend平台暂不支持float64数据格式的输入。 - - 更多参考详见 :func:`mindspore.ops.ger`。 - - **参数：** - - - **x** (Tensor) - 输入Tensor，数据类型为float16、float32或者float64。 - - **返回：** - - Tensor，是一个与此Tensor相同数据类型的输出矩阵。当此Tensor shape为 :math:`(m,)` ， `x` shape为 :math:`(n,)` ， - 那么输出shape为 :math:`(m, n)` 。 - - .. py:method:: hardshrink(lambd=0.5) - - Hard Shrink激活函数，按输入元素计算输出，公式定义如下： - - .. math:: - \text{HardShrink}(x) = - \begin{cases} - x, & \text{ if } x > \lambda \\ - x, & \text{ if } x < -\lambda \\ - 0, & \text{ otherwise } - \end{cases} - - **参数：** - - - **lambd** (float) - Hard Shrink公式定义的阈值 :math:`\lambda` 。默认值：0.5。 - - **返回：** - - Tensor，shape和数据类型与输入相同。 - - **异常：** - - - **TypeError** - `lambd` 不是float。 - - **TypeError** - 原始Tensor的dtype既不是float16也不是float32。 - - .. py:method:: has_init - :property: - - Tensor是否已经初始化。 - - .. py:method:: index_fill(dim, index, value) - - 按 `index` 中给定的顺序选择索引，将输入 `value` 值填充到当前Tensor的所有 `dim` 维元素。 - - **参数：** - - - **dim** (Union[int, Tensor]) - 填充输入Tensor的维度，要求是一个int或者数据类型为int32或int64的0维Tensor。 - - **index** (Tensor) - 填充输入Tensor的索引，数据类型为int32。 - - **value** (Union[bool, int, float, Tensor]) - 填充输入Tensor的值。如果 `value` 是Tensor，那么 `value` 要求是数据类型与当前Tensor相同的0维Tensor。否则，该值会自动转化为一个数据类型与当前Tensor相同的0维Tensor。 - - **返回：** - - 填充后的Tensor。shape和数据类型与当前Tensor相同。 - - **异常：** - - - **TypeError** - `dim` 的类型不是int或者Tensor。 - - **TypeError** - 当 `dim` 是Tensor时， `dim` 的数据类型不是int32或者int64。 - - **TypeError** - `index` 的类型不是Tensor。 - - **TypeError** - `index` 的数据类型不是int32。 - - **TypeError** - `value` 的类型不是bool、int、float或者Tensor。 - - **TypeError** - 当 `value` 是Tensor时， `value` 的数据类型和当前Tensor的数据类型不相同。 - - **ValueError** - 当 `dim` 是Tensor时， `dim` 的维度不等于0。 - - **ValueError** - `index` 的维度大于1。 - - **ValueError** - 当 `value` 是Tensor时， `value` 的维度不等于0。 - - **RuntimeError** - `dim` 值超出范围[-self.ndim, self.ndim - 1]。 - - **RuntimeError** - `index` 存在值超出范围[-self.shape[dim], self.shape[dim]-1]。 - - .. py:method:: init_data(slice_index=None, shape=None, opt_shard_group=None) - - 获取此Tensor的数据。 - - .. note:: 对于同一个Tensor，只可以调用一次 `init_data` 函数。 - - **参数：** - - - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 - - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 - - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数的切片。默认值：None。 - - **返回：** - - 初始化的Tensor。 - - .. py:method:: inplace_update(v, indices) - - 根据 `indices` 以 `v` 来更新Tensor中的值。 - - .. note:: - `indices` 只能沿着最高轴进行索引。 - - **参数：** - - - **v** (Tensor) - 用来更新的值。有相同的数据类型和除第一维外相同的shape。第一维的大小应该与 `indices` 大小相同。 - - **indices** (Union[int, tuple]) - 待更新值在原Tensor中的索引。 - - **返回：** - - Tensor，更新后的Tensor。 - - **异常：** - - - **TypeError** - `indices` 不是int或tuple。 - - **TypeError** - `indices` 是元组，但是其中的元素不是int。 - - **ValueError** - Tensor的shape与 `v` 的shape不同。 - - .. py:method:: inv() - - 计算当前Tensor的倒数。 - - .. math:: - out_i = \frac{1}{x_{i} } - - 其中 `x` 表示当前Tensor。 - - **返回：** - - Tensor，shape和类型与当前Tensor相同。 - - **异常：** - - - **TypeError** - 当前Tensor的数据类型不为float16、float32或int32。 - - .. py:method:: invert() - - 按位翻转当前Tensor。 - - .. math:: - out_i = \sim x_{i} - - 其中 `x` 表示当前Tensor。 - - **返回：** - - Tensor，shape和类型与当前Tensor相同。 - - **异常：** - - - **TypeError** - 当前Tensor的数据类型不为int16或uint16。 - - .. py:method:: isclose(x2, rtol=1e-05, atol=1e-08, equal_nan=False) - - 返回一个布尔型Tensor，表示当前Tensor与 `x2` 的对应元素的差异是否在容忍度内相等。 - - **参数：** - - - **x2** (Tensor) - 对比的第二个输入，支持的类型有float32，float16，int32。 - - **rtol** (float, optional) - 相对容忍度。默认值：1e-05。 - - **atol** (float, optional) - 绝对容忍度。默认值：1e-08。 - - **equal_nan** (bool, optional) - IsNan的输入，任意维度的Tensor。默认值：False。 - - **返回：** - - Tensor，shape与广播后的shape相同，数据类型是布尔型。 - - **异常：** - - - **TypeError** - 当前Tensor和 `x2` 中的任何一个不是Tensor。 - - **TypeError** - 当前Tensor和 `x2` 的数据类型不是float16、float32或int32之一。 - - **TypeError** - `atol` 和 `rtol` 中的任何一个不是float。 - - **TypeError** - `equal_nan` 不是bool。 - - **TypeError** - 当前Tensor和 `x2` 的数据类型不同。 - - **ValueError** - 当前Tensor和 `x2` 无法广播。 - - **ValueError** - `atol` 和 `rtol` 中的任何一个小于零。 - - .. py:method:: item(index=None) - - 获取Tensor中指定索引的元素。 - - .. note:: - Tensor.item返回的是Tensor标量，而不是Python标量。 - - **参数：** - - - **index** (Union[None, int, tuple(int)]) - Tensor的索引。默认值：None。 - - **返回：** - - Tensor标量，dtype与原始Tensor的相同。 - - **异常：** - - - **ValueError** - `index` 的长度不等于Tensor的ndim。 - - .. py:method:: itemset(*args) - - 将标量插入到Tensor（并将标量转换为Tensor的数据类型）。 - - 至少有1个参数，并且最后一个参数被定义为设定值。 - Tensor.itemset(\*args)等同于 :math:`Tensor[args] = item` 。 - - **参数：** - - - **args** (Union[(numbers.Number), (int/tuple(int), numbers.Number)]) - 指定索引和值的参数。如果 `args` 包含一个参数（标量），则其仅在Tensor大小为1的情况下使用。如果 `args` 包含两个参数，则最后一个参数是要设置的值且必须是标量，而第一个参数指定单个Tensor元素的位置。参数值是整数或者元组。 - - **返回：** - - 一个新的Tensor，其值为 :math:`Tensor[args] = item` 。 - - **异常：** - - - **ValueError** - 第一个参数的长度不等于Tensor的ndim。 - - **IndexError** - 只提供了一个参数，并且原来的Tensor不是标量。 - - .. py:method:: itemsize - :property: - - 返回一个Tensor元素的长度（以字节为单位）。 - - .. py:method:: lerp(end, weight) - - 基于某个浮点数Scalar或权重Tensor的值， 计算当前Tensor和 `end` Tensor之间的线性插值。 - - 如果参数 `weight` 是一个Tensor，那么另两个输入的维度信息可以被广播到当前Tensor。 - 如果参数 `weight` 是一个Scalar， 那么 `end` 的维度信息可以被广播到当前Tensor。 - - **参数：** - - - **end** (Tensor) - 进行线性插值的Tensor结束点，其数据类型必须为float16或者float32。 - - **weight** (Union[float, Tensor]) - 线性插值公式的权重参数。当为Scalar时，其数据类型为float，当为Tensor时，其数据类型为float16或者float32。 - - **返回：** - - 返回新的Tensor，其数据类型和维度必须和输入中的当前Tensor保持一致。 - - **异常：** - - - **TypeError** - 如果 `end` 不是Tensor。 - - **TypeError** - 如果 `weight` 不是float类型Scalar或者Tensor。 - - **TypeError** - 如果 `end` 的数据类型不是float16或者float32。 - - **TypeError** - 如果 `weight` 为Tensor且 `weight` 不是float16或者float32。 - - **TypeError** - 如果当前Tensor和 `end` 的数据类型不一致。 - - **TypeError** - 如果 `weight` 为Tensor且 `end` 、 `weight` 和当前Tensor数据类型不一致。 - - **ValueError** - 如果 `end` 的维度信息无法相互广播到当前Tensor。 - - **ValueError** - 如果 `weight` 为Tensor且 `weight` 的维度信息无法广播到当前Tensor。 - - .. py:method:: log1p() - - 对当前Tensor逐元素加一后计算自然对数。 - - .. math:: - out_i = {log_e}(x_i + 1) - - **返回：** - - Tensor，与 `x` 的shape相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型非float16或float32。 - - .. py:method:: logit(eps=None) - - 逐元素计算张量的logit值，当 eps 不是 None 时， `x` 中的元素被截断到范围[eps, 1-eps]内。 - 当 eps 为 None 时，输入 `x` 不进行数值截断。 - - `x` 指的当前 Tensor。 - - .. math:: - \begin{align} - y_{i} & = \ln(\frac{z_{i}}{1 - z_{i}}) \\ - z_{i} & = \begin{cases} - x_{i} & \text{if eps is None} \\ - \text{eps} & \text{if } x_{i} \lt \text{eps} \\ - x_{i} & \text{if } \text{eps} \leq x_{i} \leq 1 - \text{eps} \\ - 1 - \text{eps} & \text{if } x_{i} \gt 1 - \text{eps} - \end{cases} - \end{align} - - 参数： - - **eps** (float) - epsilon值。输入的数值界限被定义[eps, 1-eps]。 默认值：None。 - - 返回： - Tensor，具有与 `x` 相同的shape。 - - 异常： - - **TypeError** - `eps` 不是float类型。 - - **TypeError** - `x` 不是Tensor类型。 - - **TypeError** - `x` 的数据类型不是float16、float32或float64。 - - .. py:method:: log_matrix_determinant() - - 计算一个或多个平方矩阵行列式绝对值的对数的符号和绝对值的对数。 - - `x` 指的当前 Tensor。 - - **返回：** - - Tensor，行列式的绝对值的对数的符号， 形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 - - Tensor，行列式的绝对值的对数， 形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不为 Tensor。 - - **TypeError** - `x` 的数据类型不为以下类型： mstype.float32、 mstype.float64、 mstype.complex64 和 mstype.complex128。 - - **ValueError** - `x` 的最后两个维度大小不同。 - - **ValueError** - `x` 的维数小于2。 - - .. py:method:: masked_fill(mask, value) - - 将掩码位置为True的位置填充指定的值。该Tensor和 `mask` 的shape需相同或可广播。 - - **参数：** - - - **mask** (Tensor[bool]) - mask矩阵，值为bool类型的Tensor。 - - **value** (Union[float, Tensor]) - 填充值，其数据类型与该Tensor相同。 - - **返回：** - - Tensor，shape和dtype与该Tensor相同。 - - **异常：** - - - **TypeError** - `mask` 不是Tensor。 - - **TypeError** - `mask` 的数据类型不是bool。 - - **ValueError** - 该Tensor和 `mask` 的shape不可广播。 - - **TypeError** - 该Tensor 或 `value` 的数据类型不是float16、float32、int8、或int32。 - - **TypeError** - `value` 的数据类型与该Tensor不同。 - - **TypeError** - `value` 既不是float也不是Tensor。 - - .. py:method:: masked_select(mask) - - 返回一个一维张量，其中的内容是此张量中对应于 `mask` 张量中True位置的值。`mask` 张量的shape与此张量的shape不需要一样，但必须符合广播规则。 - - **参数：** - - - **mask** (Tensor[bool]) - 值为bool类型的张量。 - - **返回：** - - 一个一维张量，类型与此张量相同。 - - **异常：** - - - **TypeError** - `mask` 不是bool类型的Tensor。 - - .. py:method:: matrix_determinant() - - 计算一个或多个方阵的行列式。 - - `x` 指的当前 Tensor。 - - **返回：** - - Tensor，形状为 `x_shape[:-2]` ，数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不为 Tensor。 - - **TypeError** - `x` 的数据类型不为以下类型： mstype.float32、 mstype.float64、 mstype.complex64 和 mstype.complex128。 - - **ValueError** - `x` 的最后两个维度大小不同。 - - **ValueError** - `x` 的维数小于2。 - - .. py:method:: max(axis=None, keepdims=False, initial=None, where=True) - - 返回Tensor的最大值或轴方向上的最大值。 - - **参数：** - - - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最大值，而不是在单个轴或所有轴上进行选择。默认值：None。 - - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 - - **initial** (scalar, optional) - 输出元素的最小值。如果对空切片进行计算，则该参数必须设置。默认值：None。 - - **where** (bool Tensor, optional) - 一个bool数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 - - **返回：** - - Tensor或标量，输入Tensor的最大值。如果 `axis` 为None，则结果是一个标量值。如果提供了 `axis` ，则结果是Tensor ndim - 1维度的一个数组。 - - **异常：** - - - **TypeError** - 参数具有前面未指定的类型。 - - .. py:method:: mean(axis=(), keep_dims=False) - - 返回指定维度上所有元素的均值，并降维。 - - **参数：** - - - **axis** (Union[None, int, tuple(int), list(int)]) - 计算mean的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int、tuple(int)或list(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 - - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 - - **返回：** - - 与输入的张量具有相同的数据类型的Tensor。 - - .. py:method:: min(axis=None, keepdims=False, initial=None, where=True) - - 返回Tensor的最小值或轴方向上的最小值。 - - **参数：** - - - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最小值，而不是在单个轴或所有轴上进行选择。默认值：None。 - - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 - - **initial** (scalar, optional) - 输出元素的最大值。如果对空切片进行计算，则该参数必须设置。默认值：None。 - - **where** (bool Tensor, optional) - 一个布尔数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 - - **返回：** - - Tensor或标量，输入Tensor的最小值。如果轴为None，则结果为一个标量值。如果提供了 `axis` ，则结果是Tensor.ndim - 1维度的一个数组。 - - **异常：** - - - **TypeError** - 参数具有前面未指定的类型。 - - .. py:method:: narrow(axis, start, length) - - 沿指定轴，指定起始位置获取指定长度的Tensor。 - - **参数：** - - - **axis** (int) - 指定的轴。 - - **start** (int) - 指定的起始位置。 - - **length** (int) - 指定的长度。 - - **返回：** - - Tensor。 - - **异常：** - - - **TypeError** - axis不是int类型。 - - **TypeError** - start不是int类型。 - - **TypeError** - length不是int类型。 - - **ValueError** - axis取值不在[0, ndim-1]范围内。 - - **ValueError** - start取值不在[0, shape[axis]-1]范围内。 - - **ValueError** - start+length超出Tensor的维度范围shape[axis]-1。 - - .. py:method:: nbytes - :property: - - 返回Tensor占用的总字节数。 - - .. py:method:: ndim - :property: - - 返回Tensor维度的数量。 - - .. py:method:: nonzero() - - 计算x中非零元素的下标。 - - **返回：** - - Tensor，维度为2，类型为int64，表示输入中所有非零元素的下标。 - - .. py:method:: norm(axis, p=2, keep_dims=False, epsilon=1e-12) - - 返回给定Tensor的矩阵范数或向量范数。 - - .. math:: - output = sum(abs(input)**p)**(1/p) - - **参数：** - - - **axis** (Union[int, list, tuple]) - 指定要计算范数的输入维度。 - - **p** (int) - 范数的值。默认值：2。 `p` 大于等于0。 - - **keep_dims** (bool) - 输出Tensor是否保留原有的维度。默认值：False。 - - **epsilon** (float) - 用于保持数据稳定性的常量。默认值：1e-12。 - - **返回：** - - Tensor，其数据类型与当前Tensor相同，其维度信息取决于 `axis` 轴以及参数 `keep_dims` 。例如如果输入的大小为 `(2,3,4)` 轴为 `[0,1]` ，输出的维度为 `(4，)` 。 - - **异常：** - - - **TypeError** - 当前Tensor的数据类型不是float16或者float32。 - - **TypeError** - `axis` 不是int，tuple或者list。 - - **TypeError** - `p` 不是int。 - - **TypeError** - `axis` 是tuple或者list但其元素不是int。 - - **TypeError** - `keep_dims` 不是bool。 - - **TypeError** - `epsilon` 不是float。 - - **ValueError** - `axis` 的元素超出范围 `[-len(input_x.shape, len(input_x.shape)]` ，其中 `input_x` 指当前Tensor。 - - **ValueError** - `axis` 的维度rank大于当前Tensor的维度rank。 - - .. py:method:: pow(power) - - 计算Tensor中每个元素的 `power` 次幂。 - - .. math:: - - out_{i} = x_{i} ^{ y_{i}} - - .. note:: - - Tensor和 `power` 遵循 `隐式类型转换规则 `_ ，使数据类型保持一致。 - - 当前的Tensor和 `power` 的数据类型不能同时是bool，并保证其shape可以广播。 - - **参数：** - - - **power** (Union[Tensor, number.Number, bool]) - 幂值，是一个number.Number或bool值，或数据类型为number或bool_的Tensor。 - - **返回：** - - Tensor，shape与广播后的shape相同，数据类型为 `Tensor` 与 `power` 中精度较高的类型。 - - **异常：** - - - **TypeError** - `power` 不是Tensor、number.Number或bool。 - - **ValueError** - 当Tensor和 `power` 都为Tensor时，它们的shape不相同。 - - .. py:method:: prod(axis=(), keep_dims=False) - - 默认情况下，通过将维度中的所有元素相乘来减少张量的维度。并且还可以沿轴减小"x"的维度。通过控制 `keep_dims` 判断输出和输入的维度是否相同。 - - **参数：** - - - **axis** (Union[None, int, tuple(int), list(int)]) - 计算prod的维度。当 `axis` 为None或空元组时，计算所有维度。当 `axis` 为int、tuple(int)或list(int)时，记Tensor的维度为dim，则其取值范围为[-dim, dim)。默认值：()。 - - **keep_dims** (bool) - 计算结果是否保留维度。默认值：False。 - - **返回：** - - 与输入的张量具有相同的数据类型的Tensor。 - - **异常：** - - - **TypeError** - 如果 `axis` 不是以下数据类型之一：int、tuple 或 list。 - - **TypeError** - 如果 `x` 不是Tensor类型。 - - - .. py:method:: ptp(axis=None, keepdims=False) - - 该函数名称是"peak to peak"的缩写。计算沿着axis的最大值与最小值的差值。 - - .. note:: - 不支持NumPy参数 `dtype` 和 `out` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 轴，在轴方向上可以计算范围。默认计算扁平数组的方差。默认值：None。 - - **keepdims** (bool) - 如果设为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果将针对输入数组正确传递。默认值为False。 - - **返回：** - - Tensor。 - - **异常：** - - - **TypeError** - `self` 不是Tensor，或者 `axis` 和 `keepdims` 具有前面未指定的类型。 - - .. py:method:: random_categorical(num_sample, seed=0, dtype=mstype.int64) - - 从分类分布中抽取样本。 - - **参数：** - - - **num_sample** (int): 要抽取的样本数。只允许使用常量值。 - - **seed** (int): 随机种子。只允许使用常量值。默认值：0。 - - **dtype** (mindspore.dtype): 输出的类型。它的值必须是 mindspore.int16、mindspore.int32 和 mindspore.int64 之一。默认值：mindspore.int64。 - - **返回：** - - Tensor，Shape为 :math:`(batch_size, num_samples)` 的输出Tensor。 - - **异常：** - - - **TypeError** - 如果 `dtype` 不是以下之一：mindspore.int16、mindspore.int32、mindspore.int64。 - - **TypeError** - 如果 `logits` 不是Tensor。 - - **TypeError** - 如果 `num_sample` 或者 `seed` 不是 int。 - - .. py:method:: ravel() - - 返回一个展开的一维Tensor。 - - **返回：** - - 一维Tensor，含有与输入相同的元素。 - - .. py:method:: renorm(p, dim, maxnorm) - - 沿维度 `dim` 重新规范Tensor的子张量，并且每个子张量的p范数不超过给定的最大范数 `maxnorm` 。 如果子张量的p范数小于 `maxnorm` ，则当前子张量不需要修改；否则该子张量需要修改为对应位置的原值除以该子张量的p范数，然后再乘上 `maxnorm` 。 - - **参数：** - - - **p** (int) - 范数计算的幂。 - - **dim** (int) - 获得子张量的维度。 - - **maxnorm** (float32) - 给定的最大范数。 - - **返回：** - - Tensor，shape和type与输入Tensor一致。 - - **异常：** - - - **TypeError** - `p` 不是int类型。 - - **TypeError** - `dim` 不是int类型。 - - **TypeError** - `maxnorm` 不是float32类型。 - - **ValueError** - `p` 小于等于0。 - - .. py:method:: repeat(repeats, axis=None) - - 对数组中的元素进行重复复制。 - - **参数：** - - - **repeats** (Union[int, tuple, list]) - 每个元素的重复次数，`repeats` 被广播以适应指定轴的shape。 - - **axis** (int, optional) - 轴方向上的重复值。默认情况下，使用展开的输入Tensor，并返回一个展开的输出Tensor。 - - **返回：** - - Tensor，除了维度外，与输入Tensor具有相同的shape。 - - **异常：** - - - **ValueError** - 维度超出范围。 - - **TypeError** - 参数类型不匹配。 - - .. py:method:: reshape(*shape) - - 不改变数据的情况下，将Tensor的shape改为输入的新shape。 - - **参数：** - - - **shape** (Union[int, tuple(int), list(int)]) - 新的shape应与原来的shape兼容。如果参数值为整数，则结果是该长度的一维数组。shape的维度可以为-1。在这种情况下，将根据数组的长度和剩下的维度计算出该值。 - - **返回：** - - Tensor，具有新shape的Tensor。 - - **异常：** - - - **TypeError** - 新shape不是整数、列表或元组。 - - **ValueError** - 新shape与原来Tensor的shape不兼容。 - - .. py:method:: resize(*new_shape) - - 将Tensor改为输入的新shape，并将不足的元素补0。 - - .. note:: - 此方法不更改输入数组的大小，也不返回NumPy中的任何内容，而是返回一个具有输入大小的新Tensor。不支持Numpy参数 `refcheck` 。 - - **参数：** - - - **new_shape** (Union[ints, tuple of ints]) - 指定Tensor的新shape。 - - **返回：** - - Tensor。 - - .. py:method:: round() - - 将Tensor进行四舍五入到最接近的整数数值。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - .. py:method:: scatter_add(indices, updates) - - 根据指定的更新值和输入索引，通过加法进行运算，将结果赋值到输出Tensor中。当同一索引有不同值时，更新的结果将是所有值的总和。此操作几乎等同于使用 :class:`mindspore.ops.ScatterNdAdd` ，只是更新后的结果是通过算子output返回，而不是直接原地更新input。 - - `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。`updates` 的shape应该等于 `input_x[indices]` 的shape，其中 `input_x` 指当前Tensor。有关更多详细信息，请参见使用用例。 - - .. note:: - GPU平台上，如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误；CPU平台上直接抛出索引错误；Ascend平台不支持越界检查，若越界可能会造成未知错误。 - - **参数：** - - - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 - - **updates** (Tensor) - 指定与本Tensor相加操作的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: scatter_div(indices, updates) - - 根据索引，通过相除运算得到输出Tensor的值。更新后的结果是通过算子output返回，而不是直接原地更新当前Tensor。 - - `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。其中 `input_x` 指当前Tensor。 有关更多详细信息，请参见使用用例。 - - .. note:: - - 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新为当前Tensor，而不是抛出索引错误。 - - 算子无法处理除0异常, 用户需保证 `updates` 中没有0值。 - - **参数：** - - - **indices** (Tensor) - 该Tensor的索引，数据类型为int32或int64。其rank至少为2。 - - **updates** (Tensor) - 指定与当前Tensor相加操作的Tensor，其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]` ，其中 `input_x` 指当前Tensor。 - - **返回：** - - Tensor，shape和数据类型与该Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: scatter_min(indices, updates) - - 根据指定的更新值和输入索引，通过最小值运算，将结果赋值到输出Tensor中。 - - 索引的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。有关更多详细信息，请参见下方样例。 - - .. note:: - 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误。 - - **参数：** - - - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 - - **updates** (Tensor) - 指定与本Tensor做最小值运算的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: scatter_mul(indices, updates) - - 根据指定的索引，通过乘法进行计算，将结果赋值到输出Tensor中。更新后的结果是通过算子output返回，而不是直接原地更新当前Tensor。 - - `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。其中 `input_x` 指当前Tensor。 有关更多详细信息，请参见使用用例。 - - .. note:: - - 如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新为当前Tensor，而不是抛出索引错误。 - - **参数：** - - - **indices** (Tensor) - 该Tensor的索引，数据类型为int32或int64的。其rank必须至少为2。 - - **updates** (Tensor) - 指定与当前Tensor相加操作的Tensor，其数据类型与输入相同。updates.shape应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`， 其中 `input_x` 代指当前Tensor本身。 - - **返回：** - - Tensor，shape和数据类型与该Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: scatter_sub(indices, updates) - - 根据指定的更新值和输入索引，通过减法进行运算，将结果赋值到输出Tensor中。当同一索引有不同值时，更新的结果将分别减去这些值。此操作几乎等同于使用 :class:`mindspore.ops.ScatterNdSub` ，只是更新后的结果是通过算子output返回，而不是直接原地更新input。 - - `indices` 的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。`updates` 的shape应该等于 `input_x[indices]` 的shape，其中 `input_x` 指当前Tensor。有关更多详细信息，请参见使用用例。 - - .. note:: - GPU平台上，如果 `indices` 的某些值超出范围，则相应的 `updates` 不会更新到 `input_x` ，而不是抛出索引错误；CPU平台上直接抛出索引错误；Ascend平台不支持越界检查，若越界可能会造成未知错误。 - - **参数：** - - - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64。其rank至少为2。 - - **updates** (Tensor) - 指定与本Tensor相减操作的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]` 。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: searchsorted(v, side='left', sorter=None) - - 查找应插入元素以保存顺序的位置索引。 - - **参数：** - - - **v** (Union[int, float, bool, list, tuple, Tensor]) - 要插入元素的值。 - - **side** ('left', 'right', optional) - 如果参数值为'left'，则给出找到的第一个合适位置的索引。如果参数值为'right'，则返回最后一个这样的索引。如果没有合适的索引，则返回0或N（其中N是Tensor的长度）。默认值：'left'。 - - **sorter** (Union[int, float, bool, list, tuple, Tensor]) - 整数索引的可选一维数组，将Tensor按升序排序。它们通常是NumPy argsort方法的结果。默认值：None。 - - **返回：** - - Tensor，shape与 `v` 相同的插入点数组。 - - **异常：** - - - **ValueError** - `side` 或 `sorter` 的参数无效。 - - .. py:method:: select(condition, y) - - 根据条件判断Tensor中的元素的值，来决定输出中的相应元素是从当前Tensor（如果元素值为True）还是从 `y` （如果元素值为False）中选择。 - - 该算法可以被定义为： - - .. math:: - - out_i = \begin{cases} - tensor_i, & \text{if } condition_i \\ - y_i, & \text{otherwise} - \end{cases} - - **参数：** - - - **condition** (Tensor[bool]) - 条件Tensor，决定选择哪一个元素。shape与当前的Tensor相同。 - - **y** (Union[Tensor, int, float]) - 如果y是一个Tensor，那么shape与当前Tensor相同。如果y是int或者float，那么将会被转化为int32或者float32类型，并且被广播为与当前Tensor相同的shape。 - - **返回：** - - Tensor，与当前Tensor的shape相同。 - - **异常：** - - - **TypeError** - `y` 不是Tensor、int或者float。 - - **ValueError** - 输入的shape不相同。 - - .. py:method:: shape - :property: - - 返回Tensor的shape。 - - .. py:method:: size - :property: - - 返回Tensor中的元素总数。 - - .. py:method:: soft_shrink(lambd=0.5) - - Soft Shrink激活函数，按输入元素计算输出，公式定义如下： - - .. math:: - \text{SoftShrink}(x) = - \begin{cases} - x - \lambda, & \text{ if } x > \lambda \\ - x + \lambda, & \text{ if } x < -\lambda \\ - 0, & \text{ otherwise } - \end{cases} - - **参数：** - - - **lambd** (float) - :math:`\lambda` 应大于等于0。默认值：0.5。 - - **返回：** - - Tensor，shape和数据类型与输入相同。 - - **异常：** - - - **TypeError** - `lambd` 不是float。 - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - 原始Tensor的dtype既不是float16也不是float32。 - - **ValueError** - `lambd` 小于0。 - - .. py:method:: split(axis=0, output_num=1) - - 根据指定的轴和分割数量对Tensor进行分割。 - - Tensor将被分割为相同shape的子Tensor，且要求 `self.shape(axis)` 可被 `output_num` 整除。 - - **参数：** - - - **axis** (int) - 指定分割轴。默认值：0。 - - **output_num** (int) - 指定分割数量。其值为正整数。默认值：1。 - - **返回：** - - tuple[Tensor]，每个输出Tensor的shape相同，即 :math:`(y_1, y_2, ..., y_S)` 。数据类型与Tensor相同。 - - **异常：** - - - **TypeError** - `axis` 或 `output_num` 不是int。 - - **ValueError** - `axis` 超出[-len(`self.shape`), len(`self.shape`))范围。或 `output_num` 小于或等于0。 - - **ValueError** - `self.shape(axis)` 不可被 `output_num` 整除。 - - .. py:method:: squeeze(axis=None) - - 从Tensor中删除shape为1的维度。 - - **参数：** - - - **axis** (Union[None, int, list(int), tuple(int)], optional) - 选择shape中长度为1的条目的子集。如果选择shape条目长度大于1的轴，则报错。默认值为None。 - - **返回：** - - Tensor，删除了长度为1的维度的全部子集或一个子集。 - - **异常：** - - - **TypeError** - 输入的参数类型有误。 - - **ValueError** - 指定维度的shape大于1。 - - .. py:method:: std(axis=None, ddof=0, keepdims=False) - - 计算指定维度的标准差。 - 标准差是方差的算术平方根，如：:math:`std = sqrt(mean(abs(x - x.mean())**2))` 。 - - 返回标准差。默认情况下计算展开数组的标准差，否则在指定维度上计算。 - - .. note:: - 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 在该维度上计算标准差。默认值：`None` 。如果为 `None` ，则计算展开数组的标准偏差。 - - **ddof** (int) - δ自由度。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。默认值：0。 - - **keepdims** - 默认值：`False`。 - - **返回：** - - 含有标准差数值的Tensor。 - - .. py:method:: strides - :property: - - Tensor上每个维度跨度的字节元组。 - - .. py:method:: sum(axis=None, dtype=None, keepdims=False, initial=None) - - 返回指定维度上数组元素的总和。 - - .. note:: - 不支持NumPy参数 `out` 、 `where` 、 `casting` 、 `order` 、 `subok` 、 `signature` 和 `extobj` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 指定维度，在该维度方向上进行求和运算。默认值：None。如果参数值为None，会计算输入数组中所有元素的和。如果axis为负数，则从最后一维开始往第一维计算。如果axis为整数元组，会对该元组指定的所有轴方向上的元素进行求和。 - - **dtype** (`mindspore.dtype`, optional) - 默认值为None。会覆盖输出Tensor的dtype。 - - **keepdims** (bool) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。如果设为默认值，那么 `keepdims` 不会被传递给ndarray子类的sum方法。但是任何非默认值都会被传递。如果子类的方法未实现 `keepdims` ，则引发异常。默认值：False。 - - **initial** (scalar) - 初始化的起始值。默认值：None。 - - **返回：** - - Tensor。具有与输入相同shape的Tensor，删除了指定的轴。如果输入Tensor是0维数组，或axis为None时，返回一个标量。 - - **异常：** - - - **TypeError** - input不是Tensor，`axis` 不是整数或整数元组，`keepdims` 不是整数，或者 `initial` 不是标量。 - - **ValueError** - 任意轴超出范围或存在重复的轴。 - - .. py:method:: svd(full_matrices=False, compute_uv=True) - - 更多参考详见 :func:`mindspore.ops.svd`。 - - **参数：** - - - **full_matrices** (bool, optional) - 如果这个参数为True，则计算完整的 :math:`U` 和 :math:`V` 。否则 :math:`U` 和 :math:`V` 的shape和P有关，P是M和N的较小值, M和N是输入矩阵的行和列。默认值：False。 - - **compute_uv** (bool, optional) - 如果这个参数为True，则计算 :math:`U` 和 :math:`V` ，否则只计算 :math:`S` 。默认值：True。 - - **返回：** - - - **s** (Tensor) - 奇异值。shape为 :math:`(*, P)`。 - - **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。 - - **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。 - - **异常：** - - - **TypeError** - `full_matrices` 或 `compute_uv` 不是bool类型。 - - **TypeError** - 输入的rank小于2。 - - **TypeError** - 输入的数据类型不为float32或float64。 - - .. py:method:: swapaxes(axis1, axis2) - - 交换Tensor的两个维度。 - - **参数：** - - - **axis1** (int) - 第一个维度。 - - **axis2** (int) - 第二个维度。 - - **返回：** - - 转化后的Tensor，与输入具有相同的数据类型。 - - **异常：** - - - **TypeError** - `axis1` 或 `axis2` 不是整数。 - - **ValueError** - `axis1` 或 `axis2` 不在 `[-ndim, ndim-1]` 范围内。 - - .. py:method:: take(indices, axis=None, mode='clip') - - 在指定维度上获取Tensor中的元素。 - - **参数：** - - - **indices** (Tensor) - 待提取的值的shape为 `(Nj...)` 的索引。 - - **axis** (int, optional) - 在指定维度上选择值。默认情况下，使用展开的输入数组。默认值：None。 - - **mode** ('raise', 'wrap', 'clip', optional) - - - raise：抛出错误。 - - wrap：绕接。 - - clip：裁剪到范围。 `clip` 模式意味着所有过大的索引都会被在指定轴方向上指向最后一个元素的索引替换。注：这将禁用具有负数的索引。默认值：`clip` 。 - - **返回：** - - Tensor，索引的结果。 - - **异常：** - - - **ValueError** - `axis` 超出范围，或 `mode` 被设置为'raise'、'wrap'和'clip'以外的值。 - - .. py:method:: tan() - - 返回每个元素的正切值。 - - .. math:: - - out_i = tan(x_i) - - **返回：** - - Tensor。 - - **异常：** - - - **TypeError** - 当前输入不是Tensor。 - - .. py:method:: to_coo() - - 将常规Tensor转为稀疏化的COOTensor。 - - .. note:: - 现在只支持2维Tensor。 - - **返回：** - - 返回一个2维的COOTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： - - - **indices** (Tensor) - 二维整数张量，表示稀疏张量中 `values` 所处的位置索引。 - - **values** (Tensor) - 一维张量，用来给 `indices` 中的每个元素提供数值。 - - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 - - **异常：** - - - **ValueError** - Tensor的shape不是2维。 - - .. py:method:: to_csr() - - 将常规Tensor转为稀疏化的CSRTensor。 - - .. note:: - 现在只支持2维Tensor。 - - **返回：** - - 返回一个2维的CSRTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： - - - **indptr** (Tensor) - 一维整数张量，表示每行非零元素的在 `values` 中存储的起止位置。 - - **indices** (Tensor) - 一维整数张量，表示每个元素的列索引值。 - - **values** (Tensor) - 一维张量，用来表示索引对应的数值。 - - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 - - **异常：** - - - **ValueError** - Tensor的shape不是2维。 - - .. py:method:: to_tensor(slice_index=None, shape=None, opt_shard_group=None) - - 返回init_data()的结果，并获取此Tensor的数据。 - - .. note:: - 不建议使用 `to_tensor` 。请使用 `init_data` 。 - - **参数：** - - - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 - - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 - - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数切片的分片。默认值：None。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: top_k(k, sorted=True) - - 沿最后一个维度查找 `k` 个最大元素和对应的索引。 - - .. warning:: - - 如果 `sorted` 设置为'False'，它将使用aicpu运算符，性能可能会降低。 - - `x` 指的当前 Tensor。 - - 如果 `input_x` 是一维Tensor，则查找Tensor中 `k` 个最大元素，并将其值和索引输出为Tensor。因此， `values[k]` 是 `input_x` 中 `k` 个最大元素，其索引是 `indices[k]` 。 - - 对于多维矩阵，计算每行中最大的 `k` 个元素（沿最后一个维度的相应向量），因此： - - .. math:: - values.shape = indices.shape = input\_x.shape[:-1] + [k]. - - 如果两个比较的元素相同，则优先返回索引值较小的元素。 - - **参数：** - - - **k** (int) - 指定计算最大元素的数量，需要是常量。 - - **sorted** (bool, optional) - 如果为True，则获取的元素将按值降序排序。默认值：True。 - - **返回：** - - 2个Tensor组成的tuple， `values` 和 `indices` 。 - - - **values** (Tensor) - 最后一个维度的每个切片中的 `k` 最大元素。 - - **indices** (Tensor) - `k` 最大元素的对应索引。 - - **异常：** - - - **TypeError** - 如果 `k` 不是int。 - - **TypeError** - 如果 `sorted` 不是bool。 - - .. py:method:: scatter_max(indices, updates) - - 根据指定的更新值和输入索引，通过最大值运算，输出结果以Tensor形式返回。 - - 索引的最后一个轴是每个索引向量的深度。对于每个索引向量， `updates` 中必须有相应的值。 `updates` 的shape应该等于 `input_x[indices]` 的shape。有关更多详细信息，请参见下方样例。 - - .. note:: - 如果 `indices` 的某些值超出范围，则不会更新相应的 `updates`，同时也不会抛出索引错误。 - - **参数：** - - - **indices** (Tensor) - Tensor的索引，数据类型为int32或int64的。其rank必须至少为2。 - - **updates** (Tensor) - 指定与本Tensor做最大值运算的Tensor，其数据类型与该Tensor相同。 `updates.shape` 应等于 `indices.shape[:-1] + self.shape[indices.shape[-1]:]`。 - - **返回：** - - Tensor，shape和数据类型与原Tensor相同。 - - **异常：** - - - **TypeError** - `indices` 的数据类型既不是int32，也不是int64。 - - **ValueError** - Tensor的shape长度小于 `indices` 的shape的最后一个维度。 - - .. py:method:: trace(offset=0, axis1=0, axis2=1, dtype=None) - - 在Tensor的对角线方向上的总和。 - - **参数：** - - - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 - - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 - - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 - - **dtype** (`mindspore.dtype` , optional) - 默认值为None。覆盖输出Tensor的dtype。 - - **返回：** - - Tensor，对角线方向上的总和。 - - **异常：** - - **ValueError** - 输入Tensor的维度少于2。 - - .. py:method:: transpose(*axes) - - 返回被转置后的Tensor。 - - - 对于一维Tensor，这没有影响，因为转置后的向量是相同的。 - - 对于二维Tensor，是标准的矩阵转置。 - - 对于n维Tensor，如果提供了维度，则它们的顺序代表维度的置换方式。 - - 如果未提供轴，且Tensor.shape等于(i[0], i[1],...i[n-2], i[n-1])，则Tensor.transpose().shape等于(i[n-1], i[n-2], ... i[1], i[0])。 - - **参数：** - - - **axes** (Union[None, tuple(int), list(int), int], optional) - 如果 `axes` 为None或未设置，则该方法将反转维度。如果 `axes` 为tuple(int)或list(int)，则Tensor.transpose()把Tensor转置为新的维度。如果 `axes` 为整数，则此表单仅作为元组/列表表单的备选。 - - **返回：** - - Tensor，具有与输入Tensor相同的维度，其中维度被准确的排列。 - - **异常：** - - - **TypeError** - 输入参数类型有误。 - - **ValueError** - `axes` 的数量不等于Tensor.ndim。 - - .. py:method:: unique_consecutive(return_idx=False, return_counts=False, axis=None) - - 返回输入张量中每个连续等效元素组中唯一的元素。 - - **参数：** - - - **return_idx** (bool, optional) - 是否返回原始输入中，各元素在返回的唯一列表中的结束位置的索引。默认值：False。 - - **return_counts** (bool, optional) - 是否返回每个唯一元素的计数。默认值：False。 - - **axis** (int, optional) - 维度。如果为None，对输入进行展平操作，返回其唯一性。如果指定，必须是int32或int64类型。默认值：None。 - - **返回：** - - Tensor或包含Tensor对象的元组（ `output` 、 `idx` 、 `counts` ）。 `output` 与输入张量具有相同的类型，用于表示唯一标量元素的输出列表。 - 如果 `return_idx` 为 True，则会有一个额外的返回张量 `idx`，它的形状与输入张量相同，表示原始输入中的元素映射到输出中的位置的索引。如果 - `return_idx` 为 True，则会有一个额外的返回张量 `counts`，表示每个唯一值或张量的出现次数。 - - **异常：** - - - **RuntimeError** - `axis` 不在 `[-ndim, ndim-1]` 范围内。 - - .. py:method:: unique_with_pad(pad_num) - - 对当前一维张量中元素去重，返回一维张量中的唯一元素（使用pad_num填充）和相对索引。 - - 基本操作与unique相同，但unique_with_pad多了pad操作。 - unique运算符对张量处理后所返回的元组（ `y` ， `idx` ）， `y` 与 `idx` 的shape通常会有差别，因此，为了解决上述情况， - unique_with_pad操作符将用用户指定的 `pad_num` 填充 `y` 张量，使其具有与张量 `idx` 相同的形状。 - - **参数：** - - - **pad_num** (int) - 填充值。数据类型为int32或int64。 - - **返回：** - - Tuple， `(y, idx)` 。 `y` 是与当前张量形状和数据类型相同的Tensor，包含当前张量中去重后的元素，并用 `pad_num` 填充。 `idx` 为索引Tensor，包含当前张量中的元素在 `y` 中的索引，与当前张量的shape相同。 - - **异常：** - - - **TypeError** - 当前张量的数据类型既不是int32也不是int64。 - - **ValueError** - 当前张量不是一维张量。 - - .. py:method:: unsorted_segment_max(segment_ids, num_segments) - - 沿分段计算输入Tensor的最大值。 - - .. note:: - - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用 `x` 的数据类型的最小值填充输出 `output[i]` 。 - - `segment_ids` 必须是一个非负Tensor。 - - **参数：** - - - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 - - **num_segments** (int) - 分段的数量。 - - **返回：** - - Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 - - **异常：** - - - **TypeError** - `num_segments` 不是int类型。 - - **ValueError** - `segment_ids` 的维度不等于1。 - - .. py:method:: unsorted_segment_min(segment_ids, num_segments) - - 沿分段计算输入Tensor的最小值。 - - .. note:: - - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用 `x` 的数据类型的最大值填充输出 `output[i]` 。 - - `segment_ids` 必须是一个非负Tensor。 - - **参数：** - - - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 - - **num_segments** (int) - 分段的数量。 - - **返回：** - - Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 - - **异常：** - - - **TypeError** - `num_segments` 不是int类型。 - - **ValueError** - `segment_ids` 的维度不等于1。 - - .. py:method:: unsorted_segment_prod(segment_ids, num_segments) - - 沿分段计算输入Tensor元素的乘积。 - - .. note:: - - 如果 `segment_ids` 中不存在segment_id `i` ，则将使用1填充输出 `output[i]` 。 - - `segment_ids` 必须是一个非负Tensor。 - - **参数：** - - - **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量，值必须是非负数。数据类型支持int32。 - - **num_segments** (int) - 分段的数量。 - - **返回：** - - Tensor，若 `num_segments` 值为 `N` ，则shape为 :math:`(N, x_2, ..., x_R)` 。 - - **异常：** - - - **TypeError** - `num_segments` 不是int类型。 - - **ValueError** - `segment_ids` 的维度不等于1。 - - .. py:method:: var(axis=None, ddof=0, keepdims=False) - - 在指定维度上的方差。 - - 方差是平均值的平方偏差的平均值，即：:math:`var = mean(abs(x - x.mean())**2)` 。 - - 返回方差值。默认情况下计算展开Tensor的方差，否则在指定维度上计算。 - - .. note:: - 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 维度，在指定维度上计算方差。其默认值是展开Tensor的方差。默认值：None。 - - **ddof** (int) - δ自由度。默认值：0。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。 - - **keepdims** (bool) - 默认值：False。 - - **返回：** - - 含有方差值的Tensor。 - - .. py:method:: view(*shape) - - 根据输入shape重新创建一个Tensor，与原Tensor数据相同。该方法与reshape方法相同，都是依靠底层reshape算子实现的。 - - **参数：** - - - **shape** (Union[tuple(int), int]) - 输出Tensor的维度。 - - **返回：** - - Tensor，具有与入参 `shape` 相同的维度。 - - .. py:method:: xlogy(y) - - 计算原Tensor乘以输入Tensor的对数。当原Tensor为零时，则返回零。原Tensor的数据类型需要是 - `number `_ 或 - `bool_ `_。 - 后面为了使表达清晰，使用 `x` 代替原Tensor。 - - .. math:: - out_i = x_{i}\ln{y_{i}} - - `x` 和 `y` 的输入遵循隐式类型转换规则，使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时，它们的数据类型不能同时是bool的，它们的shape可以广播。当输入是一个Tensor和一个Scalar时，Scalar只能是一个常量。 - - **参数：** - - - **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时，则第二个输入是数值型或bool。当第一个输入是Scalar时，则第二个输入必须是数据类型为数值型或bool的Tensor。 - - **返回：** - - Tensor，shape与广播后的shape相同，数据类型为两个输入中精度较高或数数值较高的类型。 - - **异常：** - - - **TypeError** - 如果 `x` 和 `y` 不是数值型、bool或Tensor。 - - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32或float64。 - - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 - - .. py:method:: xdivy(y) - - 计算原Tensor除以输入的Tensor。当原Tensor为零时，则返回零。原Tensor的数据类型需要是float，complex或bool。 - 后面为了使表达清晰，使用 `x` 代替原Tensor。 - - .. math:: - out_i = x_{i}\y_{i} - - `x` 和 `y` 的输入遵循隐式类型转换规则，使数据类型一致。y是一个Tensor或Scalar。当y是Tensor时，x和y的数据类型不能同时是bool的，它们的shape可以广播。当y是Scalar时，只能是一个常量。 - - **参数：** - - - **y** (Union[Tensor, number.Number, bool]) - float、complex或bool类型的Tensor。`x` 和 `y` 不能同时为bool类型。 - - **返回：** - - Tensor，shape与广播后的shape相同，数据类型为两个输入中精度较高或数数值较高的类型。 - - **异常：** - - - **TypeError** - 如果 `y` 不是以下之一：Tensor、Number、bool。 - - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32、float64、complex64、complex128、bool。 - - **ValueError** - 如果 `x` 不能广播至 `y` 的shape。 - - **RuntimeError** - 如果Parameter的 `x` , `y` 需要进行数据类型转换，但是Parameter是不支持数据类型转换。 +.. mscnplatformautosummary:: + :toctree: Tensor + :nosignatures: + + mindspore.Tensor.abs + mindspore.Tensor.addcdiv + mindspore.Tensor.addcmul + mindspore.Tensor.all + mindspore.Tensor.any + mindspore.Tensor.approximate_equal + mindspore.Tensor.argmax + mindspore.Tensor.argmin + mindspore.Tensor.argmin_with_value + mindspore.Tensor.asnumpy + mindspore.Tensor.assign_value + mindspore.Tensor.astype + mindspore.Tensor.atan2 + mindspore.Tensor.bernoulli + mindspore.Tensor.bitwise_and + mindspore.Tensor.bitwise_or + mindspore.Tensor.bitwise_xor + mindspore.Tensor.broadcast_to + mindspore.Tensor.ceil + mindspore.Tensor.choose + mindspore.Tensor.clip + mindspore.Tensor.col2im + mindspore.Tensor.copy + mindspore.Tensor.cosh + mindspore.Tensor.cummax + mindspore.Tensor.cummin + mindspore.Tensor.cumsum + mindspore.Tensor.diag + mindspore.Tensor.diagonal + mindspore.Tensor.dtype + mindspore.Tensor.erf + mindspore.Tensor.erfc + mindspore.Tensor.expand_as + mindspore.Tensor.expand_dims + mindspore.Tensor.fill + mindspore.Tensor.fills + mindspore.Tensor.flatten + mindspore.Tensor.flush_from_cache + mindspore.Tensor.from_numpy + mindspore.Tensor.gather + mindspore.Tensor.gather_elements + mindspore.Tensor.gather_nd + mindspore.Tensor.ger + mindspore.Tensor.hardshrink + mindspore.Tensor.has_init + mindspore.Tensor.index_fill + mindspore.Tensor.init_data + mindspore.Tensor.inplace_update + mindspore.Tensor.inv + mindspore.Tensor.invert + mindspore.Tensor.isclose + mindspore.Tensor.item + mindspore.Tensor.itemset + mindspore.Tensor.itemsize + mindspore.Tensor.lerp + mindspore.Tensor.log1p + mindspore.Tensor.log_matrix_determinant + mindspore.Tensor.logit + mindspore.Tensor.masked_fill + mindspore.Tensor.masked_select + mindspore.Tensor.matrix_determinant + mindspore.Tensor.max + mindspore.Tensor.mean + mindspore.Tensor.min + mindspore.Tensor.narrow + mindspore.Tensor.nbytes + mindspore.Tensor.ndim + mindspore.Tensor.nonzero + mindspore.Tensor.norm + mindspore.Tensor.pow + mindspore.Tensor.prod + mindspore.Tensor.ptp + mindspore.Tensor.random_categorical + mindspore.Tensor.ravel + mindspore.Tensor.renorm + mindspore.Tensor.repeat + mindspore.Tensor.reshape + mindspore.Tensor.resize + mindspore.Tensor.round + mindspore.Tensor.scatter_add + mindspore.Tensor.scatter_div + mindspore.Tensor.scatter_max + mindspore.Tensor.scatter_min + mindspore.Tensor.scatter_mul + mindspore.Tensor.scatter_sub + mindspore.Tensor.searchsorted + mindspore.Tensor.select + mindspore.Tensor.shape + mindspore.Tensor.size + mindspore.Tensor.soft_shrink + mindspore.Tensor.split + mindspore.Tensor.squeeze + mindspore.Tensor.std + mindspore.Tensor.strides + mindspore.Tensor.sum + mindspore.Tensor.svd + mindspore.Tensor.swapaxes + mindspore.Tensor.T + mindspore.Tensor.take + mindspore.Tensor.tan + mindspore.Tensor.top_k + mindspore.Tensor.to_coo + mindspore.Tensor.to_csr + mindspore.Tensor.to_tensor + mindspore.Tensor.trace + mindspore.Tensor.transpose + mindspore.Tensor.unique_consecutive + mindspore.Tensor.unique_with_pad + mindspore.Tensor.unsorted_segment_max + mindspore.Tensor.unsorted_segment_min + mindspore.Tensor.unsorted_segment_prod + mindspore.Tensor.var + mindspore.Tensor.view + mindspore.Tensor.xdivy + mindspore.Tensor.xlogy \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_grid_sample.rst b/docs/api/api_python/ops/mindspore.ops.func_grid_sample.rst index 41d4b5e159e..3830f22f6b0 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_grid_sample.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_grid_sample.rst @@ -16,23 +16,23 @@ mindspore.ops.grid_sample 远离边界的位置，它会一直被反射，直到在边界内。 参数： - - **input_x** (Tensor) - 4-D场景下，shape为 :math:`(N, C, H_{in}, W_{in})`，5-D场景下，shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})`。数据类型为float32或float64。 - - **grid** (Tensor) - 4-D场景下，shape为 :math:`(N, H_{out}, W_{out}, 2)`，5-D场景下，shape为 :math:`(N, D_{out}, H_{out}, W_{out}, 3)`。数据类型与 `input_x` 保持一致。 - - **interpolation_mode** (str) - 插值方法。可选方法为 `bilinear`，`nearest` 或 `bicubic`。默认值：`bilinear`。需要注意的是 `bicubic` 只支持4-D输入。当 `interpolation_mode` - 为 `bilinear`，且输入为5-D，则 `interpolation_mode` 为 `trilinear`。但是，当输入为4-D，则 `interpolation_mode` 为 `bilinear`。 - - **padding_mode** (str) - 填充方法。可选方法为 `zeros`，`border` 和 `reflection`。默认值为 `zeros`。 - - **align_corners** (bool) - 布尔值。如果设置成 `True`，-1和1被视为引用输入角像素的中心点。如果设置为 `False`，将被视为引用到输入角像素的角点，使采样更不受分辨率影响。 - 默认值为 `False`。 + - **input_x** (Tensor) - 4-D场景下，shape为 :math:`(N, C, H_{in}, W_{in})`，5-D场景下，shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})`。数据类型为float32或float64。 + - **grid** (Tensor) - 4-D场景下，shape为 :math:`(N, H_{out}, W_{out}, 2)`，5-D场景下，shape为 :math:`(N, D_{out}, H_{out}, W_{out}, 3)`。数据类型与 `input_x` 保持一致。 + - **interpolation_mode** (str) - 插值方法。可选方法为 `bilinear`，`nearest` 或 `bicubic`。默认值：`bilinear`。需要注意的是 `bicubic` 只支持4-D输入。当 `interpolation_mode` + 为 `bilinear`，且输入为5-D，则 `interpolation_mode` 为 `trilinear`。但是，当输入为4-D，则 `interpolation_mode` 为 `bilinear`。 + - **padding_mode** (str) - 填充方法。可选方法为 `zeros`，`border` 和 `reflection`。默认值为 `zeros`。 + - **align_corners** (bool) - 布尔值。如果设置成 `True`，-1和1被视为引用输入角像素的中心点。如果设置为 `False`，将被视为引用到输入角像素的角点，使采样更不受分辨率影响。 + 默认值为 `False`。 返回： Tensor，数据类型与 `input_x` 相同，4-D场景下，shape为 :math:`(N, C, H_{out}, W_{out})`，5-D场景下，shape为 :math:`(N, C, D_{out}, H_{out}, W_{out})`。 异常： - **TypeError** - 如果 `input_x` 或 `grid` 不是Tensor类型。 - - **TypeError** - 如果 `input_x` 和 `grid` 的数据类型不一致。 + - **TypeError** - 如果 `input_x` 和 `grid` 的数据类型不一致。 - **TypeError** - 如果 `input_x` 或 `grid` 的数据类型无效。 - - **TypeError** - 如果 `align_corners` 不是一个布尔值。 - - **ValueError** - 如果 `input_x` 或 `grid` 的维度不是4维或5维。 + - **TypeError** - 如果 `align_corners` 不是一个布尔值。 + - **ValueError** - 如果 `input_x` 或 `grid` 的维度不是4维或5维。 - **ValueError** - 如果 `input_x` 的第一个维度不等于 `grid` 的第一个维度。 - **ValueError** - 如果 `grid` 最后一个维度不等于2（4-D场景）或者3（5-D场景）。 - **ValueError** - 如果 `interpolation_mode` 不是 `bilinear`，`nearest`，`bicubic`，数据类型不为String。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_log1p.rst b/docs/api/api_python/ops/mindspore.ops.func_log1p.rst index 9678230f77e..9d238551c6e 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_log1p.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_log1p.rst @@ -1,7 +1,7 @@ mindspore.ops.log1p =================== -.. py:function:: mindspore.ops.log1p +.. py:function:: mindspore.ops.log1p(x) 对输入Tensor逐元素加一后计算自然对数。 diff --git a/docs/api/api_python_en/Tensor_list.rst b/docs/api/api_python_en/Tensor_list.rst new file mode 100644 index 00000000000..b96a220931a --- /dev/null +++ b/docs/api/api_python_en/Tensor_list.rst @@ -0,0 +1,153 @@ +.. role:: hidden + :class: hidden-section + +.. currentmodule:: {{ module }} + +{% if objname in ["AdaSumByDeltaWeightWrapCell", "AdaSumByGradWrapCell", "DistributedGradReducer"] %} +{{ fullname | underline }} + +.. autoclass:: {{ name }} + :exclude-members: infer_value, infer_shape, infer_dtype, construct + :members: + +{% elif fullname=="mindspore.Tensor" %} +{{ fullname | underline }} + +.. autoclass:: {{ name }} + +.. msplatformautosummary:: + :toctree: Tensor + :nosignatures: + + mindspore.Tensor.abs + mindspore.Tensor.addcdiv + mindspore.Tensor.addcmul + mindspore.Tensor.all + mindspore.Tensor.any + mindspore.Tensor.approximate_equal + mindspore.Tensor.argmax + mindspore.Tensor.argmin + mindspore.Tensor.argmin_with_value + mindspore.Tensor.asnumpy + mindspore.Tensor.assign_value + mindspore.Tensor.astype + mindspore.Tensor.atan2 + mindspore.Tensor.bernoulli + mindspore.Tensor.bitwise_and + mindspore.Tensor.bitwise_or + mindspore.Tensor.bitwise_xor + mindspore.Tensor.broadcast_to + mindspore.Tensor.ceil + mindspore.Tensor.choose + mindspore.Tensor.clip + mindspore.Tensor.col2im + mindspore.Tensor.copy + mindspore.Tensor.cosh + mindspore.Tensor.cummax + mindspore.Tensor.cummin + mindspore.Tensor.cumsum + mindspore.Tensor.diag + mindspore.Tensor.diagonal + mindspore.Tensor.dtype + mindspore.Tensor.erf + mindspore.Tensor.erfc + mindspore.Tensor.expand_as + mindspore.Tensor.expand_dims + mindspore.Tensor.fill + mindspore.Tensor.fills + mindspore.Tensor.flatten + mindspore.Tensor.flush_from_cache + mindspore.Tensor.from_numpy + mindspore.Tensor.gather + mindspore.Tensor.gather_elements + mindspore.Tensor.gather_nd + mindspore.Tensor.ger + mindspore.Tensor.hardshrink + mindspore.Tensor.has_init + mindspore.Tensor.index_fill + mindspore.Tensor.init_data + mindspore.Tensor.inplace_update + mindspore.Tensor.inv + mindspore.Tensor.invert + mindspore.Tensor.isclose + mindspore.Tensor.item + mindspore.Tensor.itemset + mindspore.Tensor.itemsize + mindspore.Tensor.lerp + mindspore.Tensor.log1p + mindspore.Tensor.log_matrix_determinant + mindspore.Tensor.logit + mindspore.Tensor.masked_fill + mindspore.Tensor.masked_select + mindspore.Tensor.matrix_determinant + mindspore.Tensor.max + mindspore.Tensor.mean + mindspore.Tensor.min + mindspore.Tensor.narrow + mindspore.Tensor.nbytes + mindspore.Tensor.ndim + mindspore.Tensor.nonzero + mindspore.Tensor.norm + mindspore.Tensor.pow + mindspore.Tensor.prod + mindspore.Tensor.ptp + mindspore.Tensor.random_categorical + mindspore.Tensor.ravel + mindspore.Tensor.renorm + mindspore.Tensor.repeat + mindspore.Tensor.reshape + mindspore.Tensor.resize + mindspore.Tensor.round + mindspore.Tensor.scatter_add + mindspore.Tensor.scatter_div + mindspore.Tensor.scatter_max + mindspore.Tensor.scatter_min + mindspore.Tensor.scatter_mul + mindspore.Tensor.scatter_sub + mindspore.Tensor.searchsorted + mindspore.Tensor.select + mindspore.Tensor.shape + mindspore.Tensor.size + mindspore.Tensor.soft_shrink + mindspore.Tensor.split + mindspore.Tensor.squeeze + mindspore.Tensor.std + mindspore.Tensor.strides + mindspore.Tensor.sum + mindspore.Tensor.svd + mindspore.Tensor.swapaxes + mindspore.Tensor.T + mindspore.Tensor.take + mindspore.Tensor.tan + mindspore.Tensor.top_k + mindspore.Tensor.to_coo + mindspore.Tensor.to_csr + mindspore.Tensor.to_tensor + mindspore.Tensor.trace + mindspore.Tensor.transpose + mindspore.Tensor.unique_consecutive + mindspore.Tensor.unique_with_pad + mindspore.Tensor.unsorted_segment_max + mindspore.Tensor.unsorted_segment_min + mindspore.Tensor.unsorted_segment_prod + mindspore.Tensor.var + mindspore.Tensor.view + mindspore.Tensor.xdivy + mindspore.Tensor.xlogy + +{% elif objname[0].istitle() %} +{{ fullname | underline }} + +.. autoclass:: {{ name }} + :exclude-members: infer_value, infer_shape, infer_dtype + :members: + +{% else %} +{{ fullname | underline }} + +.. autofunction:: {{ fullname }} +{% endif %} + +.. + autogenerated from _templates/classtemplate.rst + note it does not have :inherited-members: