!31421 Update prob programming Chinese API doc

Merge pull request !31421 from zichun_ye/prob_doc
This commit is contained in:
i-robot 2022-03-25 01:30:49 +00:00 committed by Gitee
commit 5b72669b15
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
29 changed files with 2614 additions and 94 deletions

View File

@ -60,7 +60,7 @@ mindspore.nn.probability.bijector.Bijector
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: forward_log_jacobian(value, *args, **kwargs)
@ -74,7 +74,7 @@ mindspore.nn.probability.bijector.Bijector
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value, *args, **kwargs)
@ -88,7 +88,7 @@ mindspore.nn.probability.bijector.Bijector
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: inverse_log_jacobian(value, *args, **kwargs)
@ -102,4 +102,4 @@ mindspore.nn.probability.bijector.Bijector
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -24,7 +24,7 @@ mindspore.nn.probability.bijector.Exp
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: forward_log_jacobian(value)
@ -36,7 +36,7 @@ mindspore.nn.probability.bijector.Exp
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
@ -48,7 +48,7 @@ mindspore.nn.probability.bijector.Exp
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: inverse_log_jacobian(value)
@ -60,4 +60,4 @@ mindspore.nn.probability.bijector.Exp
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -25,6 +25,24 @@ mindspore.nn.probability.bijector.GumbelCDF
- **TypeError** - `loc``scale` 中元素的数据类型不为float`loc``scale` 中元素的数据类型不相同。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
@ -35,7 +53,7 @@ mindspore.nn.probability.bijector.GumbelCDF
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
@ -47,7 +65,7 @@ mindspore.nn.probability.bijector.GumbelCDF
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
@ -59,7 +77,7 @@ mindspore.nn.probability.bijector.GumbelCDF
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
@ -71,4 +89,4 @@ mindspore.nn.probability.bijector.GumbelCDF
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -26,7 +26,7 @@ mindspore.nn.probability.bijector.Invert
**返回:**
Tensor, 基础Bijector的输入随机变量的值。
Tensor基础Bijector的输入随机变量的值。
.. py:method:: forward_log_jacobian(x)
@ -38,7 +38,7 @@ mindspore.nn.probability.bijector.Invert
**返回:**
Tensor, 基类逆映射导数的对数值。
Tensor基类逆映射导数的对数值。
.. py:method:: inverse(y)
@ -50,11 +50,11 @@ mindspore.nn.probability.bijector.Invert
**返回:**
Tensor, 基础Bijector的输出随机变量的值。
Tensor基础Bijector的输出随机变量的值。
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(y)
@ -66,5 +66,5 @@ mindspore.nn.probability.bijector.Invert
**返回:**
Tensor, 基类正映射导数的对数值。
Tensor基类正映射导数的对数值。

View File

@ -28,6 +28,15 @@ mindspore.nn.probability.bijector.PowerTransform
- **ValueError** - `power` 中元素小于0或静态未知。
- **TypeError** - `power` 中元素的数据类型不是float。
.. py:method:: power
:property:
返回指数。
**返回:**
TensorBijector的指数。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
@ -38,7 +47,7 @@ mindspore.nn.probability.bijector.PowerTransform
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
@ -50,7 +59,7 @@ mindspore.nn.probability.bijector.PowerTransform
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
@ -62,7 +71,7 @@ mindspore.nn.probability.bijector.PowerTransform
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
@ -74,4 +83,4 @@ mindspore.nn.probability.bijector.PowerTransform
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -24,6 +24,24 @@ mindspore.nn.probability.bijector.ScalarAffine
- **TypeError** - `shift``scale` 中元素的数据类型不为float`shift``scale` 的数据类型不相同。
.. py:method:: loc
:property:
返回映射的位置。
**返回:**
Tensor映射的位置值。
.. py:method:: scale
:property:
返回映射的比例。
**返回:**
Tensor映射的比例值。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
@ -34,7 +52,7 @@ mindspore.nn.probability.bijector.ScalarAffine
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
@ -46,7 +64,7 @@ mindspore.nn.probability.bijector.ScalarAffine
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
@ -58,7 +76,7 @@ mindspore.nn.probability.bijector.ScalarAffine
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
@ -70,4 +88,4 @@ mindspore.nn.probability.bijector.ScalarAffine
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -23,6 +23,15 @@ mindspore.nn.probability.bijector.Softplus
- **TypeError** - sharpness中元素的数据类型不为float。
.. py:method:: scale
:property:
返回映射的锐度因子。
**返回:**
Tensor映射的锐度因子。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
@ -33,7 +42,7 @@ mindspore.nn.probability.bijector.Softplus
**返回:**
Tensor, 输入随机变量的值。
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
@ -45,7 +54,7 @@ mindspore.nn.probability.bijector.Softplus
**返回:**
Tensor, 正映射导数的对数值。
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
@ -57,7 +66,7 @@ mindspore.nn.probability.bijector.Softplus
**返回:**
Tensor, 输出随机变量的值。
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
@ -69,4 +78,4 @@ mindspore.nn.probability.bijector.Softplus
**返回:**
Tensor, 逆映射导数的对数值。
Tensor逆映射导数的对数值。

