code_docs_ops_fractional_max_pool

docs/api/api_python/ops/mindspore.ops.func_fractional_max_pool2d.rst

@@ -11,22 +11,22 @@ mindspore.ops.fractional_max_pool2d
     分数最大池化的详细描述在 `Fractional Max-Pooling <https://arxiv.org/pdf/1412.6071>`_ 。
 
     参数：
-        - **input_x** (Tensor) - shape为 :math:`(N, C, H_{in}, W_{in})` 的Tensor。支持的数据类型，float16、float32、float64、int32和int64。
-        - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，如果为int，则代表池化核的高和宽。如果为tuple，其值必须包含两个正整数值分别表示池化核的高和宽。取值必须为正整数。
-        - **output_size** (Union[int, tuple[int]]，可选) - 目标输出shape。如果是整数，则表示输出目标的高和宽。如果是tuple，其值必须包含两个整数值分别表示目标输出的高和宽。默认值：None。
-        - **output_ratio** (Union[float, tuple[float]]，可选) - 目标输出shape与输入shape的比率。通过输入shape和 `output_ratio` 确定输出shape。支持数据类型：float16、float32、double，数值介于0到1之间。默认值：None。
+        - **input_x** (Tensor) - shape为 :math:`(N, C, H_{in}, W_{in})` 的Tensor。支持的数据类型：float16、float32、float64、int32和int64。
+        - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，如果为int，则代表池化核的高和宽。如果为tuple，其值必须包含两个正int值分别表示池化核的高和宽。取值必须为正int。
+        - **output_size** (Union[int, tuple[int]]，可选) - 目标输出shape。如果是int，则表示输出目标的高和宽。如果是tuple，其值必须包含两个int值分别表示目标输出的高和宽。默认值：None。
+        - **output_ratio** (Union[float, tuple[float]]，可选) - 目标输出shape与输入shape的比率。通过输入shape和 `output_ratio` 确定输出shape。支持数据类型：float16、float32、double，数值范围（0，1）。默认值：None。
         - **return_indices** (bool，可选) - 如果为 `True` ，返回分数最大池化的最大值的的索引值。默认值：False。
-        - **_random_samples** (Tensor，可选) - 3D张量，分数最大池化的随机步长。支持的数据类型：float16、float32、double。数值介于0到1之间。shape为 :math:`(N, C, 2)` 的Tensor。默认值：None。
+        - **_random_samples** (Tensor，可选) - 3D Tensor，分数最大池化的随机步长。支持的数据类型：float16、float32、double。数值范围（0，1）。shape为 :math:`(N, C, 2)` 的Tensor。默认值：None。
 
     返回：
         - **y** (Tensor) - 数据类型和输入相同，shape是 :math:`(N, C, H, W)`。
-        - **argmax** (Tensor) - 输出的索引，是一个张量。shape和输出 `y` 一致，数据类型是int64。仅当 `return_indices` 为True时，输出最大池化的索引值。
+        - **argmax** (Tensor) - 输出的索引，是一个Tensor。shape和输出 `y` 一致，数据类型是int64。仅当 `return_indices` 为True时，输出最大池化的索引值。
 
     异常：
         - **TypeError** - `input_x` 不是float16、float32、float64、int32或int64。
         - **TypeError** - `_random_samples` 不是float16、float32或float64。
-        - **ValueError** - `kernel_size` 不是整数并且不是长度为2的元组。
-        - **ValueError** - `output_shape` 不是整数并且不是长度为2的元组。
+        - **ValueError** - `kernel_size` 不是int并且不是长度为2的tuple。
+        - **ValueError** - `output_shape` 不是int并且不是长度为2的tuple。
         - **ValueError** - `kernel_size`， `output_shape` 与-1的和大于 `input_x` 的对应维度的量。
         - **ValueError** - `_random_samples` 维度不是3。
         - **ValueError** - `output_size` 和 `output_ratio` 同时为 `None` 。

docs/api/api_python/ops/mindspore.ops.func_fractional_max_pool3d.rst

@@ -12,25 +12,25 @@ mindspore.ops.fractional_max_pool3d
     输入输出的数据格式可以是”NCDHW“。其中，N是批次大小，C是通道数，D是特征深度，H是特征高度，W是特征宽度。
 
     参数：
-        - **input_x** (Tensor) - 4维或5维的张量，支持的数据类型：float16、float32、double、int32、int64。支持shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` 。
-        - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，如果为int，则代表池化核的深度，高和宽。如果为tuple，其值必须包含三个正整数值分别表示池化核的深度，高和宽。取值必须为正整数。
-        - **output_size** (Union[int, tuple[int]]，可选) - 目标输出大小。如果是整数，则表示输出目标的深、高和宽。如果是tuple，其值必须包含三个整数值分别表示目标输出的深、高和宽。默认值：None。
-        - **output_ratio** (Union[float, tuple[float]]，可选) - 目标输出shape与输入shape的比率。通过输入shape和 `output_ratio` 确定输出shape。支持数据类型：float16、float32、double，数值介于0到1之间。默认值：None。
+        - **input_x** (Tensor) - 4维或5维的Tensor，支持的数据类型：float16、float32、double、int32、int64。支持shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` 。
+        - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，如果为int，则代表池化核的深度，高和宽。如果为tuple，其值必须包含三个正int值分别表示池化核的深度，高和宽。取值必须为正int。
+        - **output_size** (Union[int, tuple[int]]，可选) - 目标输出大小。如果是int，则表示输出目标的深、高和宽。如果是tuple，其值必须包含三个int值分别表示目标输出的深、高和宽。默认值：None。
+        - **output_ratio** (Union[float, tuple[float]]，可选) - 目标输出shape与输入shape的比率。通过输入shape和 `output_ratio` 确定输出shape。支持数据类型：float16、float32、double，数值范围（0，1）。默认值：None。
         - **return_indices** (bool，可选) - 如果为 `True` ，返回分数最大池化的最大值的的索引值。默认值：False。
