forked from huawei/mindspore2022
49 lines
1.5 KiB
ReStructuredText
49 lines
1.5 KiB
ReStructuredText
mindspore.nn.probability.distribution.Cauchy
|
||
================================================
|
||
|
||
.. py:class:: mindspore.nn.probability.distribution.Cauchy(loc=None, scale=None, seed=None, dtype=mstype.float32, name='Cauchy')
|
||
|
||
柯西分布（Cauchy distribution）。
|
||
连续随机分布，取值范围为所有实数，概率密度函数为
|
||
|
||
.. math::
|
||
f(x, a, b) = 1 / \pi b(1 - ((x - a)/b)^2).
|
||
|
||
其中 :math:`a, b` 为分别为柯西分布的位置参数和比例参数。
|
||
|
||
**参数：**
|
||
|
||
- **loc** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的位置。
|
||
- **scale** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的比例。
|
||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值：mindspore.float32。
|
||
- **name** (str) - 分布的名称。默认值：'Cauchy'。
|
||
|
||
.. note::
|
||
- `scale` 中的元素必须大于零。
|
||
- `dtype` 必须是float，因为柯西分布是连续的。
|
||
- GPU后端不支持柯西分布。
|
||
|
||
**异常：**
|
||
|
||
- **ValueError** - `scale` 中元素小于0。
|
||
- **TypeError** - `dtype` 不是float的子类。
|
||
|
||
.. py:method:: loc
|
||
:property:
|
||
|
||
返回分布位置。
|
||
|
||
**返回：**
|
||
|
||
Tensor, 分布的位置值。
|
||
|
||
.. py:method:: scale
|
||
:property:
|
||
|
||
返回分布比例。
|
||
|
||
**返回：**
|
||
|
||
Tensor, 分布的比例值。
|