fix docs problems for ascend dtype in xlogy op

This commit is contained in:
cjh9368 2022-08-04 17:53:36 +08:00
parent 6685a89540
commit 6bd6b9da21
4 changed files with 17 additions and 6 deletions

View File

@ -13,6 +13,9 @@ mindspore.Tensor.xlogy
`x``y` 的输入遵循隐式类型转换规则使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时它们的数据类型不能同时是bool的它们的shape可以广播。当输入是一个Tensor和一个Scalar时Scalar只能是一个常量。 `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。 - **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` 不是数值型、bool或Tensor。
- **TypeError** - 如果 `x``y` 的数据类型不是float16、float32或float64 - **TypeError** - 如果 `x``y` 的数据类型不是float16、float32、float64、complex64或complex128
- **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。

View File

@ -10,6 +10,9 @@ mindspore.ops.xlogy
`x``y` 的输入遵循隐式类型转换规则使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时它们的数据类型不能同时是bool的它们的shape可以广播。当输入是一个Tensor和一个Scalar时Scalar只能是一个常量。 `x``y` 的输入遵循隐式类型转换规则使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时它们的数据类型不能同时是bool的它们的shape可以广播。当输入是一个Tensor和一个Scalar时Scalar只能是一个常量。
.. warning::
- 在Ascend上 `x``y` 必须为float16或float32。
参数: 参数:
- **x** (Union[Tensor, number.Number, bool]) - 第一个输入为数值型。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_ - **x** (Union[Tensor, number.Number, bool]) - 第一个输入为数值型。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_
- **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时则第二个输入是数值型或bool。当第一个输入是Scalar时则第二个输入必须是数据类型为数值型或bool的Tensor。 - **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` 不是数值型、bool或Tensor。
- **TypeError** - 如果 `x``y` 的数据类型不是float16、float32或float64 - **TypeError** - 如果 `x``y` 的数据类型不是float16、float32、float64、complex64或complex128
- **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。 - **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。

View File

@ -4600,6 +4600,9 @@ class Tensor(Tensor_):
When the inputs are one tensor and one scalar, When the inputs are one tensor and one scalar,
the scalar could only be a constant. the scalar could only be a constant.
.. warning::
- On Ascend, the data type of `x` and `y` must be float16 or float32.
Args: Args:
- **y** (Union[Tensor, number.Number, bool]) - The `y` input is a number.Number or - **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. a bool or a tensor whose data type is number or bool.
@ -4610,7 +4613,7 @@ class Tensor(Tensor_):
Raises: Raises:
TypeError: If `y` is not a number.Number or a bool or a Tensor. 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`. ValueError: If `x` could not be broadcast to a tensor with shape of `y`.
Supported Platforms: Supported Platforms:

View File

@ -1289,6 +1289,9 @@ def xlogy(x, y):
When the inputs are one tensor and one scalar, When the inputs are one tensor and one scalar,
the scalar could only be a constant. the scalar could only be a constant.
.. warning::
- On Ascend, the data type of `x` and `y` must be float16 or float32.
Args: Args:
- **x** (Union[Tensor, number.Number, bool]) - The first input is a number.Number or - **x** (Union[Tensor, number.Number, bool]) - The first input is a number.Number or
a bool or a tensor whose data type is a bool or a tensor whose data type is
@ -1304,7 +1307,7 @@ def xlogy(x, y):
Raises: Raises:
TypeError: If `x` and `y` is not a number.Number or a bool or a Tensor. 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`. ValueError: If `x` could not be broadcast to a tensor with shape of `y`.
Supported Platforms: Supported Platforms:
@ -1313,8 +1316,7 @@ def xlogy(x, y):
Examples: Examples:
>>> x = Tensor(np.array([-5, 0, 4]), mindspore.float32) >>> x = Tensor(np.array([-5, 0, 4]), mindspore.float32)
>>> y = Tensor(np.array([2, 2, 2]), mindspore.float32) >>> y = Tensor(np.array([2, 2, 2]), mindspore.float32)
>>> xlogy = ops.Xlogy() >>> output = ops.xlogy(x, y)
>>> output = xlogy(x, y)
>>> print(output) >>> print(output)
[-3.465736 0. 2.7725887] [-3.465736 0. 2.7725887]
""" """