-        - **_random_samples** (Tensor，可选) - 随机步长。支持的数据类型：float16、float32、double。shape为 :math:`(N, C, 3)` 的Tensor。数值介于0到1之间。默认值：None。
+        - **_random_samples** (Tensor，可选) - 随机步长。支持的数据类型：float16、float32、double。shape为 :math:`(N, C, 3)` 的Tensor。数值范围（0，1）。默认值：None。
 
     返回：
-        - **y** (Tensor) - 3D分数最大池化的输出，是一个张量。数据类型和输入相同，shape是 :math:`(N, C, D, H, W)` 。
+        - **y** (Tensor) - 3D分数最大池化的输出，是一个Tensor。数据类型和输入相同，shape是 :math:`(N, C, D, H, W)` 。
         - **argmax** (Tensor) - 仅当 `return_indices` 为True时，输出最大池化的索引值。shape和输出 `y` 一致。
 
     异常：
-        - **TypeError** - `input_x` 不是4维或5维张量。
-        - **TypeError** - `random_samples` 不是3维张量。
+        - **TypeError** - `input_x` 不是4维或5维Tensor。
+        - **TypeError** - `random_samples` 不是3维Tensor。
         - **TypeError** - `x` 数据类型不是float16、float32、double、int32、int64。
         - **TypeError** - `random_samples` 数据类型不是float16、float32、double。
         - **TypeError** - `argmax` 数据类型不是int32、int64。
-        - **ValueError** - `output_shape` 不是长度为3的元组。
-        - **ValueError** - `kernal_size` 不是长度为3的元组。
+        - **ValueError** - `output_shape` 不是长度为3的tuple。
+        - **ValueError** - `kernal_size` 不是长度为3的tuple。
         - **ValueError** - `output_shape` 和 `kernel_size` 不是正数。
         - **ValueError** - `output_size` 和 `output_ratio` 同时为 `None` 。
         - **ValueError** - `input_x` 和 `random_samples` 的第一维度大小不相等。

mindspore/python/mindspore/ops/function/nn_func.py

@@ -1352,19 +1352,19 @@ def fractional_max_pool2d(input_x, kernel_size, output_size=None, output_ratio=N
             is an int number that represents height and width of the kernel, or a tuple
             of two int numbers that represent height and width respectively.
             The value must be a positive integer.
-        output_size (Union[int, tuple[int]], optional): The Shape of the target `output_size`,
+        output_size (Union[int, tuple[int]], optional): The shape of the target `output_size`,
             is an int number that represents height and width, or a tuple
             of two int numbers that represent height and width respectively.
             The value must be a positive integer.
             Default: None.
         output_ratio (Union[float, tuple[float]], optional): The ratio of target output shape to input shape.
             Specifying the size of the output tensor by using a ratio of the input size.
-            Data type : float16, float32, double, and value is between (0, 1).
+            Data type: float16, float32, double, and value is between (0, 1).
             Default: None.
         return_indices (bool, optional): If `return_indices` is True, the indices of max value would be output.
             Default: False.
         _random_samples (Tensor, optional): The random step of FractionalMaxPool2d, which is a 3D tensor.
-            Tensor of data type : float16, float32, double, and value is between (0, 1).
+            Tensor of data type: float16, float32, double, and value is between (0, 1).
             Supported shape :math:`(N, C, 2)`.
             Default: None.
 
@@ -1451,8 +1451,8 @@ def fractional_max_pool3d(input_x, kernel_size, output_size=None, output_ratio=N
 
     Args:
         input_x (Tensor): The input of FractionalMaxPool3d, which is a 4D or 5D tensor.
-            Tensor of data type : float16, float32, double, int32, int64.
-            Supported shape :math:`(N, C, D_{in}, H_{in}, W_{in})` .
+            Tensor of data type: float16, float32, double, int32, int64.
+            Supported shape :math:`(N, C, D_{in}, H_{in}, W_{in})`.
         kernel_size (Union[int, tuple[int]]): The size of kernel used to take the maximum value,
             is an int number that represents depth, height and width of the kernel, or a tuple
             of three int numbers that represent depth, height and width respectively.
@@ -1464,13 +1464,13 @@ def fractional_max_pool3d(input_x, kernel_size, output_size=None, output_ratio=N
             Default: None.
         output_ratio (Union[float, tuple[float]], optional): The ratio of target output shape to input shape.
             Specifying the size of the output tensor by using a ratio of the input size.
-            Data type : float16, float32, double, and value is between (0, 1).
+            Data type: float16, float32, double, and value is between (0, 1).
             Default: None.
         return_indices (bool, optional): If `return_indices` is True, the indices of max value would be output.
             Default: False.
         _random_samples (Tensor, optional): The random step of FractionalMaxPool3d, which is a 3D tensor.
-            Tensor of data type : float16, float32, double, and value is between (0, 1).
-            Supported shape :math:`(N, C, 3)`
+            Tensor of data type: float16, float32, double, and value is between (0, 1).
+            Supported shape :math:`(N, C, 3)`.
 
     Returns:
         - **y** (Tensor) - A tensor, the output of FractionalMaxPool3d.