View File

@ -21,9 +21,188 @@ mindspore.nn.probability.distribution.Bernoulli
- **ValueError** - `probs` 中元素小于0或大于1。
.. py:method:: probs
:property:
返回结果为1的概率。
**返回:**
Tensor, 结果为1的概率。
Tensor结果为1的概率。
.. py:method:: cdf(value, probs1)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs1_b, probs1)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(probs1)
计算熵。
**参数:**
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, probs1)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, probs1)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs1)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs1)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(probs1)
计算期望。
**参数:**
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(probs1)
计算众数。
**参数:**
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, probs1)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, probs1)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs1)
计算标准差。
**参数:**
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs1)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(probs1)
计算方差。
**参数:**
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -28,18 +28,214 @@ mindspore.nn.probability.distribution.Beta
- **ValueError** - `concentration1` 或者 `concentration0` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
返回concentration0也称为 Beta 分布的beta
.. py:method:: concentration0
:property:
返回concentration0也称为 Beta 分布的 beta
**返回:**
Tensor, concentration0 的值。
Tensorconcentration0 的值。
.. py:method:: concentration1
:property:
返回concentration1也称为 Beta 分布的alpha
返回concentration1也称为 Beta 分布的 alpha
**返回:**
Tensor, concentration1 的值。
Tensorconcentration1 的值。
.. py:method:: cdf(value, concentration1, concentration0)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, concentration1_b, concentration0_b, concentration1, concentration0)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(concentration1, concentration0)
计算熵。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, concentration1_b, concentration0_b, concentration1, concentration0)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, concentration1, concentration0)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, concentration1, concentration0)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, concentration1, concentration0)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(concentration1, concentration0)
计算期望。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(concentration1, concentration0)
计算众数。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, concentration1, concentration0)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, concentration1, concentration0)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(concentration1, concentration0)
计算标准差。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, concentration1, concentration0)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(concentration1, concentration0)
计算方差。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -8,7 +8,7 @@ mindspore.nn.probability.distribution.Categorical
**参数:**
- **probs** (Tensor, list, numpy.ndarray) - 事件概率。
- **probs** (Tensorlist, numpy.ndarray) - 事件概率。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mindspore.int32.
- **name** (str) - 分布的名称。默认值Categorical。
@ -21,10 +21,188 @@ mindspore.nn.probability.distribution.Categorical
- **ValueError** - `probs` 的秩为0或者其中所有元素的和不等于1。
.. py:method:: probs
:property:
返回事件发生的概率。
**返回:**
Tensor, 事件发生的概率。
Tensor事件发生的概率。
.. py:method:: cdf(value, probs)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs_b, probs)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(probs)
计算熵。
**参数:**
- **probs_b** (Tensor) - 对比分布的事件发生的概率。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, probs)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, probs)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(probs)
计算期望。
**参数:**
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(probs)
计算众数。
**参数:**
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, probs)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, probs)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs)
计算标准差。
**参数:**
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(probs)
计算方差。
**参数:**
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -36,7 +36,7 @@ mindspore.nn.probability.distribution.Cauchy
**返回:**
Tensor, 分布的位置值。
Tensor分布的位置值。
.. py:method:: scale
:property:
@ -45,4 +45,198 @@ mindspore.nn.probability.distribution.Cauchy
**返回:**
Tensor, 分布的比例值。
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -22,7 +22,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -30,7 +30,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 累积分布函数的值。
Tensor累积分布函数的值。
.. py:method:: construct(name, *args, **kwargs)
@ -48,7 +48,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, name对应函数的值。
Tensorname对应函数的值。
.. py:method:: cross_entropy(dist, *args, **kwargs)
@ -57,7 +57,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **dist** (str) - 分布的类型。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -65,7 +65,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 交叉熵的值。
Tensor交叉熵的值。
.. py:method:: entropy(*args, **kwargs)
@ -73,7 +73,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -81,7 +81,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 熵的值。
Tensor熵的值。
.. py:method:: get_dist_args(*args, **kwargs)
@ -89,7 +89,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -114,7 +114,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **dist** (str) - 分布的类型。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -122,7 +122,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, KL散度。
TensorKL散度。
.. py:method:: log_cdf(value, *args, **kwargs)
@ -131,7 +131,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -139,7 +139,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 累积分布函数的对数。
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, *args, **kwargs)
@ -148,7 +148,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -156,7 +156,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 累积分布函数的对数。
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, *args, **kwargs)
@ -165,7 +165,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -173,7 +173,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 生存函数的对数。
Tensor生存函数的对数。
.. py:method:: mean(*args, **kwargs)
@ -181,7 +181,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -189,7 +189,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 概率分布的期望。
Tensor概率分布的期望。
.. py:method:: mode(*args, **kwargs)
@ -197,7 +197,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -205,7 +205,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 概率分布的众数。
Tensor概率分布的众数。
.. py:method:: prob(value, *args, **kwargs)
@ -214,7 +214,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -222,7 +222,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 概率值。
Tensor概率值。
.. py:method:: sample(*args, **kwargs)
@ -231,7 +231,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **shape** (tuple) - 样本的shape。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -239,7 +239,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 根据概率分布采样的样本。
Tensor根据概率分布采样的样本。
.. py:method:: sd(*args, **kwargs)
@ -247,7 +247,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -255,7 +255,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 概率分布的标准差。
Tensor概率分布的标准差。
.. py:method:: survival_function(value, *args, **kwargs)
@ -264,7 +264,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -272,7 +272,7 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 生存函数的值。
Tensor生存函数的值。
.. py:method:: var(*args, **kwargs)
@ -280,7 +280,7 @@ mindspore.nn.probability.distribution.Distribution
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
@ -288,5 +288,5 @@ mindspore.nn.probability.distribution.Distribution
**返回:**
Tensor, 概率分布的方差。
Tensor概率分布的方差。

