Skip to content

Commit f77eadc

Browse files
committed
add SigmoidTransform,SoftmaxTransform,StackTransform,StickBreakingTransform,TanhTransform chinese documents
1 parent 420495c commit f77eadc

File tree

5 files changed

+531
-0
lines changed

5 files changed

+531
-0
lines changed
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
.. _cn_api_paddle_distribution_SigmoidTransform:
2+
3+
SigmoidTransform
4+
-------------------------------
5+
6+
.. py:class:: paddle.distribution.SigmoidTransform
7+
8+
Sigmoid变换 :math:`y = \frac{1}{1 + \exp(-x)}` , :math:`x = \text{logit}(y)`
9+
10+
11+
代码示例
12+
:::::::::
13+
14+
COPY-FROM: paddle.distribution.SigmoidTransform
15+
16+
方法
17+
:::::::::
18+
19+
forward(x)
20+
'''''''''
21+
22+
计算正变换 :math:`y=f(x)` 的结果。
23+
24+
**参数**
25+
26+
- **x** (Tensor) - 正变换输入参数,通常为 :ref:`cn_api_distribution_Distribution`
27+
的随机采样结果。
28+
29+
**返回**
30+
31+
- **y** (Tensor) - 正变换的计算结果。
32+
33+
34+
inverse(y)
35+
'''''''''
36+
37+
计算逆变换 :math:`x = f^{-1}(y)`
38+
39+
**参数**
40+
41+
- **y** (Tensor) - 逆变换的输入参数。
42+
43+
**返回**
44+
45+
- **x** (Tensor) - 逆变换的计算结果。
46+
47+
forward_log_det_jacobian(x)
48+
'''''''''
49+
50+
计算正变换雅可比行列式绝对值的对数。
51+
52+
如果变换不是一一映射,则雅可比矩阵不存在,返回 ``NotImplementedError`` .
53+
54+
**参数**
55+
56+
- **x** (Tensor) - 输入参数。
57+
58+
**返回**
59+
60+
- Tensor - 正变换雅可比行列式绝对值的对数。
61+
62+
63+
inverse_log_det_jacobian(y)
64+
'''''''''
65+
66+
计算逆变换雅可比行列式绝对值的对数。
67+
68+
与 ``forward_log_det_jacobian`` 互为负数。
69+
70+
**参数**
71+
72+
- **y** (Tensor) - 输入参数。
73+
74+
**返回**
75+
76+
- Tensor - 逆变换雅可比行列式绝对值的对数。
77+
78+
79+
forward_shape(shape)
80+
'''''''''
81+
82+
推断正变换输出形状。
83+
84+
**参数**
85+
86+
- **shape** (Sequence[int]) - 正变换输入的形状。
87+
88+
**返回**
89+
90+
- Sequence[int] - 正变换输出的形状。
91+
92+
93+
inverse_shape(shape)
94+
'''''''''
95+
96+
推断逆变换输出形状。
97+
98+
**参数**
99+
100+
- **shape** (Sequence[int]) - 逆变换输入的形状。
101+
102+
**返回**
103+
104+
- Sequence[int] - 逆变换输出的形状。
105+
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
.. _cn_api_paddle_distribution_SoftmaxTransform:
2+
3+
SoftmaxTransform
4+
-------------------------------
5+
6+
.. py:class:: paddle.distribution.SoftmaxTransform
7+
8+
Softmax变换,首先进行 :math:`y = exp(x)` 变换, 然后归一化。
9+
10+
Softmax变换主要用途是将一个无约束空间变换为单纯形。Softmax不是双射函数,
11+
所以 ``forward_log_det_jacobian`` 、 ``inverse_log_det_jacobian`` 未实现。
12+
13+
代码示例
14+
:::::::::
15+
16+
COPY-FROM: paddle.distribution.SoftmaxTransform
17+
18+
方法
19+
:::::::::
20+
21+
forward(x)
22+
'''''''''
23+
24+
计算正变换 :math:`y=f(x)` 的结果。
25+
26+
**参数**
27+
28+
- **x** (Tensor) - 正变换输入参数,通常为 :ref:`cn_api_distribution_Distribution`
29+
的随机采样结果。
30+
31+
**返回**
32+
33+
- **y** (Tensor) - 正变换的计算结果。
34+
35+
36+
inverse(y)
37+
'''''''''
38+
39+
计算逆变换 :math:`x = f^{-1}(y)`
40+
41+
**参数**
42+
43+
- **y** (Tensor) - 逆变换的输入参数。
44+
45+
**返回**
46+
47+
- **x** (Tensor) - 逆变换的计算结果。
48+
49+
forward_log_det_jacobian(x)
50+
'''''''''
51+
52+
计算正变换雅可比行列式绝对值的对数。
53+
54+
如果变换不是一一映射,则雅可比矩阵不存在,返回 ``NotImplementedError`` .
55+
56+
**参数**
57+
58+
- **x** (Tensor) - 输入参数。
59+
60+
**返回**
61+
62+
- Tensor - 正变换雅可比行列式绝对值的对数。
63+
64+
65+
inverse_log_det_jacobian(y)
66+
'''''''''
67+
68+
计算逆变换雅可比行列式绝对值的对数。
69+
70+
与 ``forward_log_det_jacobian`` 互为负数。
71+
72+
**参数**
73+
74+
- **y** (Tensor) - 输入参数。
75+
76+
**返回**
77+
78+
- Tensor - 逆变换雅可比行列式绝对值的对数。
79+
80+
81+
forward_shape(shape)
82+
'''''''''
83+
84+
推断正变换输出形状。
85+
86+
**参数**
87+
88+
- **shape** (Sequence[int]) - 正变换输入的形状。
89+
90+
**返回**
91+
92+
- Sequence[int] - 正变换输出的形状。
93+
94+
95+
inverse_shape(shape)
96+
'''''''''
97+
98+
推断逆变换输出形状。
99+
100+
**参数**
101+
102+
- **shape** (Sequence[int]) - 逆变换输入的形状。
103+
104+
**返回**
105+
106+
- Sequence[int] - 逆变换输出的形状。
107+
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
.. _cn_api_paddle_distribution_StackTransform:
2+
3+
StackTransform
4+
-------------------------------
5+
6+
.. py:class:: paddle.distribution.StackTransform(transforms, axis=0)
7+
8+
``StackTransform`` 将一系列变换沿着某个特定轴作用于一个输入Tensor上。
9+
10+
参数
11+
:::::::::
12+
13+
- **transforms** (Sequence[Transform]) - 变换序列。
14+
- **axis** (int) - 待变换的轴。
15+
16+
代码示例
17+
:::::::::
18+
19+
COPY-FROM: paddle.distribution.StackTransform
20+
21+
方法
22+
:::::::::
23+
24+
forward(x)
25+
'''''''''
26+
27+
计算正变换 :math:`y=f(x)` 的结果。
28+
29+
**参数**
30+
31+
- **x** (Tensor) - 正变换输入参数,通常为 :ref:`cn_api_distribution_Distribution`
32+
的随机采样结果。
33+
34+
**返回**
35+
36+
- **y** (Tensor) - 正变换的计算结果。
37+
38+
39+
inverse(y)
40+
'''''''''
41+
42+
计算逆变换 :math:`x = f^{-1}(y)`
43+
44+
**参数**
45+
46+
- **y** (Tensor) - 逆变换的输入参数。
47+
48+
**返回**
49+
50+
- **x** (Tensor) - 逆变换的计算结果。
51+
52+
forward_log_det_jacobian(x)
53+
'''''''''
54+
55+
计算正变换雅可比行列式绝对值的对数。
56+
57+
如果变换不是一一映射,则雅可比矩阵不存在,返回 ``NotImplementedError`` .
58+
59+
**参数**
60+
61+
- **x** (Tensor) - 输入参数。
62+
63+
**返回**
64+
65+
- Tensor - 正变换雅可比行列式绝对值的对数。
66+
67+
68+
inverse_log_det_jacobian(y)
69+
'''''''''
70+
71+
计算逆变换雅可比行列式绝对值的对数。
72+
73+
与 ``forward_log_det_jacobian`` 互为负数。
74+
75+
**参数**
76+
77+
- **y** (Tensor) - 输入参数。
78+
79+
**返回**
80+
81+
- Tensor - 逆变换雅可比行列式绝对值的对数。
82+
83+
84+
forward_shape(shape)
85+
'''''''''
86+
87+
推断正变换输出形状。
88+
89+
**参数**
90+
91+
- **shape** (Sequence[int]) - 正变换输入的形状。
92+
93+
**返回**
94+
95+
- Sequence[int] - 正变换输出的形状。
96+
97+
98+
inverse_shape(shape)
99+
'''''''''
100+
101+
推断逆变换输出形状。
102+
103+
**参数**
104+
105+
- **shape** (Sequence[int]) - 逆变换输入的形状。
106+
107+
**返回**
108+
109+
- Sequence[int] - 逆变换输出的形状。
110+

0 commit comments

Comments
 (0)