mindspore.nn.probability.distribution.HalfNormal

class mindspore.nn.probability.distribution.HalfNormal(mean=None, sd=None, seed=None, dtype=mstype.float32, name='HalfNormal')

半正态分布（HalfNormal distribution）。 连续随机分布，取值范围为 \([\mu, \inf)\) ，概率密度函数为

\[f(x, \mu, \sigma) = 1 / \sigma\sqrt{2\pi} \exp(-(x - \mu)^2 / 2\sigma^2).\]

其中 \(\mu, \sigma\) 为分别为半正态分布的期望与标准差。

参数：

• mean (Union[int, float, list, numpy.ndarray, Tensor], 可选) - 半正态分布的平均值。 如果输入为None，那么分布的平均值将在运行时传入。默认值： None 。

• sd (Union[int, float, list, numpy.ndarray, Tensor], 可选) - 半正态分布的标准差。 如果输入为None，那么分布的标准差将在运行时传入。默认值： None 。

• seed (int, 可选) - 采样时使用的种子。如果为None，则使用全局种子。默认值： None 。

• dtype (mindspore.dtype, 可选) - 事件样例的类型。默认值： mstype.float32 。

• name (str, 可选) - 分布的名称。默认值： 'HalfNormal' 。

说明

• sd 必须大于0。

• dtype 必须是float，因为半正态分布是连续的。

• 如果在方法函数调用中传入参数 mean 或者 sd ，则计算中会使用传参值，否则就会使用初始化时的参数值。

异常：

• ValueError - sd 中元素不大于0。

• TypeError - dtype 不是float的子类。

支持平台：

CPU

样例：

>>> import mindspore
>>> import mindspore.nn as nn
>>> from mindspore.nn.probability.distribution import HalfNormal
>>> from mindspore import Tensor
>>> # To initialize a HalfNormal distribution of the mean 3.0 and the standard deviation 4.0.
>>> n1 = HalfNormal(3.0, 4.0, dtype=mindspore.float32)
>>> # A HalfNormal distribution can be initialized without arguments.
>>> # In this case, `mean` and `sd` must be passed in through arguments.
>>> hn = HalfNormal(dtype=mindspore.float32)
>>> # Here are some tensors used below for testing
>>> value = Tensor([1.0, 2.0, 3.0], dtype=mindspore.float32)
>>> mean_a = Tensor([2.0], dtype=mindspore.float32)
>>> sd_a = Tensor([2.0, 2.0, 2.0], dtype=mindspore.float32)
>>> mean_b = Tensor([1.0], dtype=mindspore.float32)
>>> sd_b = Tensor([1.0, 1.5, 2.5], dtype=mindspore.float32)
>>> ans = n1.log_prob(value)
>>> print(ans.shape)
(3,)
>>> # Evaluate with respect to the distribution b.
>>> ans = n1.log_prob(value, mean_b, sd_b)
>>> print(ans.shape)
(3,)
>>> # `mean` and `sd` must be passed in during function calls
>>> ans = hn.log_prob(value, mean_a, sd_a)
>>> print(ans.shape)
(3,)

log_prob(value, mean=None, sd=None)

计算半正态分布给定值对应的概率的对数。

参数：

• value (Tensor) - 要计算的值。

• mean (Tensor, 可选) - 分布的期望。默认值： None 。

• sd (Tensor, 可选) - 分布的标准差。默认值： None 。

返回：

Tensor，概率密度函数的对数。