View File

@ -34,5 +34,182 @@ mindspore.nn.probability.distribution.Exponential
**返回:**
Tensor, rate 的值。
Tensor,率参数的值。
.. py:method:: cdf(value, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, rate_b, rate)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(rate)
计算熵。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, rate_b, rate)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, rate)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, rate)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(rate)
计算期望。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(rate)
计算众数。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, rate)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, rate)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(rate)
计算标准差。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, rate)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(rate)
计算方差。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -35,7 +35,7 @@ mindspore.nn.probability.distribution.Gamma
**返回:**
Tensor, concentration 的值。
Tensorconcentration 的值。
.. py:method:: rate
:property:
@ -44,5 +44,198 @@ mindspore.nn.probability.distribution.Gamma
**返回:**
Tensor, rate 的值。
Tensorrate 的值。
.. py:method:: cdf(value, concentration, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, concentration_b, rate_b, concentration, rate)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **concentration_b** (Tensor) - 对比分布的alpha。
- **rate_b** (Tensor) - 对比分布的beta。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(concentration, rate)
计算熵。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, concentration_b, rate_b, concentration, rate)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **concentration_b** (Tensor) - 对比分布的alpha。
- **rate_b** (Tensor) - 对比分布的beta。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, concentration, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, concentration, rate)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, concentration, rate)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(concentration, rate)
计算期望。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(concentration, rate)
计算众数。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, concentration, rate)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, concentration, rate)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(concentration, rate)
计算标准差。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, concentration, rate)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(concentration, rate)
计算方差。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -30,5 +30,182 @@ mindspore.nn.probability.distribution.Geometric
**返回:**
Tensor, 伯努利试验成功的概率值。
Tensor伯努利试验成功的概率值。
.. py:method:: cdf(value, probs)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs_b, probs)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(probs)
计算熵。
**参数:**
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, probs)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, probs)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(probs)
计算期望。
**参数:**
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(probs)
计算众数。
**参数:**
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, probs)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, probs)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs)
计算标准差。
**参数:**
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(probs)
计算方差。
**参数:**
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -36,7 +36,7 @@ mindspore.nn.probability.distribution.Gumbel
**返回:**
Tensor, 分布的位置值。
Tensor分布的位置值。
.. py:method:: scale
:property:
@ -45,4 +45,198 @@ mindspore.nn.probability.distribution.Gumbel
**返回:**
Tensor, 分布的比例值。
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -36,7 +36,7 @@ mindspore.nn.probability.distribution.LogNormal
**返回:**
Tensor, 分布的位置值。
Tensor分布的位置值。
.. py:method:: scale
:property:
@ -45,4 +45,198 @@ mindspore.nn.probability.distribution.LogNormal
**返回:**
Tensor, 分布的比例值。
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -35,7 +35,7 @@ mindspore.nn.probability.distribution.Logistic
**返回:**
Tensor, 分布的位置值。
Tensor分布的位置值。
.. py:method:: scale
:property:
@ -44,5 +44,198 @@ mindspore.nn.probability.distribution.Logistic
**返回:**
Tensor, 分布的比例值。
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -31,17 +31,186 @@ mindspore.nn.probability.distribution.Normal
.. py:method:: mean
:property:
返回分布位置
返回分布期望
**返回:**
Tensor, 分布的期望。
Tensor分布的期望。
.. py:method:: sd
:property:
返回分布比例
返回分布的标准差
**返回:**
Tensor, 分布的标准差。
Tensor分布的标准差。
.. py:method:: cdf(value, mean, sd)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, mean_b, sd_b, mean, sd)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **mean_b** (Tensor) - 对比分布的期望。
- **sd_b** (Tensor) - 对比分布的标准差。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(mean, sd)
计算熵。
**参数:**
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, mean_b, sd_b, mean, sd)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **mean_b** (Tensor) - 对比分布的期望。
- **sd_b** (Tensor) - 对比分布的标准差。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, mean, sd)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, mean, sd)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, mean, sd)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mode(mean, sd)
计算众数。
**参数:**
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, mean, sd)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, mean, sd)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: survival_function(value, mean, sd)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(mean, sd)
计算方差。
**参数:**
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -33,5 +33,142 @@ mindspore.nn.probability.distribution.Poisson
**返回:**
Tensor, rate 参数的值。
Tensorrate 参数的值。
.. py:method:: cdf(value, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: log_cdf(value, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, rate)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, rate)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(rate)
计算期望。
**参数:**
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(rate)
计算众数。
**参数:**
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, rate)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, rate)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(rate)
计算标准差。
**参数:**
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, rate)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(rate)
计算方差。
**参数:**
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -48,3 +48,95 @@ mindspore.nn.probability.distribution.TransformedDistribution
**返回:**
Bool, 概率映射函数为线性映射则返回True否则返回False。
.. py:method:: cdf(value)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的值。
.. py:method:: log_cdf(value)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean
计算期望。
**返回:**
Tensor概率分布的期望。
.. py:method:: prob(value)
计算给定值下的概率。
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor概率值。
.. py:method:: sample(shape)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: survival_function(value)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor生存函数的值。

