Skip to content

Commit 4a042c8

Browse files
authored
modify doc to align with the impl code (#789)
1 parent 6dcc49e commit 4a042c8

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

rfcs/APIs/20230914_api_design_for_igamma_and_igammac.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $\gamma(a, x) = \int_0^x t^{a-1} e^{-t} dt $
2424
上不完全伽马函数 $\Gamma(a,x)$ 的定义域为 $a>0$, $x \geq 0$,值域为 $(0,\Gamma(a)]$。
2525
下不完全伽马函数 $\gamma(a,x)$ 的定义域为 $a>0$, $x \geq 0$,值域为 $[0,\Gamma(a))$,其中 $\Gamma(a)$ 是伽马函数的值。
2626

27-
相应的 API 需要输入两个参数 `input``other`,对应上式的 $a$ 和 $x$;
27+
相应的 API 需要输入两个参数 `x``a`,对应上式的 $x$ 和 $a$;
2828

2929
## 3、意义
3030

@@ -364,64 +364,64 @@ XlaOp Igamma(XlaOp a, XlaOp x) {
364364
365365
```python
366366
paddle.igamma(
367-
input: Tensor,
368-
other: Tensor,
367+
x: Tensor,
368+
a: Tensor,
369369
name: str | None = None
370370
)
371371
```
372372

373373
```python
374374
paddle.igammac(
375-
input: Tensor,
376-
other: Tensor,
375+
x: Tensor,
376+
a: Tensor,
377377
name: str | None = None
378378
)
379379
```
380380

381381
```python
382382
paddle.igamma_(
383-
input: Tensor,
384-
other: Tensor,
383+
x: Tensor,
384+
a: Tensor,
385385
name: str | None = None
386386
)
387387
```
388388

389389
```python
390390
paddle.igammac_(
391-
input: Tensor,
392-
other: Tensor,
391+
x: Tensor,
392+
a: Tensor,
393393
name: str | None = None
394394
)
395395
```
396396

397397
```python
398398
paddle.Tensor.igamma(
399-
other: Tensor
399+
a: Tensor
400400
)
401401
```
402402

403403
```python
404404
paddle.Tensor.igammac(
405-
other: Tensor
405+
a: Tensor
406406
)
407407
```
408408

409409
```python
410410
paddle.Tensor.igamma_(
411-
other: Tensor
411+
a: Tensor
412412
)
413413
```
414414

415415
```python
416416
paddle.Tensor.igammac_(
417-
other: Tensor
417+
a: Tensor
418418
)
419419
```
420420

421421
## 底层OP设计
422422
Kernel部分CPU实现添加在 `paddle/phi/kernels/cpu/igamma_kernel.cc``paddle/phi/kernels/cpu/igammac_kernel.cc`
423423
Kernel部分GPU实现添加在 `paddle/phi/kernels/gpu/igamma_kernel.cu``paddle/phi/kernels/gpu/igammac_kernel.cu`
424-
输入 CPU 支持 float16, bfloat16, float32, float64,GPU支持 float32, float64,
424+
输入支持 float32, float64,
425425
对于底层 OP 主要分为三部分,由于 `igamma``igammac`是互补关系,所以实际上可复用代码很多,
426426
因此底层OP设计仅以`igammac`为例。
427427

@@ -444,10 +444,10 @@ $\Gamma(a, x) = \int_x^{\infty} t^{a-1} e^{-t} dt $
444444
### igamma
445445
对于 igamma 、 igamma_ 、igammac 和 igammac_ 有类似的API,下面列出了`igamma`的情况。
446446

447-
具体的API为`paddle.igamma(input, other, name = None)``paddle.Tensor.igamma(input, other)`
447+
具体的API为`paddle.igamma(x, a, name = None)``paddle.Tensor.igamma(x, a)`
448448

449-
- input: 输入张量,即公式中的 $a$, CPU 支持 float16, bfloat16, float32, float64,GPU支持 float32, float64
450-
- other: 输入张量,即公式中的 $x$, CPU 支持 float16, bfloat16, float32, float64,GPU支持 float32, float64
449+
- x: 输入张量,即公式中的 $x$, 支持 float32, float64
450+
- a: 输入张量,即公式中的 $a$, 支持 float32, float64
451451

452452

453453
例如将一维张量 $[3, 5]$ 和一维张量 $[2, 7]$ 输入,则计算结果如下:
@@ -460,7 +460,7 @@ $\Gamma(a, x) = [\int_2^{\infty} t^{2} e^{-t} dt, \int_7^{\infty} t^{4} e^{-t} d
460460
测试需要考虑的 case 如下:
461461

462462
- 输出数值结果的一致性和数据类型是否正确,使用 scipy 作为参考标准
463-
- 对不同 dtype 的输入数据 `input``other` 进行计算精度检验,与PyTorch保持一致
463+
- 对不同 dtype 的输入数据 `x``a` 进行计算精度检验,与PyTorch保持一致
464464
- 输入输出的容错性与错误提示信息
465465
- 输出 Dtype 错误或不兼容时抛出异常
466466
- 保证调用属性时是可以被正常找到的

0 commit comments

Comments
 (0)