Skip to content

Commit

Permalink
add doc for as_complex, as_real (PaddlePaddle#4126)
Browse files Browse the repository at this point in the history
* add doc for view_as_complex, view_as_real

* rename api

* fix typos, add to index

* add more details in doc of as_real
  • Loading branch information
Feiyu Chan authored Dec 24, 2021
1 parent 83d23e1 commit f54db24
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,8 @@ tensor元素操作相关(如:转置,reshape等)
" :ref:`paddle.unsqueeze <cn_api_paddle_tensor_unsqueeze>` ", "该OP向输入Tensor的Shape中一个或多个位置(axis)插入尺寸为1的维度"
" :ref:`paddle.unsqueeze_ <cn_api_paddle_tensor_unsqueeze_>` ", "Inplace 版本的 unsqueeze API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.unstack <cn_api_fluid_layers_unstack>` ", "该OP将单个dim为 D 的Tensor沿 axis 轴unpack为 num 个dim为 (D-1) 的Tensor"
" :ref:`paddle.as_complex <cn_api_paddle_as_complex>` ", "将实数 Tensor 转为复数 Tensor"
" :ref:`paddle.as_real <cn_api_paddle_as_real>` ", "将复数 Tensor 转为实数 Tensor"
" :ref:`paddle.repeat_interleave <cn_api_tensor_repeat_interleave>` ", "沿 axis 轴对输入 x 的元素进行复制"

.. einsum:
Expand Down
2 changes: 2 additions & 0 deletions docs/api/paddle/Tensor/Overview_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Methods
argmax
argmin
argsort
as_complex
as_real
asin
astype
atan
Expand Down
27 changes: 27 additions & 0 deletions docs/api/paddle/as_complex_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _cn_api_paddle_as_complex:

as_complex
-------------------------------

.. py:function:: paddle.as_complex(x, name=None)
将实数 Tensor 转为复数 Tensor.

输入 Tensor 的数据类型是 'float32' 或者 'float64',输出 Tensor 的数据类型相应为 'complex64' 或者 'complex128'.

输入 Tensor 的形状是 ``(*, 2)`` (其中 ``*`` 表示任意形状),亦即,输入的最后一维的大小必须是 2, 这对应着复数的实部和虚部。输出 Tensor 的形状是 ``(*,)``.

参数
:::::::::
- x (Tensor) - 输入 Tensor,数据类型为:float32 或 float64。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。

返回
:::::::::
输出 Tensor,数据类型是 'complex64' 或 'complex128', 与 ``x`` 的数值精度一致。

代码示例
:::::::::

COPY-FROM: paddle.as_complex
27 changes: 27 additions & 0 deletions docs/api/paddle/as_real_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _cn_api_paddle_as_real:

as_real
-------------------------------

.. py:function:: paddle.as_real(x, name=None)
将复数 Tensor 转为实数 Tensor.

输入 Tensor 的数据类型是 'complex64' 或者 'complex128',输出 Tensor 的数据类型相应为 'float32' 或者 'float64'.

输入 Tensor 的形状是 ``(*,)`` (其中 ``*`` 表示任意形状),输出 Tensor 的形状是 ``(*, 2)``,亦即,输出的形状是在输入形状后附加一个 ``2``,因为一个复数的实部和虚部分别表示为一个实数。

参数
:::::::::
- x (Tensor) - 输入 Tensor,数据类型为:'complex64' 或 'complex128'。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。

返回
:::::::::
输出 Tensor,数据类型是 'float32' 或 'float64', 与 ``x`` 的数值精度一致。

代码示例
:::::::::

COPY-FROM: paddle.as_real

0 comments on commit f54db24

Please sign in to comment.