View File

@ -36,7 +36,7 @@ mindspore.nn.probability.distribution.Uniform
**返回:**
Tensor, 分布的上限值。
Tensor分布的上限值。
.. py:method:: low
:property:
@ -45,4 +45,198 @@ mindspore.nn.probability.distribution.Uniform
**返回:**
Tensor, 分布的下限值。
Tensor分布的下限值。
.. py:method:: cdf(value, high, low)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, high_b, low_b, high, low)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **high_b** (Tensor) - 对比分布的上限值。
- **low_b** (Tensor) - 对比分布的下限值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor交叉熵的值。
.. py:method:: entropy(high, low)
计算熵。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor熵的值。
.. py:method:: kl_loss(dist, high_b, low_b, high, low)
计算KL散度即KL(a||b)。
**参数:**
- **dist** (str) - 分布的类型。
- **high_b** (Tensor) - 对比分布的上限值。
- **low_b** (Tensor) - 对比分布的下限值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
TensorKL散度。
.. py:method:: log_cdf(value, high, low)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, high, low)
计算给定值对应的概率的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, high, low)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor生存函数的对数。
.. py:method:: mean(high, low)
计算期望。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的期望。
.. py:method:: mode(high, low)
计算众数。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的众数。
.. py:method:: prob(value, high, low)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率值。
.. py:method:: sample(shape, high, low)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
.. py:method:: sd(high, low)
计算标准差。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的标准差。
.. py:method:: survival_function(value, high, low)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor生存函数的值。
.. py:method:: var(high, low)
计算方差。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的方差。

