!45542 [MS][DOC]add some primitive doc
Merge pull request !45542 from mengyuanli/code_docs_export_primitive
This commit is contained in:
commit
8622779fae
|
@ -227,6 +227,7 @@ MindSpore中 `mindspore.ops` 接口与上一版本相比,新增、删除和支
|
|||
mindspore.ops.BesselK1e
|
||||
mindspore.ops.BesselY0
|
||||
mindspore.ops.BesselY1
|
||||
mindspore.ops.Betainc
|
||||
mindspore.ops.Bincount
|
||||
mindspore.ops.Bucketize
|
||||
mindspore.ops.Cauchy
|
||||
|
|
|
@ -0,0 +1,33 @@
|
|||
mindspore.ops.Betainc
|
||||
=====================
|
||||
|
||||
.. py:class:: mindspore.ops.Betainc
|
||||
|
||||
计算正则化不完全beta积分 :math:`I_{x}(a, b)`。
|
||||
|
||||
正则化的不完全beta积分定义为:
|
||||
|
||||
.. math::
|
||||
|
||||
I_{x}(a, b)=\frac{B(x ; a, b)}{B(a, b)}
|
||||
|
||||
其中
|
||||
|
||||
.. math::
|
||||
|
||||
B(x ; a, b)=\int_{0}^{x} t^{a-1}(1-t)^{b-1} d t
|
||||
|
||||
是不完全的 beta 函数, :math:`B(a, b)` 是完整的beta函数。
|
||||
|
||||
输入:
|
||||
- **a** (Tensor) - float32或者float64类型的Tensor。
|
||||
- **b** (Tensor) - 必须具有与 `a` 相同的dtype和shape的Tensor。
|
||||
- **x** (Tensor) - 必须具有与 `a` 相同的dtype和shape的Tensor。
|
||||
|
||||
输出:
|
||||
Tensor,具有与 `a` 相同的shape和dtype。
|
||||
|
||||
异常:
|
||||
- **TypeError** - 如果 `a` 的dtype不是float32或float64。
|
||||
- **TypeError** - 如果 `b` 和 `x` 其中之一的dtype不是和 `a` 的dtype一致。
|
||||
- **ValueError** - 如果 `b` 和 `x` 其中之一的shape不是和 `a` 的shape一致。
|
|
@ -227,6 +227,7 @@ Mathematical Operators
|
|||
mindspore.ops.BesselK1e
|
||||
mindspore.ops.BesselY0
|
||||
mindspore.ops.BesselY1
|
||||
mindspore.ops.Betainc
|
||||
mindspore.ops.Bincount
|
||||
mindspore.ops.Bucketize
|
||||
mindspore.ops.Cauchy
|
||||
|
|
|
@ -1578,11 +1578,11 @@ class Betainc(Primitive):
|
|||
|
||||
Inputs:
|
||||
- **a** (Tensor) - A Tensor of types: float32, float64.
|
||||
- **b** (Tensor) - A Tensor, must have the same dtype and shape as a.
|
||||
- **x** (Tensor) - A Tensor, must have the same dtype and shape as a.
|
||||
- **b** (Tensor) - A Tensor, must have the same dtype and shape as `a` .
|
||||
- **x** (Tensor) - A Tensor, must have the same dtype and shape as `a` .
|
||||
|
||||
Outputs:
|
||||
A Tensor, has the same dtype and shape as a.
|
||||
A Tensor, has the same dtype and shape as `a` .
|
||||
|
||||
Raises:
|
||||
TypeError: If dtype of `a` is not float32 nor float64.
|
||||
|
|
Loading…
Reference in New Issue