Skip to content

Commit b97a2f7

Browse files
authored
Add doc for paddle.i1 and paddle.i1e document.;test=docs_preview (#5839)
* Add doc for paddle.i1 and paddle.i1e * Fix format error * fix typo
1 parent e5b454c commit b97a2f7

File tree

5 files changed

+74
-1
lines changed

5 files changed

+74
-1
lines changed

docs/api/api_label

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1218,4 +1218,5 @@ paddle.get_cuda_rng_state .. _api_paddle_get_cuda_rng_state:
12181218
paddle.flops .. _api_paddle_flops:
12191219
paddle.load .. _api_paddle_load:
12201220
paddle.vander .. _api_paddle_vander:
1221-
1221+
paddle.i1 .. _api_paddle_tensor_i1:
1222+
paddle.i1e .. _api_paddle_tensor_i1e:

docs/api/paddle/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ tensor 数学操作
147147
" :ref:`paddle.cumulative_trapezoid <cn_api_paddle_tensor_cumulative_trapezoid>` ", "在指定维度上对输入实现 trapezoid rule 算法。使用累积求和函数 cumsum"
148148
" :ref:`paddle.i0 <cn_api_paddle_tensor_i0>` ", "对输入 Tensor 每个元素计算第一类零阶修正贝塞尔函数"
149149
" :ref:`paddle.i0e <cn_api_paddle_tensor_i0e>` ", "对输入 Tensor 每个元素计算第一类指数缩放的零阶修正贝塞尔函数"
150+
" :ref:`paddle.i1 <cn_api_paddle_tensor_i1>` ", "对输入 Tensor 每个元素计算第一类一阶修正贝塞尔函数"
151+
" :ref:`paddle.i1e <cn_api_paddle_tensor_i1e>` ", "对输入 Tensor 每个元素计算第一类指数缩放的一阶修正贝塞尔函数"
150152
.. _tensor_math_inplace:
151153

152154
tensor 数学操作原位(inplace)版本

docs/api/paddle/Tensor_cn.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2564,3 +2564,23 @@ i0e(x, name=None)
25642564
返回类型:Tensor
25652565

25662566
请参考 :ref:`cn_api_paddle_tensor_i0e`
2567+
2568+
i1(x, name=None)
2569+
:::::::::
2570+
用于将输入的 Tensor 计算第一类一阶修正贝塞尔函数。
2571+
2572+
返回:返回第一类一阶修正贝塞尔函数对应输出 Tensor。
2573+
2574+
返回类型:Tensor
2575+
2576+
请参考 :ref:`cn_api_paddle_tensor_i1`
2577+
2578+
i1e(x, name=None)
2579+
:::::::::
2580+
用于将输入的 Tensor 计算第一类指数缩放的一阶修正贝塞尔函数。
2581+
2582+
返回:返回第一类指数缩放的一阶修正贝塞尔函数对应输出 Tensor。
2583+
2584+
返回类型:Tensor
2585+
2586+
请参考 :ref:`cn_api_paddle_tensor_i1e`

docs/api/paddle/i1_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_paddle_tensor_i1:
2+
3+
i1
4+
-------------------------------
5+
6+
.. py:function:: paddle.i1(x, name=None)
7+
对于给定 ``x`` 计算其每个元素的第一类一阶修正贝塞尔曲线函数,其中输入 ``x`` 大小无特殊限制。返回第一类一阶修正贝塞尔函数对应输出 Tensor。
8+
9+
.. math::
10+
I_1(x)=\frac{\left(\text { x }_{i}\right)}{2} * \sum_{k=0}^{\infty} \frac{\left(\text{x}_{i}^{2} / 4\right)^{k}}{(k !) *(k+1) !}
11+
12+
参数
13+
::::::::::
14+
- **x** (Tensor) – 输入是一个多维的 Tensor,它的数据类型可以是 float32,float64。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::
19+
- ``Tensor`` (Tensor):在 x 处的第一类一阶修正贝塞尔曲线函数的值。
20+
21+
22+
代码示例
23+
::::::::::
24+
25+
COPY-FROM: paddle.i1

docs/api/paddle/i1e_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_paddle_tensor_i1e:
2+
3+
i1e
4+
-------------------------------
5+
6+
.. py:function:: paddle.i1e(x, name=None)
7+
对于给定 ``x`` 计算其每个元素的第一类指数缩放的一阶修正贝塞尔曲线函数,其中输入 ``x`` 大小无特殊限制。返回第一类指数缩放的一阶修正贝塞尔函数对应输出 Tensor。
8+
9+
.. math::
10+
I_1e(x)=\exp (-|x|) * i 1(x)=\exp (-|x|) * \frac{\left(\text { input }_{i}\right)}{2} * \sum_{k=0}^{\infty} \frac{\left(\text { input }_{i}^{2} / 4\right)^{k}}{(k !) *(k+1) !}
11+
12+
参数
13+
::::::::::
14+
- **x** (Tensor) – 输入是一个多维的 Tensor,它的数据类型可以是 float32,float64。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::
19+
- ``Tensor`` (Tensor):在 x 处的第一类指数缩放的一阶修正贝塞尔曲线函数的值。
20+
21+
22+
代码示例
23+
::::::::::
24+
25+
COPY-FROM: paddle.i1e

0 commit comments

Comments
 (0)