View File

@ -33,7 +33,7 @@ class Exp(PowerTransform):
- **forward**
- **inverse**
- **forward_log_jacobian**
- **backward_log_jacobian**
- **inverse_log_jacobian**
It should be notice that the inputs to the APIs of the Exp bijector should be always a tensor.
For more details of all APIs, including the inputs and outputs of the APIs of the Exp bijector,

View File

@ -38,7 +38,7 @@ class GumbelCDF(Bijector):
- **forward**
- **inverse**
- **forward_log_jacobian**
- **backward_log_jacobian**
- **inverse_log_jacobian**
It should be notice that the inputs of APIs of the Gumbel_cdf bijector should be always a tensor,
with a shape that can be broadcasted to that of `loc` and `scale`.

View File

@ -43,7 +43,7 @@ class PowerTransform(Bijector):
- **forward**
- **inverse**
- **forward_log_jacobian**
- **backward_log_jacobian**
- **inverse_log_jacobian**
It should be notice that the inputs to APIs of the PowerTransform bijector should be always a tensor,
with a shape that can be broadcasted to that of `power`.

View File

@ -39,7 +39,7 @@ class ScalarAffine(Bijector):
- **forward**
- **inverse**
- **forward_log_jacobian**
- **backward_log_jacobian**
- **inverse_log_jacobian**
It should be notice that the inputs to APIs of the Scalar affine bijector should be always a tensor,
with a shape that can be broadcasted to that of `shift` and `scale`.

View File

@ -40,7 +40,7 @@ class Softplus(Bijector):
- **forward**
- **inverse**
- **forward_log_jacobian**
- **backward_log_jacobian**
- **inverse_log_jacobian**
It should be notice that the inputs of APIs of APIs of the Softplus bijector should be always a tensor,
with a shape that can be broadcasted to that of `sharpness`.

View File

@ -382,7 +382,7 @@ class Logistic(Distribution):
l_zero = self.const(self.tiny)
h_one = self.const(1.0)
sample_uniform = self.uniform(sample_shape, l_zero, h_one, self.seed)
sample = self.log(sample_uniform) - self.log1p(sample_uniform)
sample = self.log(sample_uniform) - self.log1p(-sample_uniform) # pylint: disable=invalid-unary-operand-type
sample = sample * scale + loc
value = self.cast(sample, self.dtype)
if origin_shape == ():

View File

@ -41,8 +41,7 @@ class Poisson(Distribution):
The accessible APIs of the Poisson distribution are defined in the base class, including:
- `prob`, `log_prob`, `cdf`, `log_cdf`, `survival_function`, and `log_survival`
- `mean`, `sd`, `mode`, `var`, and `entropy`
- `kl_loss` and `cross_entropy`
- `mean`, `sd`, `mode`, `var`
- `sample`
For more details of all APIs, including the inputs and outputs of all APIs of the Poisson distribution,