From 6bd6b9da2166f777277540ba348fe9eb0c141d1e Mon Sep 17 00:00:00 2001 From: cjh9368 Date: Thu, 4 Aug 2022 17:53:36 +0800 Subject: [PATCH] fix docs problems for ascend dtype in xlogy op --- .../mindspore/Tensor/mindspore.Tensor.xlogy.rst | 5 ++++- docs/api/api_python/ops/mindspore.ops.func_xlogy.rst | 5 ++++- mindspore/python/mindspore/common/tensor.py | 5 ++++- mindspore/python/mindspore/ops/function/math_func.py | 8 +++++--- 4 files changed, 17 insertions(+), 6 deletions(-) diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst index e0a8fde9423..0ab8c0ebba3 100644 --- a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.xlogy.rst @@ -13,6 +13,9 @@ mindspore.Tensor.xlogy `x` 和 `y` 的输入遵循隐式类型转换规则,使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时,它们的数据类型不能同时是bool的,它们的shape可以广播。当输入是一个Tensor和一个Scalar时,Scalar只能是一个常量。 + .. warning:: + - 在Ascend上, `x` 和 `y` 必须为float16或float32。 + 参数: - **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时,则第二个输入是数值型或bool。当第一个输入是Scalar时,则第二个输入必须是数据类型为数值型或bool的Tensor。 @@ -21,5 +24,5 @@ mindspore.Tensor.xlogy 异常: - **TypeError** - 如果 `x` 和 `y` 不是数值型、bool或Tensor。 - - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32或float64。 + - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32、float64、complex64或complex128。 - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_xlogy.rst b/docs/api/api_python/ops/mindspore.ops.func_xlogy.rst index 6d8c8d9d352..01b3e7a5921 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_xlogy.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_xlogy.rst @@ -10,6 +10,9 @@ mindspore.ops.xlogy `x` 和 `y` 的输入遵循隐式类型转换规则,使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时,它们的数据类型不能同时是bool的,它们的shape可以广播。当输入是一个Tensor和一个Scalar时,Scalar只能是一个常量。 + .. warning:: + - 在Ascend上, `x` 和 `y` 必须为float16或float32。 + 参数: - **x** (Union[Tensor, number.Number, bool]) - 第一个输入为数值型。数据类型为 `number `_ 或 `bool_ `_ 。 - **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时,则第二个输入是数值型或bool。当第一个输入是Scalar时,则第二个输入必须是数据类型为数值型或bool的Tensor。 @@ -19,5 +22,5 @@ mindspore.ops.xlogy 异常: - **TypeError** - 如果 `x` 和 `y` 不是数值型、bool或Tensor。 - - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32或float64。 + - **TypeError** - 如果 `x` 和 `y` 的数据类型不是float16、float32、float64、complex64或complex128。 - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 diff --git a/mindspore/python/mindspore/common/tensor.py b/mindspore/python/mindspore/common/tensor.py index 93ebe6b057b..31997cf026f 100644 --- a/mindspore/python/mindspore/common/tensor.py +++ b/mindspore/python/mindspore/common/tensor.py @@ -4600,6 +4600,9 @@ class Tensor(Tensor_): When the inputs are one tensor and one scalar, the scalar could only be a constant. + .. warning:: + - On Ascend, the data type of `x` and `y` must be float16 or float32. + Args: - **y** (Union[Tensor, number.Number, bool]) - The `y` input is a number.Number or a bool or a tensor whose data type is number or bool. @@ -4610,7 +4613,7 @@ class Tensor(Tensor_): Raises: TypeError: If `y` is not a number.Number or a bool or a Tensor. - TypeError: If dtype of `x` and 'y' is not in [float16, float32, float64] . + TypeError: If dtype of `x` and 'y' is not in [float16, float32, float64, complex64, complex128] . ValueError: If `x` could not be broadcast to a tensor with shape of `y`. Supported Platforms: diff --git a/mindspore/python/mindspore/ops/function/math_func.py b/mindspore/python/mindspore/ops/function/math_func.py index afcd0c32212..2a7140f7f0f 100644 --- a/mindspore/python/mindspore/ops/function/math_func.py +++ b/mindspore/python/mindspore/ops/function/math_func.py @@ -1289,6 +1289,9 @@ def xlogy(x, y): When the inputs are one tensor and one scalar, the scalar could only be a constant. + .. warning:: + - On Ascend, the data type of `x` and `y` must be float16 or float32. + Args: - **x** (Union[Tensor, number.Number, bool]) - The first input is a number.Number or a bool or a tensor whose data type is @@ -1304,7 +1307,7 @@ def xlogy(x, y): Raises: TypeError: If `x` and `y` is not a number.Number or a bool or a Tensor. - TypeError: If dtype of `x` and 'y' is not in [float16, float32, float64]. + TypeError: If dtype of `x` and 'y' is not in [float16, float32, float64, complex64, complex128]. ValueError: If `x` could not be broadcast to a tensor with shape of `y`. Supported Platforms: @@ -1313,8 +1316,7 @@ def xlogy(x, y): Examples: >>> x = Tensor(np.array([-5, 0, 4]), mindspore.float32) >>> y = Tensor(np.array([2, 2, 2]), mindspore.float32) - >>> xlogy = ops.Xlogy() - >>> output = xlogy(x, y) + >>> output = ops.xlogy(x, y) >>> print(output) [-3.465736 0. 2.7725887] """