forked from mindspore-Ecosystem/mindspore
!42653 modify the inconsistence of files 0922
Merge pull request !42653 from 宦晓玲/code_docs_0922
This commit is contained in:
commit
5113939d8f
|
@ -3,11 +3,13 @@ mindspore.dataset.vision.AdjustGamma
|
|||
|
||||
.. py:class:: mindspore.dataset.vision.AdjustGamma(gamma, gain=1)
|
||||
|
||||
对输入图像应用伽马校正。更多详细信息,请参见 `Gamma矫正 <https://en.wikipedia.org/wiki/Gamma_correction>`_ 。
|
||||
对输入图像应用伽马校正。输入图片shape应该为 [..., H, W, C]或[H, W]。
|
||||
|
||||
.. math::
|
||||
I_{\text{out}} = 255 \times \text{gain} \times \left(\frac{I_{\text{in}}}{255}\right)^{\gamma}
|
||||
|
||||
更多详细信息,请参见 `Gamma矫正 <https://en.wikipedia.org/wiki/Gamma_correction>`_ 。
|
||||
|
||||
参数:
|
||||
- **gamma** (float) - 输出图像像素值与输入图像像素值呈指数相关。 `gamma` 大于1使阴影更暗,而 `gamma` 小于1使黑暗区域更亮。
|
||||
- **gain** (float, 可选) - 常数乘数,默认值:1。
|
||||
|
|
|
@ -31,5 +31,5 @@ mindspore.dataset.vision.AutoAugment
|
|||
异常:
|
||||
- **TypeError** - 如果 `policy` 不是AutoAugmentPolicy类型。
|
||||
- **TypeError** - 如果 `interpolation` 不是Inter类型。
|
||||
- **TypeError** - 如果 如果 `fill_value` 不是整数或长度为3的元组。
|
||||
- **TypeError** - 如果 `fill_value` 不是整数或长度为3的元组。
|
||||
- **RuntimeError** - 如果给定的张量形状不是<H, W, C>。
|
||||
|
|
|
@ -6,13 +6,13 @@ mindspore.dataset.vision.PadToSize
|
|||
将图像填充到固定大小。
|
||||
|
||||
参数:
|
||||
- **size** (Union[int, Sequence[int]]) - 要填充的目标大小。
|
||||
- **size** (Union[int, Sequence[int, int]]) - 要填充的目标大小。
|
||||
若输入整型,则将图像填充为(size, size)大小;如果提供了序列[int, int],则将图像填充为(高度, 宽度)大小。
|
||||
- **offset** (Union[int, Sequence[int]], 可选) - 顶部和左侧要填充的长度。
|
||||
- **offset** (Union[int, Sequence[int, int]], 可选) - 顶部和左侧要填充的长度。
|
||||
如果输入整型,使用此值填充图像上侧和左侧。
|
||||
如果提供了序列[int, int],则应按[top, left]的顺序排列,填充图像上侧和左侧。
|
||||
默认值:None,表示对称填充。
|
||||
- **fill_value** (Union[int, tuple[int]], 可选) - 填充的像素值,仅在 `padding_mode` 取值为Border.CONSTANT时有效。
|
||||
- **fill_value** (Union[int, tuple[int, int, int]], 可选) - 填充的像素值,仅在 `padding_mode` 取值为Border.CONSTANT时有效。
|
||||
如果是3元素元组,则分别用于填充R、G、B通道。
|
||||
如果是整数,则用于所有 RGB 通道。
|
||||
`fill_value` 值必须在 [0, 255] 范围内,默认值:0。
|
||||
|
|
|
@ -3,7 +3,7 @@ mindspore.dataset.vision.RandomLighting
|
|||
|
||||
.. py:class:: mindspore.dataset.vision.RandomLighting(alpha=0.05)
|
||||
|
||||
将AlexNet PCA的噪声添加到图像中,其中Alexnet PCA噪声的特征值和特征向量是由ImageNet数据集计算得出。
|
||||
将AlexNet PCA的噪声添加到图像中。Alexnet PCA噪声的特征值和特征向量是由ImageNet数据集计算得出。
|
||||
|
||||
参数:
|
||||
- **alpha** (float, 可选) - 图像的强度,必须是非负的。默认值:0.05。
|
||||
|
|
|
@ -90,7 +90,7 @@ mindspore.nn.probability.distribution.Distribution
|
|||
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
传递给字类的参数的顺序应该与通过 `_add_parameter` 初始化默认参数的顺序相同。
|
||||
`dist_spec_args` 必须以列表或者字典的形式传入。传递给字类的参数的顺序应该与通过 `_add_parameter` 初始化默认参数的顺序相同。如果某个 `dist_spec_args` 为None,那么将返回默认值。
|
||||
|
||||
返回:
|
||||
list[Tensor],参数列表。
|
||||
|
|
|
@ -9,7 +9,7 @@ mindspore.nn.probability.distribution.Geometric
|
|||
离散随机分布,取值范围为正自然数集,概率质量函数为 :math:`P(X = i) = p(1-p)^{i-1}, i = 1, 2, ...`。
|
||||
|
||||
参数:
|
||||
- **probs** (int, float, list, numpy.ndarray, Tensor) - 成功的概率。默认值:None。
|
||||
- **probs** (float, list, numpy.ndarray, Tensor) - 成功的概率。默认值:None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None,则使用全局种子。默认值:None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值:mstype.int32.
|
||||
- **name** (str) - 分布的名称。默认值:'Geometric'。
|
||||
|
|
|
@ -12,8 +12,8 @@ mindspore.nn.probability.distribution.Logistic
|
|||
其中 :math:`a, b` 为分别为Logistic分布的位置参数和比例参数。
|
||||
|
||||
参数:
|
||||
- **loc** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的位置。默认值:None。
|
||||
- **scale** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的尺度。默认值:None。
|
||||
- **loc** (float, list, numpy.ndarray, Tensor) - Logistic分布的位置。默认值:None。
|
||||
- **scale** (float, list, numpy.ndarray, Tensor) - Logistic分布的尺度。默认值:None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None,则使用全局种子。默认值:None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值:mstype.float32。
|
||||
- **name** (str) - 分布的名称。默认值:'Logistic'。
|
||||
|
|
|
@ -12,7 +12,7 @@ mindspore.nn.probability.distribution.Poisson
|
|||
其中 :math:`\lambda` 为率参数(rate)。
|
||||
|
||||
参数:
|
||||
- **rate** (int, float, list, numpy.ndarray, Tensor) - 泊松分布的率参数。默认值:None。
|
||||
- **rate** (list, numpy.ndarray, Tensor) - 泊松分布的率参数。默认值:None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None,则使用全局种子。默认值:None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值:mstype.float32。
|
||||
- **name** (str) - 分布的名称。默认值:'Poisson'。
|
||||
|
|
|
@ -463,7 +463,7 @@ class AutoAugment(ImageTensorOperation):
|
|||
|
||||
- Inter.AREA: means the interpolation method is area interpolation.
|
||||
|
||||
fill_value (Union[int, tuple], optional): Pixel fill value for the area outside the transformed image.
|
||||
fill_value (Union[int, tuple[int]], optional): Pixel fill value for the area outside the transformed image.
|
||||
It can be an int or a 3-tuple. If it is a 3-tuple, it is used to fill R, G, B channels respectively.
|
||||
If it is an integer, it is used for all RGB channels. The fill_value values must be in range [0, 255]
|
||||
(default=0).
|
||||
|
|
|
@ -2101,8 +2101,8 @@ class KLDivLoss(LossBase):
|
|||
\operatorname{sum}(L(x, target)), & \text{if reduction} = \text{'sum'.}
|
||||
\end{cases}
|
||||
|
||||
where :math:`x` represents `logits`.
|
||||
:math:`target` represents `labels`.
|
||||
where :math:`x` represents `logits`,
|
||||
:math:`target` represents `labels`, and
|
||||
:math:`\ell(x, target)` represents `output`.
|
||||
|
||||
Note:
|
||||
|
|
|
@ -19,7 +19,9 @@ from .bijector import Bijector
|
|||
|
||||
class Invert(Bijector):
|
||||
r"""
|
||||
Invert Bijector. Compute the inverse function of the input bijector.
|
||||
Invert Bijector. Compute the inverse function of the input bijector. If the function of the forward mapping,
|
||||
namely the input of `bijector` below, is :math:`Y = g(X)`,
|
||||
then the function of corresponding inverse mapping Bijector is :math:`Y = h(X) = g^{-1}(X)`.
|
||||
|
||||
Args:
|
||||
bijector (Bijector): Base Bijector.
|
||||
|
|
|
@ -427,7 +427,8 @@ class Distribution(Cell):
|
|||
|
||||
def prob(self, value, *args, **kwargs):
|
||||
"""
|
||||
Evaluate the probability (pdf or pmf) at given value.
|
||||
Evaluate the probability (pdf or pmf) at given value. For a discrete distribution,
|
||||
it is a probability mass function, while for a continuous distribution, it is probability density function.
|
||||
|
||||
Args:
|
||||
value (Tensor): value to be evaluated.
|
||||
|
|
Loading…
Reference in New Issue