diff --git a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hypot.rst b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hypot.rst index 2032de03ade..d0ab100b553 100644 --- a/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hypot.rst +++ b/docs/api/api_python/mindspore/Tensor/mindspore.Tensor.hypot.rst @@ -1,6 +1,6 @@ mindspore.Tensor.hypot ====================== -.. py:method:: mindspore.Tensor.hypot(other): +.. py:method:: mindspore.Tensor.hypot(other) 详情请参考 :func:`mindspore.ops.hypot`。 diff --git a/docs/api/api_python/ops/mindspore.ops.Dilation2D.rst b/docs/api/api_python/ops/mindspore.ops.Dilation2D.rst index c11a06a5675..d7851426b79 100644 --- a/docs/api/api_python/ops/mindspore.ops.Dilation2D.rst +++ b/docs/api/api_python/ops/mindspore.ops.Dilation2D.rst @@ -11,7 +11,7 @@ 给定kernel size :math:`ks = (h_{ker}, w_{ker})`, stride :math:`s = (s_0, s_1)`，和 - dilation :math:`d = (d_0, d_1)` ，计算如下: + dilation :math:`d = (d_0, d_1)` ，计算如下： .. math:: \text{output}(N_i, C_j, h, w) = \max_{m=0, \ldots, h_{ker}-1} \max_{n=0, \ldots, w_{ker}-1} @@ -29,13 +29,13 @@ - **dilation** (Union(int，tuple[int])) - 数据类型为int，或者包含2个整数的元组，或者包含4个整数的元组，指定用于扩张卷积的膨胀速率。 如果设置为 :math:`k > 1` ，则每次抽样点跳过 :math:`k - 1` 个像素点。 其值必须大于等于1，并且以输入的宽度和高度为边界。 - - **pad_mode** (str，可选) - 指定填充模式，可选模式有"same", "valid"，默认值："same"。大小写均支持。 + - **pad_mode** (str，可选) - 指定填充模式，可选模式有"same"、"valid"，默认值："same"。大小写均支持。 - same：采用完全方式。输出的宽度和高度和输入的一样。 - valid：采用丢弃的方式。没有填充时候输出为最大的高度和宽度。额外的像素点将被丢弃。 - - **data_format** (str，可选) - 数据格式的值。目前只支持`NCHW`，默认值: `NCHW` 。 + - **data_format** (str，可选) - 数据格式的值。目前只支持 `NCHW` ，默认值： `NCHW` 。 输入： - **x** (Tensor) - 输入数据。一个四维Tensor，数据类型为float16、float32，shape必须为 diff --git a/docs/api/api_python/ops/mindspore.ops.EuclideanNorm.rst b/docs/api/api_python/ops/mindspore.ops.EuclideanNorm.rst index 9368a844e40..2b8c9cce787 100644 --- a/docs/api/api_python/ops/mindspore.ops.EuclideanNorm.rst +++ b/docs/api/api_python/ops/mindspore.ops.EuclideanNorm.rst @@ -1,12 +1,12 @@ mindspore.ops.EuclideanNorm ============================ -.. py:class:: mindspore.ops.EuclideanNorm(keep_dims=False): +.. py:class:: mindspore.ops.EuclideanNorm(keep_dims=False) 计算Tensor维度上元素的欧几里得范数，根据给定的轴对输入进行规约操作。 参数： - - **keep_dims** （bool，可选） - 如果为True，被规约的轴保留为1，如果为False，不保留给定的这些轴，默认值：False。 + - **keep_dims** (bool，可选) - 如果为True，被规约的轴保留为1，如果为False，不保留给定的这些轴，默认值：False。 输入： - **x** (Tensor) - 输入Tensor，将被规约，数据类型为：float16、float32、float64、int8、int16、 diff --git a/docs/api/api_python/ops/mindspore.ops.ExtractGlimpse.rst b/docs/api/api_python/ops/mindspore.ops.ExtractGlimpse.rst index 50bad56de69..33dd1910ff3 100644 --- a/docs/api/api_python/ops/mindspore.ops.ExtractGlimpse.rst +++ b/docs/api/api_python/ops/mindspore.ops.ExtractGlimpse.rst @@ -15,7 +15,7 @@ - **uniform_noise** (bool，可选) - 可选的bool，指示是否应该使用均匀分布或高斯分布生成噪声。默认为True。 - **noise** (str，可选) - 可选string，其值可以为： `uniform` 、 `gaussian` 和 `zero` 。 窗口由输入大小和偏移决定，如果窗口与输入部分没有重叠，则填充随机噪声。当 `noise` 为 `uniform` 或者 `gaussian` ， - 其填充结果是变量。当 `noise`为 `zero` ，则 `uniform_noise` 必须为False，这样填充的噪声才是0，保证了结果的正确。 + 其填充结果是变量。当 `noise` 为 `zero` ，则 `uniform_noise` 必须为False，这样填充的噪声才是0，保证了结果的正确。 当 `uniform_noise` 为True， `noise` 仅可以为 `uniform` 。当 `uniform_noise` 为False， `noise`可以为 `uniform` 、 `gaussian` 和 `zero` 。 默认为 `uniform` 。 diff --git a/docs/api/api_python/ops/mindspore.ops.ListDiff.rst b/docs/api/api_python/ops/mindspore.ops.ListDiff.rst index 10960165e95..0f36dc2c2c2 100644 --- a/docs/api/api_python/ops/mindspore.ops.ListDiff.rst +++ b/docs/api/api_python/ops/mindspore.ops.ListDiff.rst @@ -10,15 +10,15 @@ mindspore.ops.ListDiff 表示每个 `out` 元素在 `x` 中的位置。即： :math:`out[i] = x[idx[i]] for i in [0, 1, ..., len(out) - 1]` 。 参数： - - **out_idx** ( :class:`mindspore.dtype` ，可选) - `idx` 的数据类型，可选值： `mindspore.dtype.int32` 和 `mindspore.dtype.int64` 。默认值： `mindspore.dtype.int32` 。 + - **out_idx** (:class:`mindspore.dtype` ，可选) - `idx` 的数据类型，可选值： `mindspore.dtype.int32` 和 `mindspore.dtype.int64` 。默认值： `mindspore.dtype.int32` 。 输入： - **x** (Tensor) - 一个1-D Tensor。保留的值。类型支持：[float16, float32, float64, uint8, uint16, int8, int16, int32, int64]。 - **y** (Tensor) - 一个1-D Tensor，与 `x` 类型一致。移除的值。 输出： - **out** (Tensor) - 一个1-D Tensor，与 `x` 类型一致。 - **idx** (Tensor) - 一个1-D Tensor， `out_idx` 类型。 + - **out** (Tensor) - 一个1-D Tensor，与 `x` 类型一致。 + - **idx** (Tensor) - 一个1-D Tensor， `out_idx` 类型。 异常： - **ValueError** - 如果 `x` 或 `y` 的shape不是1D。 diff --git a/docs/api/api_python/ops/mindsopre.ops.NthElement.rst b/docs/api/api_python/ops/mindspore.ops.NthElement.rst similarity index 100% rename from docs/api/api_python/ops/mindsopre.ops.NthElement.rst rename to docs/api/api_python/ops/mindspore.ops.NthElement.rst diff --git a/docs/api/api_python/ops/mindspore.ops.PSROIPooling.rst b/docs/api/api_python/ops/mindspore.ops.PSROIPooling.rst new file mode 100644 index 00000000000..910f5d8ef82 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.PSROIPooling.rst @@ -0,0 +1,26 @@ +mindspore.ops.PSROIPooling +========================== + +.. py:class:: mindspore.ops.PSROIPooling(spatial_scale, group_size, output_dim) + + 对输入Tensor应用Position Sensitive ROI-Pooling。 + + 参数： + - **spatial_scale** (float) - 将框坐标映射到输入坐标的比例因子。例如，如果你的框定义在224x224的图像上，并且你的输入是112x112的特征图（由原始图像的0.5倍缩放产生），此时需要将其设置为0.5。 + - **group_size** (int) - 执行池化后输出的大小（以像素为单位），以（高度，宽度）的格式输出。 + - **output_dim** (int) - 执行池化后输出的维度。 + + 输入： + - **features** (Tensor) - 输入特征Tensor，其shape必须为 :math:`(N, C, H, W)` 。 各维度的值应满足： :math:`(C == output_dim * group_size * group_size)` 。数据类型为float16或者float32。 + - **rois** (Tensor) - 其shape为 :math:`(batch, 5, rois_n)` ，数据类型为float16或者float32。第一个维度的batch为批处理大小。第二个维度的大小必须为5。第三维度rois_n是rois的数量。rois_n的值格式为：(index, x1, y1, x2, y2)。其中第一个元素是rois的索引。方框坐标格式为(x1、y1、x2、y2)，之后将把这些方框的选中的区域提取出来。区域坐标必须满足0 <= x1 < x2和0 <= y1 < y2。 + + 输出： + - **out** (Tensor) - 池化后的输出。其shape为 :math:`(rois.shape[0] * rois.shape[2], output\_dim, group\_size, group\_size)` 。 + + 异常： + - **TypeError** - `spatial_scale` 不是float类型。 + - **TypeError** - `group_size` 或者 `output_dim` 不是 int类型。 + - **TypeError** - `features` 或者 `rois` 不是Tensor。 + - **TypeError** - `rois` 数据类型不是float16或者float32。 + - **ValueError** - `features` 的shape不满足 :math:`(C == output_dim * group_size * group_size)` 。 + - **ValueError** - `spatial_scale` 为负数。 diff --git a/docs/api/api_python/ops/mindspore.ops.PsROIPooling.rst b/docs/api/api_python/ops/mindspore.ops.PsROIPooling.rst index f87d7336827..910f5d8ef82 100644 --- a/docs/api/api_python/ops/mindspore.ops.PsROIPooling.rst +++ b/docs/api/api_python/ops/mindspore.ops.PsROIPooling.rst @@ -8,7 +8,7 @@ mindspore.ops.PSROIPooling 参数： - **spatial_scale** (float) - 将框坐标映射到输入坐标的比例因子。例如，如果你的框定义在224x224的图像上，并且你的输入是112x112的特征图（由原始图像的0.5倍缩放产生），此时需要将其设置为0.5。 - **group_size** (int) - 执行池化后输出的大小（以像素为单位），以（高度，宽度）的格式输出。 - - **output_dim** (int) -执行池化后输出的维度。 + - **output_dim** (int) - 执行池化后输出的维度。 输入： - **features** (Tensor) - 输入特征Tensor，其shape必须为 :math:`(N, C, H, W)` 。 各维度的值应满足： :math:`(C == output_dim * group_size * group_size)` 。数据类型为float16或者float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighborV2.rst b/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighborV2.rst index ec54c5c50c6..7cfddec5adf 100644 --- a/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighborV2.rst +++ b/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighborV2.rst @@ -10,11 +10,11 @@ mindspore.ops.ResizeNearestNeighborV2 参数： - **align_corners** (bool，可选) - 如果为True，则输入输出图像四个角像素的中心被对齐，同时保留角像素处的值。默认值：False。 - **half_pixel_centers** (bool，可选) - 是否使用半像素中心对齐。如果设置为True，那么 `align_corners` 应该设置为False。默认值：False。 - - **data_format** (str，可选)- 输入 `x` 的数据格式。默认值："NHWC"。 + - **data_format** (str，可选) - 输入 `x` 的数据格式。默认值："NHWC"。 输入： - **x** (Tensor) - 四维的Tensor，其shape为 :math:`(batch, height, width, channels)` 或者 :math:`(batch, channels, height, width)`，取决于 `data_format` 。支持的数据类型列表：[int8, uint8, int16, uint16, int32, int64, float16, float32, float64]。 - - **size** (Tensor) - 输出图片的尺寸。一维的Tensor，含有两个元素[ `new_height`,`new_width` ]。 + - **size** (Tensor) - 输出图片的尺寸。一维的Tensor，含有两个元素[ `new_height` , `new_width` ]。 输出： - **y** (Tensor) - 调整大小后的图像。是一个shape为 :math:`(batch, new\_height, new\_width, channels)` 或者 :math:`(batch, channels, new\_height, new\_width)` 的四维Tensor，具体是哪一个shape取决于 `data_format` 。数据类型与输入 `x` 相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_conj.rst b/docs/api/api_python/ops/mindspore.ops.func_conj.rst index 351bd677168..2b9beb240a5 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_conj.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_conj.rst @@ -17,4 +17,4 @@ 异常： - **TypeError** - 如果 `input` 的数据类型不是数字类型。 - - **ValueError** - 如果 `input` 不是Tensor。 + - **TypeError** - 如果 `input` 不是Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_heaviside.rst b/docs/api/api_python/ops/mindspore.ops.func_heaviside.rst index d34d3c408d5..e75dd10d0a5 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_heaviside.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_heaviside.rst @@ -3,7 +3,7 @@ mindspore.ops.heaviside .. py:function:: mindspore.ops.heaviside(x, values) - 计算输入中每​​个元素的 Heaviside 阶跃函数。公式定义如下： + 计算输入中每个元素的 Heaviside 阶跃函数。公式定义如下： .. math:: \text { heaviside }(\text { x, values })=\left\{\begin{array}{ll} diff --git a/docs/api/api_python/ops/mindspore.ops.func_log_uniform_candidate_sampler.rst b/docs/api/api_python/ops/mindspore.ops.func_log_uniform_candidate_sampler.rst index ffa7b04de19..8d13713c932 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_log_uniform_candidate_sampler.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_log_uniform_candidate_sampler.rst @@ -7,26 +7,23 @@ mindspore.ops.log_uniform_candidate_sampler 该操作从整数范围[0, `range_max` )中随机采样一个采样类( `sampled_candidates` )的Tensor。 - **参数：** + 参数： + - **true_classes** (Tensor) - 目标类，其数据类型为int64，shape为 :math:`(batch\_size, num\_true)` 。 + - **num_true** (int) - 每个训练样本的目标类数。默认值：1。 + - **num_sampled** (int) - 随机采样的类数。默认值：5。 + - **unique** (bool) - 确认批处理中的所有采样类是否都是唯一的。如果 `unique` 为True，则批处理中的所有采样类都唯一。默认值：True。 + - **range_max** (int) - 可能的类数。当 `unique` 为True时， `range_max` 必须大于或等于 `num_sampled` 。默认值：5。 + - **seed** (int) - 随机种子，必须是非负。默认值：0。 - - **true_classes** (Tensor) - 目标类，其数据类型为int64，shape为 :math:`(batch\_size, num\_true)` 。 - - **num_true** (int) - 每个训练样本的目标类数。默认值：1。 - - **num_sampled** (int) - 随机采样的类数。默认值：5。 - - **unique** (bool) - 确认批处理中的所有采样类是否都是唯一的。如果 `unique` 为True，则批处理中的所有采样类都唯一。默认值：True。 - - **range_max** (int) - 可能的类数。当 `unique` 为True时， `range_max` 必须大于或等于 `num_sampled` 。默认值：5。 - - **seed** (int) - 随机种子，必须是非负。默认值：0。 + 返回： + 3个Tensor组成的元组。 - **返回：** + - **sampled_candidates** (Tensor) - shape为 :math:`(num\_sampled,)` 且数据类型与 `true_classes` 相同的Tensor。 + - **true_expected_count** (Tensor) - shape与 `true_classes` 相同且数据类型为float32的Tensor。 + - **sampled_expected_count** (Tensor) - shape与 `sampled_candidates` 相同且数据类型为float32的Tensor。 - 3个Tensor组成的元组。 - - - **sampled_candidates** (Tensor) - shape为 :math:`(num\_sampled,)` 且数据类型与 `true_classes` 相同的Tensor。 - - **true_expected_count** (Tensor) - shape与 `true_classes` 相同且数据类型为float32的Tensor。 - - **sampled_expected_count** (Tensor) - shape与 `sampled_candidates` 相同且数据类型为float32的Tensor。 - - **异常：** - - - **TypeError** - `num_true` 和 `num_sampled` 都不是int。 - - **TypeError** - `unique` 不是bool。 - - **TypeError** - `range_max` 和 `seed` 都不是int。 - - **TypeError** - `true_classes` 不是Tensor。 \ No newline at end of file + 异常： + - **TypeError** - `num_true` 和 `num_sampled` 都不是int。 + - **TypeError** - `unique` 不是bool。 + - **TypeError** - `range_max` 和 `seed` 都不是int。 + - **TypeError** - `true_classes` 不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_orgqr.rst b/docs/api/api_python/ops/mindspore.ops.func_orgqr.rst index 4a02c3dfea1..d6057ce29b3 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_orgqr.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_orgqr.rst @@ -1,5 +1,6 @@ mindspore.ops.orgqr ==================== + .. py:function:: mindspore.ops.orgqr(x, tau) 计算 `Householder `_ 矩阵乘积的前 :math:`N` 列。