Skip to content

Commit

Permalink
PaddlePaddle Hackathon 第四期】No.1:为 Paddle 新增 finfo API (#5660)
Browse files Browse the repository at this point in the history
  • Loading branch information
lisamhy authored Mar 7, 2023
1 parent b83b33f commit ba9a54f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ tensor 属性相关
:widths: 10, 30

" :ref:`paddle.iinfo <cn_api_iinfo>` ", "返回一个 iinfo 对象,该对象包含了输入的整数类 paddle.dtype 的各种相关的数值信息"
" :ref:`paddle.finfo <cn_api_finfo>` ", "返回一个 finfo 对象,该对象包含了输入的整数类 paddle.dtype 的各种相关的数值信息"
" :ref:`paddle.imag <cn_api_tensor_imag>` ", "返回一个包含输入复数 Tensor 的虚部数值的新 Tensor"
" :ref:`paddle.real <cn_api_tensor_real>` ", "返回一个包含输入复数 Tensor 的实部数值的新 Tensor"
" :ref:`paddle.shape <cn_api_fluid_layers_shape>` ", "获得输入 Tensor 或 SelectedRows 的 shape"
Expand Down
36 changes: 36 additions & 0 deletions docs/api/paddle/finfo_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _cn_api_finfo:

finfo
-------------------------------

.. py:function:: paddle.finfo(dtype)
返回一个 ``finfo`` 对象,该对象包含了输入 ``dtype`` 的各种相关的数值信息。其中输入 ``dtype`` 只能是整数类型的 ``paddle.dtype`` 。

其功能类似 `numpy.finfo <https://numpy.org/doc/stable/reference/generated/numpy.finfo.html#numpy-finfo>`_ 。


参数
:::::::::
- **dtype** (paddle.dtype) - 输入的数据类型,只能为:paddle.float16、 paddle.float32、 paddle.float64、 paddle.bfloat16、 paddle.complex64 和 paddle.complex128 。

返回
:::::::::
一个 ``finfo`` 对象,其中包含 8 个属性,如下所示:

- **min** (double) - 该数据类型所能表示的最小的数。
- **max** (double) - 该数据类型所能表示的最大的数。
- **eps** (double) - 该数据类型所能表示的最小数,使得 1.0 + eps ≠ 1.0 。
- **resolution** (double) - 这种类型的近似小数分辨率。
- **smallest_normal** (double) - 这种类型的最小的正 normal 数。
- **tiny** (double) - 这种类型的最小的正 normal 数,和 smallest_normal 相同。
- **bits** (int) - 该数据类型所占据的 bit 位数。
- **dtype** (str) - 该数据类型的字符串名称。


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

COPY-FROM: paddle.finfo

0 comments on commit ba9a54f

Please sign in to comment.