From 49c599e02339b8d29681c23d35053dfab6a92a44 Mon Sep 17 00:00:00 2001 From: Xiao Tianci Date: Thu, 17 Feb 2022 19:35:00 +0800 Subject: [PATCH] add Chinese API for mindspore.dataset.vision --- ...aset.vision.py_transforms.AutoContrast.rst | 21 ++++++++++++ ...ataset.vision.py_transforms.CenterCrop.rst | 15 ++++++++ ...re.dataset.vision.py_transforms.Cutout.rst | 21 ++++++++++++ ...re.dataset.vision.py_transforms.Decode.rst | 11 ++++++ ....dataset.vision.py_transforms.Equalize.rst | 8 +++++ ....dataset.vision.py_transforms.FiveCrop.rst | 15 ++++++++ ...dataset.vision.py_transforms.Grayscale.rst | 15 ++++++++ ...e.dataset.vision.py_transforms.HWC2CHW.rst | 11 ++++++ ....dataset.vision.py_transforms.HsvToRgb.rst | 10 ++++++ ...re.dataset.vision.py_transforms.Invert.rst | 6 ++++ ...ion.py_transforms.LinearTransformation.rst | 23 +++++++++++++ ...ore.dataset.vision.py_transforms.MixUp.rst | 22 ++++++++++++ ...dataset.vision.py_transforms.Normalize.rst | 25 ++++++++++++++ ...aset.vision.py_transforms.NormalizePad.rst | 29 ++++++++++++++++ ...spore.dataset.vision.py_transforms.Pad.rst | 26 ++++++++++++++ ...aset.vision.py_transforms.RandomAffine.rst | 34 +++++++++++++++++++ ...taset.vision.py_transforms.RandomColor.rst | 16 +++++++++ ...vision.py_transforms.RandomColorAdjust.rst | 24 +++++++++++++ ...ataset.vision.py_transforms.RandomCrop.rst | 30 ++++++++++++++++ ...set.vision.py_transforms.RandomErasing.rst | 31 +++++++++++++++++ ...t.vision.py_transforms.RandomGrayscale.rst | 15 ++++++++ ...ion.py_transforms.RandomHorizontalFlip.rst | 16 +++++++++ ...vision.py_transforms.RandomPerspective.rst | 24 +++++++++++++ ...vision.py_transforms.RandomResizedCrop.rst | 32 +++++++++++++++++ ...et.vision.py_transforms.RandomRotation.rst | 30 ++++++++++++++++ ...t.vision.py_transforms.RandomSharpness.rst | 16 +++++++++ ...ision.py_transforms.RandomVerticalFlip.rst | 16 +++++++++ ...re.dataset.vision.py_transforms.Resize.rst | 22 ++++++++++++ ....dataset.vision.py_transforms.RgbToHsv.rst | 10 ++++++ ...e.dataset.vision.py_transforms.TenCrop.rst | 17 ++++++++++ ...ore.dataset.vision.py_transforms.ToPIL.rst | 12 +++++++ ....dataset.vision.py_transforms.ToTensor.rst | 15 ++++++++ ...re.dataset.vision.py_transforms.ToType.rst | 14 ++++++++ ...et.vision.py_transforms.UniformAugment.rst | 19 +++++++++++ 34 files changed, 651 insertions(+) create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.AutoContrast.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.CenterCrop.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Cutout.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Decode.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Equalize.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.FiveCrop.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Grayscale.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HWC2CHW.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HsvToRgb.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Invert.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.LinearTransformation.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.MixUp.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Normalize.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.NormalizePad.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Pad.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomAffine.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColor.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColorAdjust.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomCrop.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomErasing.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomGrayscale.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomHorizontalFlip.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomPerspective.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomResizedCrop.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomRotation.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomSharpness.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomVerticalFlip.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Resize.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RgbToHsv.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.TenCrop.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToPIL.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToTensor.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToType.rst create mode 100644 docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.UniformAugment.rst diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.AutoContrast.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.AutoContrast.rst new file mode 100644 index 00000000000..2b99f3c98a4 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.AutoContrast.rst @@ -0,0 +1,21 @@ +mindspore.dataset.vision.py_transforms.AutoContrast +=================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.AutoContrast(cutoff=0.0, ignore=None) + + 最大化（标准化）输入PIL图像的对比度。 + + 首先计算输入图像的直方图，移除指定 `cutoff` 比例的最亮和最暗像素后，将像素值重新映射至[0, 255]，使得最暗像素变为黑色，最亮像素变为白色。 + + **参数：** + + - **cutoff** (float，可选) - 从直方图中移除最亮和最暗像素的百分比，取值范围为[0.0, 50.0)，默认值：0.0。 + - **ignore** (Union[int, sequence]，可选) - 背景像素值，将会被直接映射为白色，默认值：None，表示没有背景像素。 + + **异常：** + + - **TypeError** - 当 `cutoff` 的类型不为浮点型。 + - **TypeError** - 当 `ignore` 的类型不为整型或序列。 + - **ValueError** - 当 `cutoff` 取值不在[0, 50.0)范围内。 + - **ValueError** - 当 `ignore` 取值不在[0, 255]范围内。 + - **RuntimeError** - 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.CenterCrop.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.CenterCrop.rst new file mode 100644 index 00000000000..de25957b54b --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.CenterCrop.rst @@ -0,0 +1,15 @@ +mindspore.dataset.vision.py_transforms.CenterCrop +================================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.CenterCrop(size) + + 以输入PIL图像的中心为裁剪中心，裁剪指定大小的子图。 + + **参数：** + + - **size** (Union[int, sequence]) - 裁剪子图的大小。若输入整型，则以该值为边裁剪(size, size)大小的子图；若输入2元素序列，则以2个元素分别为高和宽裁剪(height, width)大小的子图。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **ValueError** - 当 `size` 小于等于0。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Cutout.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Cutout.rst new file mode 100644 index 00000000000..f49a09f8c97 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Cutout.rst @@ -0,0 +1,21 @@ +mindspore.dataset.vision.py_transforms.Cutout +============================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.Cutout(length, num_patches=1) + + 随机去除输入numpy.ndarray图像上一定数量的正方形区域，将区域内像素值置为0。 + + 请参阅论文 `Improved Regularization of Convolutional Neural Networks with Cutout `_ 。 + + **参数：** + + - **length** (int) - 去除正方形区域的边长。 + - **num_patches** (int，可选) - 去除区域的数量，默认值：1。 + + **异常：** + + - **TypeError** - 当 `length` 的类型不为整型。 + - **TypeError** - 当 `num_patches` 的类型不为整型。 + - **ValueError** - 当 `length` 小于等于0。 + - **ValueError** - 当 `num_patches` 小于等于0。 + - **RuntimeError** - 当输入图像的shape不为。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Decode.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Decode.rst new file mode 100644 index 00000000000..53f797e3c42 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Decode.rst @@ -0,0 +1,11 @@ +mindspore.dataset.vision.py_transforms.Decode +============================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.Decode + + 将输入原始图像字节解码为RGB格式PIL图像。 + + **异常：** + + - **ValueError** - 当输入不是原始图像字节。 + - **ValueError** - 当输入是已解码的图像。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Equalize.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Equalize.rst new file mode 100644 index 00000000000..9f883543303 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Equalize.rst @@ -0,0 +1,8 @@ +mindspore.dataset.vision.py_transforms.Equalize +=============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.Equalize + + 均衡输入PIL图像的直方图。 + + 通过对输入图像进行非线性映射，使得输出图像中的灰度值服从均匀分布。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.FiveCrop.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.FiveCrop.rst new file mode 100644 index 00000000000..5d544a11f37 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.FiveCrop.rst @@ -0,0 +1,15 @@ +mindspore.dataset.vision.py_transforms.FiveCrop +=============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.FiveCrop(size) + + 在输入PIL图像的中心与四个角处分别裁剪指定大小的子图。 + + **参数：** + + - **size** (Union[int, sequence]) - 裁剪子图的大小。若输入整型，则以该值为边裁剪(size, size)大小的子图；若输入2元素序列，则以2个元素分别为高和宽裁剪(height, width)大小的子图。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **ValueError** - 当 `size` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Grayscale.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Grayscale.rst new file mode 100644 index 00000000000..e6653104584 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Grayscale.rst @@ -0,0 +1,15 @@ +mindspore.dataset.vision.py_transforms.Grayscale +================================================ + +.. py:class:: mindspore.dataset.vision.py_transforms.Grayscale(num_output_channels=1) + + 将输入PIL图像转换为灰度图。 + + **参数：** + + - **num_output_channels** (int) - 输出灰度图的通道数，取值可为1或3，默认值：1。当取值为3时，返回图像各通道的像素值将相同。 + + **异常：** + + - **TypeError** - 当 `num_output_channels` 的类型不为整型。 + - **ValueError** - 当 `num_output_channels` 取值不为1或3。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HWC2CHW.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HWC2CHW.rst new file mode 100644 index 00000000000..2731f45cc69 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HWC2CHW.rst @@ -0,0 +1,11 @@ +mindspore.dataset.vision.py_transforms.HWC2CHW +============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.HWC2CHW + + 将输入的(H, W, C)形状numpy.ndarray图像转换为(C, H, W)形状。 + + **异常：** + + - **TypeError** - 当输入图像的类型不为 :class:`numpy.ndarray` 。 + - **TypeError** - 当输入图像的维度不为3。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HsvToRgb.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HsvToRgb.rst new file mode 100644 index 00000000000..7c4de37c16e --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.HsvToRgb.rst @@ -0,0 +1,10 @@ +mindspore.dataset.vision.py_transforms.HsvToRgb +=============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.HsvToRgb(is_hwc=False) + + 将输入的HSV格式numpy.ndarray图像转换为RGB格式。 + + **参数：** + + - **is_hwc** (bool) - 若为True，表示输入图像的维度为(H, W, C)或(N, H, W, C)；否则为(C, H, W)或(N, C, H, W)。默认值：False。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Invert.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Invert.rst new file mode 100644 index 00000000000..4ce5faa83af --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Invert.rst @@ -0,0 +1,6 @@ +mindspore.dataset.vision.py_transforms.Invert +============================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.Invert + + 反转输入PIL图像的颜色。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.LinearTransformation.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.LinearTransformation.rst new file mode 100644 index 00000000000..ec835fbec79 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.LinearTransformation.rst @@ -0,0 +1,23 @@ +mindspore.dataset.vision.py_transforms.LinearTransformation +=========================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.LinearTransformation(transformation_matrix, mean_vector) + + 使用指定的变换方阵和均值向量对输入numpy.ndarray图像进行线性变换。 + + 先将输入图像展平为一维，从中减去均值向量，然后计算其与变换方阵的点积，最后再变形回原始形状。 + + **参数：** + + - **transformation_matrix** (numpy.ndarray) - 形如(D, D)的变换方阵，其中 + + :math:`D = C \times H \times W` 。 + + - **mean_vector** (numpy.ndarray) - 形如(D,)的均值向量，其中 + + :math:`D = C \times H \times W` 。 + + **异常：** + + - **TypeError** - 当 `transformation_matrix` 的类型不为 :class:`numpy.ndarray` 。 + - **TypeError** - 当 `mean_vector` 的类型不为 :class:`numpy.ndarray` 。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.MixUp.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.MixUp.rst new file mode 100644 index 00000000000..7883fbeb37a --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.MixUp.rst @@ -0,0 +1,22 @@ +mindspore.dataset.vision.py_transforms.MixUp +============================================ + +.. py:class:: mindspore.dataset.vision.py_transforms.MixUp(batch_size, alpha, is_single=True) + + 随机混合一批输入的numpy.ndarray图像及其标签。 + + 首先将每个图像乘以一个从Beta分布随机生成的权重lambda，然后加上另一个图像与1 - lambda之积，最后使用同样的lambda值将图像对应的标签进行混合，请确保标签预先进行了one-hot编码。 + + **参数：** + + - **batch_size** (int) - 批处理大小，即图片的数量。 + - **alpha** (float) - Beta分布的α参数值，β参数也将使用该值。 + - **is_single** (bool，可选) - 若为True，将在批内随机混合图像[img0, ..., img(n-1), img(n)]与[img1, ..., img(n), img0]及对应标签；否则，将每批图像与前一批图像的处理结果混合。默认值：True。 + + **异常：** + + - **TypeError** - 当 `batch_size` 的类型不为整型。 + - **TypeError** - 当 `alpha` 的类型不为浮点型。 + - **TypeError** - 当 `is_single` 的类型不为布尔型。 + - **ValueError** - 当 `batch_size` 不为正数。 + - **ValueError** - 当 `alpha` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Normalize.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Normalize.rst new file mode 100644 index 00000000000..ec0b4a3a106 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Normalize.rst @@ -0,0 +1,25 @@ +mindspore.dataset.vision.py_transforms.Normalize +================================================ + +.. py:class:: mindspore.dataset.vision.py_transforms.Normalize(mean, std) + + 使用指定的均值和标准差，标准化形如(C, H, W)的输入numpy.ndarray图像。 + + .. math:: + + output_{c} = \frac{input_{c} - mean_{c}}{std_{c}} + + .. note:: 输入图像的像素值需要在[0.0, 1.0]范围内。否则，请先调用 :class:`ToTensor` 进行转换。 + + **参数：** + + - **mean** (Union[float, sequence]) - 各通道的像素均值，取值范围为[0.0, 1.0]。若输入浮点型，将为每个通道应用相同的均值；若输入序列，长度应与通道数相等，且对应通道顺序进行排列。 + - **std** (Union[float, sequence]) - 各通道的标准差，取值范围为(0.0, 1.0]。若输入浮点型，将为每个通道应用相同的标准差；若输入序列，长度应与通道数相等，且对应通道顺序进行排列。 + + **异常：** + + - **TypeError** - 当输入图像的类型不为 :class:`numpy.ndarray` 。 + - **TypeError** - 当输入图像的维度不为3。 + - **NotImplementedError** - 当输入图像的像素值类型为整型。 + - **ValueError** - 当均值与标准差的长度不相等。 + - **ValueError** - 当均值或标准差的长度即不等于1，也不等于图像的通道数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.NormalizePad.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.NormalizePad.rst new file mode 100644 index 00000000000..c9945d8b6e4 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.NormalizePad.rst @@ -0,0 +1,29 @@ +mindspore.dataset.vision.py_transforms.NormalizePad +=================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.NormalizePad(mean, std, dtype='float32') + + 使用指定的均值和标准差，标准化形如(C, H, W)的输入numpy.ndarray图像，并填充一个全零的额外通道。 + + .. math:: + output_{c} = \begin{cases} + \frac{input_{c} - mean_{c}}{std_{c}}, & \text{if} \quad 0 \le c < 3 \text{;}\\ + 0, & \text{if} \quad c = 3 \text{.} + \end{cases} + + .. note:: 输入图像的像素值需要在[0.0, 1.0]范围内。否则，请先调用 :class:`ToTensor` 进行转换。 + + **参数：** + + - **mean** (Union[float, sequence]) - 各通道的像素均值，取值范围为[0.0, 1.0]。若输入浮点型，将为每个通道应用相同的均值；若输入序列，长度应与通道数相等，且对应通道顺序进行排列。 + - **std** (Union[float, sequence]) - 各通道的标准差，取值范围为(0.0, 1.0]。若输入浮点型，将为每个通道应用相同的标准差；若输入序列，长度应与通道数相等，且对应通道顺序进行排列。 + - **dtype** (str，可选) - 输出图像的数据类型，仅支持"float32"和"float16"，默认值："float32"。 + + + **异常：** + + - **TypeError** - 当输入图像的类型不为 :class:`numpy.ndarray` 。 + - **TypeError** - 当输入图像的维度不为3。 + - **NotImplementedError** - 当输入图像的像素值类型为整型。 + - **ValueError** - 当均值与标准差的长度不相等。 + - **ValueError** - 当均值或标准差的长度即不等于1，也不等于图像的通道数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Pad.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Pad.rst new file mode 100644 index 00000000000..3167f4f92e6 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Pad.rst @@ -0,0 +1,26 @@ +mindspore.dataset.vision.py_transforms.Pad +========================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.Pad(padding, fill_value=0, padding_mode=) + + 对输入PIL图像的各边进行填充。 + + **参数：** + + - **padding** (Union[int, sequence]) - 图像各边填充的像素数。若输入整型，将以该值对所有边框进行填充；若输入2元素序列，将以第一个值填充左/上边框，第二个值填充右/下边框；若输入4元素序列，将分别用于填充左、上、右和下边框。 + - **fill_value** (Union[int, tuple]，可选) - 用于填充边框的像素值，仅当 `padding_mode` 为 Border.CONSTANT 时生效 。若输入整型，将以该值填充RGB通道；若输入3元素元组，将分别用于填充R、G、B通道。默认值：0。 + - **padding_mode** (Border，可选) - 填充方式，取值可为 Border.CONSTANT、Border.EDGE、Border.REFLECT 或 Border.SYMMETRIC。默认值：Border.CONSTANT。 + + - **Border.CONSTANT**：使用常量值进行填充。 + - **Border.EDGE**：使用各边的边界像素值进行填充。 + - **Border.REFLECT**：以各边的边界为轴进行镜像填充，忽略边界像素值。 + - **Border.SYMMETRIC**：以各边的边界为轴进行对称填充，包括边界像素值。 + + **异常：** + + - **TypeError** - 当 `padding` 的类型不为整型或整型序列。 + - **TypeError** - 当 `fill_value` 的类型不为整型或整型序列。 + - **TypeError** - 当 `padding_mode` 的类型不为 :class:`Border` 。 + - **ValueError** - 当 `padding` 为负数。 + - **ValueError** - 当 `fill_value` 取值不在[0, 255]范围内。 + - **RuntimeError** 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomAffine.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomAffine.rst new file mode 100644 index 00000000000..aa66de2b4a3 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomAffine.rst @@ -0,0 +1,34 @@ +mindspore.dataset.vision.py_transforms.RandomAffine +=================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomAffine(degrees, translate=None, scale=None, shear=None, resample=, fill_value=0) + + 对输入PIL图像进行随机仿射变换。 + + **参数：** + + - **degrees** (Union[int, float, sequence]) - 旋转角度的随机选取范围，单位为度。若输入单个数字，将从(-degrees, degrees)中随机生成旋转角度；若输入2元素序列，需按(min, max)顺序排列。 + - **translate** (sequence，可选) - 水平与垂直平移比例的随机选取范围，按照(tx, ty)顺序排列，水平与垂直平移的距离将分别从(-tx * width, tx * width)与(-ty * height, ty * height)中随机生成，默认值：None，表示不平移。 + - **scale** (sequence，可选) - 放缩比例的随机选取范围，默认值：None，表示不进行放缩。 + - **shear** (Union[int, float, sequence]，可选) - 剪切角度的随机选取范围，单位为度。若输入单个数字，将进行X轴剪切，剪切角度从(-shear, shear)中随机生成；若输入2元素序列，将进行X轴剪切，剪切角度从(shear[0], shear[1])中随机生成；若输入4元素序列，将分别进行X轴和Y轴剪切，剪切角度分别从(shear[0], shear[1])和(shear[2], shear[3])中随机生成。默认值：None，表示不进行剪切。 + - **resample** (Inter，可选) - 插值方式，取值可为 Inter.BILINEAR、Inter.NEAREST 或 Inter.BICUBIC。若输入的PIL图像模式为"1"或"P"，将直接使用 Inter.NEAREST 作为插值方式。默认值：Inter.NEAREST。 + + - **Inter.BILINEAR**：双线性插值。 + - **Inter.NEAREST**：最近邻插值。 + - **Inter.BICUBIC**：双三次插值。 + + - **fill_value** (Union[int, tuple]，可选) - 变换图像之外区域的像素填充值。若输入整型，将以该值填充RGB通道；若输入3元素元组，将分别用于填充R、G、B通道。默认值：0。仅支持Pillow 5.0.0以上版本。 + + **异常：** + + - **TypeError** - 当 `degrees` 的类型不为整型、浮点型或序列。 + - **TypeError** - 当 `translate` 的类型不为序列。 + - **TypeError** - 当 `scale` 的类型不为序列。 + - **TypeError** - 当 `shear` 的类型不为整型、浮点型或序列。 + - **TypeError** - 当 `resample` 的类型不为 :class:`Inter` 。 + - **TypeError** - 当 `fill_value` 的类型不为整型或整型元组。 + - **ValueError** - 当 `degrees` 为负数。 + - **ValueError** - 当 `translate` 取值不在[-1.0, 1.0]范围内。 + - **ValueError** - 当 `scale` 为负数。 + - **ValueError** - 当 `shear` 不为正数。 + - **RuntimeError** - 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColor.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColor.rst new file mode 100644 index 00000000000..5bc8a722237 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColor.rst @@ -0,0 +1,16 @@ +mindspore.dataset.vision.py_transforms.RandomColor +================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomColor(degrees=(0.1, 1.9)) + + 随机调整输入PIL图像的色彩平衡。 + + **参数：** + + - **degrees** (sequence) - 色彩调节系数的随机选取范围，需为一个2元素序列，按照(min, max)的顺序排列，默认值：(0.1, 1.9)。调节系数为1.0时返回原始图像；调节系数为0.0时返回黑白图像；取值越大，图像的亮度、对比度等越大。 + + **异常：** + + - **TypeError** - 当 `degrees` 的类型不为浮点型序列。 + - **ValueError** - 当 `degrees` 为负数。 + - **RuntimeError** - 当输入图像的shape不为。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColorAdjust.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColorAdjust.rst new file mode 100644 index 00000000000..20b77049898 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomColorAdjust.rst @@ -0,0 +1,24 @@ +mindspore.dataset.vision.py_transforms.RandomColorAdjust +======================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomColorAdjust(brightness=(1, 1), contrast=(1, 1), saturation=(1, 1), hue=(0, 0)) + + 随机调整输入PIL图像的亮度、对比度、饱和度和色调。 + + **参数：** + + - **brightness** (Union[float, sequence]，可选) - 亮度调节系数的随机选取范围，需为非负数。若输入浮点型，将从[max(0, 1 - brightness), 1 + brightness)中随机生成亮度调节系数；若输入2元素序列，需按(min, max)顺序排列。默认值：(1, 1)。 + - **contrast** (Union[float, sequence]，可选) - 对比度调节系数的随机选取范围，需为非负数。若输入浮点型，将从[max(0, 1 - contrast), 1 + contrast)中随机生成对比度调节系数；若输入2元素序列，需按(min, max)顺序排列。默认值：(1, 1)。 + - **saturation** (Union[float, sequence]，可选) - 饱和度调节系数的随机选取范围，需为非负数。若输入浮点型，将从[max(0, 1 - saturation), 1 + saturation)中随机生成饱和度调节系数；若输入2元素序列，需按(min, max)顺序排列。默认值：(1, 1)。 + - **hue** (Union[float, sequence]，可选) - 色调调节系数的随机选取范围。若输入浮点型，取值范围为[0, 0.5]，将从[-hue, hue)中随机生成色调调节系数；若输入2元素序列，元素取值范围为[-0.5, 0.5]，且需按(min, max)顺序排列。默认值：(0, 0)。 + + **异常：** + + - **TypeError** - 当 `brightness` 的类型不为浮点型或浮点型序列。 + - **TypeError** - 当 `contrast` 的类型不为浮点型或浮点型序列。 + - **TypeError** - 当 `saturation` 的类型不为浮点型或浮点型序列。 + - **TypeError** - 当 `hue` 的类型不为浮点型或浮点型序列。 + - **ValueError** - 当 `brightness` 为负数。 + - **ValueError** - 当 `contrast` 为负数。 + - **ValueError** - 当 `saturation` 为负数。 + - **ValueError** - 当 `hue` 取值不在[-0.5, 0.5]范围内。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomCrop.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomCrop.rst new file mode 100644 index 00000000000..a95b5191451 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomCrop.rst @@ -0,0 +1,30 @@ +mindspore.dataset.vision.py_transforms.RandomCrop +================================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomCrop(size, padding=None, pad_if_needed=False, fill_value=0, padding_mode=) + + 在输入PIL图像上的随机位置，裁剪指定大小的子图。 + + **参数：** + + - **size** (Union[int, sequence]) - 裁剪子图的大小。若输入整型，则以该值为边裁剪(size, size)大小的子图；若输入2元素序列，则以2个元素分别为高和宽裁剪(height, width)大小的子图。 + - **padding** (Union[int, sequence]，可选) - 图像各边填充的像素数。指定该参数后，将在随机裁剪前对图像进行填充。若输入整型，将以该值对所有边框进行填充；若输入2元素序列，将以第一个值填充左/上边框，第二个值填充右/下边框；若输入4元素序列，将分别用于填充左、上、右和下边框。默认值：None，表示不进行填充。 + - **pad_if_needed** (bool，可选) - 当图像任意边小于指定裁剪大小时，是否进行填充。默认值：False，表示不进行填充。 + - **fill_value** (Union[int, tuple]，可选) - 用于填充边框的像素值，仅当 `padding_mode` 为 Border.CONSTANT 时生效 。若输入整型，将以该值填充RGB通道；若输入3元素元组，将分别用于填充R、G、B通道。默认值：0。 + - **padding_mode** (Border，可选) - 填充方式，取值可为 Border.CONSTANT、Border.EDGE、Border.REFLECT 或 Border.SYMMETRIC。默认值：Border.CONSTANT。 + + - **Border.CONSTANT**：使用常量值进行填充。 + - **Border.EDGE**：使用各边的边界像素值进行填充。 + - **Border.REFLECT**：以各边的边界为轴进行镜像填充，忽略边界像素值。 + - **Border.SYMMETRIC**：以各边的边界为轴进行对称填充，包括边界像素值。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **TypeError** - 当 `padding` 的类型不为整型或整型序列。 + - **TypeError** - 当 `pad_if_needed` 的类型不为布尔型。 + - **TypeError** - 当 `fill_value` 的类型不为整型或整型序列。 + - **TypeError** - 当 `padding_mode` 的类型不为 :class:`Border` 。 + - **ValueError** - 当 `size` 不为正数。 + - **ValueError** - 当 `padding` 为负数。 + - **ValueError** - 当 `fill_value` 取值不在[0, 255]范围内。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomErasing.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomErasing.rst new file mode 100644 index 00000000000..9d839647a7e --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomErasing.rst @@ -0,0 +1,31 @@ +mindspore.dataset.vision.py_transforms.RandomErasing +==================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomErasing(prob=0.5, scale=(0.02, 0.33), ratio=(0.3, 3.3), value=0, inplace=False, max_attempts=10) + + 按照指定的概率擦除输入numpy.ndarray图像上随机矩形区域内的像素。 + + 请参阅论文 `Random Erasing Data Augmentation `_。 + + **参数：** + + - **prob** (float，可选) - 执行随机擦除的概率，默认值：0.5。 + - **scale** (sequence，可选) - 擦除区域面积相对原图比例的随机选取范围，按照(min, max)顺序排列，默认值：(0.02, 0.33)。 + - **ratio** (sequence，可选) - 擦除区域宽高比的随机选取范围，按照(min, max)顺序排列，默认值：(0.3, 3.3)。 + - **value** (Union[int, str, sequence]) - 擦除区域的像素填充值。若输入整型，将以该值填充RGB通道；若输入3元素元组，将分别用于填充R、G、B通道；若输入字符串'random'，将以从标准正态分布获得的随机值擦除各个像素。默认值：0。 + - **inplace** (bool，可选) - 是否直接在原图上执行擦除，默认值：False。 + - **max_attempts** (int，可选) - 生成随机擦除区域的最大尝试次数，超过该次数时将返回原始图像。默认值：10。 + + **异常：** + + - **TypeError** - 当 `prob` 的类型不为浮点型。 + - **TypeError** - 当 `scale` 的类型不为序列。 + - **TypeError** - 当 `ratio` 的类型不为序列。 + - **TypeError** - 当 `value` 的类型不为整型、字符串或序列。 + - **TypeError** - 当 `inplace` 的类型不为布尔型。 + - **TypeError** - 当 `max_attempts` 的类型不为整型。 + - **ValueError** - 当 `prob` 取值不在[0, 1]范围内。 + - **ValueError** - 当 `scale` 为负数。 + - **ValueError** - 当 `ratio` 为负数。 + - **ValueError** - 当 `value` 取值不在[0, 255]范围内。 + - **ValueError** - 当 `max_attempts` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomGrayscale.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomGrayscale.rst new file mode 100644 index 00000000000..fd9437e266e --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomGrayscale.rst @@ -0,0 +1,15 @@ +mindspore.dataset.vision.py_transforms.RandomGrayscale +====================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomGrayscale(prob=0.1) + + 按照指定的概率将输入PIL图像转换为灰度图。 + + **参数：** + + - **prob** (float，可选) - 执行灰度转换的概率，默认值：0.1。 + + **异常：** + + - **TypeError** - 当 `prob` 的类型不为浮点型。 + - **ValueError** - 当 `prob` 取值不在[0, 1]范围内。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomHorizontalFlip.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomHorizontalFlip.rst new file mode 100644 index 00000000000..8ebaf495957 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomHorizontalFlip.rst @@ -0,0 +1,16 @@ +mindspore.dataset.vision.py_transforms.RandomHorizontalFlip +=========================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomHorizontalFlip(prob=0.5) + + 按照指定的概率随机水平翻转输入的PIL图像。 + + **参数：** + + - **prob** (float，可选) - 执行水平翻转的概率，默认值：0.5。 + + **异常：** + + - **TypeError** - 当 `prob` 的类型不为浮点型。 + - **ValueError** - 当 `prob` 取值不在[0, 1]范围内。 + - **RuntimeError** - 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomPerspective.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomPerspective.rst new file mode 100644 index 00000000000..6b95a2cf98b --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomPerspective.rst @@ -0,0 +1,24 @@ +mindspore.dataset.vision.py_transforms.RandomPerspective +======================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomPerspective(distortion_scale=0.5, prob=0.5, interpolation=) + + 按照指定的概率对输入PIL图像进行透视变换。 + + **参数：** + + - **distortion_scale** (float，可选) - 失真程度，取值范围为[0, 1]，默认值：0.5。 + - **prob** (float，可选) - 执行透视变换的概率，默认值：0.5。 + - **interpolation** (Inter，可选) - 插值方式，取值可为 Inter.BILINEAR、Inter.NEAREST 或 Inter.BICUBIC。默认值：Inter.BICUBIC。 + + - **Inter.BILINEAR**：双线性插值。 + - **Inter.NEAREST**：最近邻插值。 + - **Inter.BICUBIC**：双三次插值。 + + **异常：** + + - **TypeError** - 当 `distortion_scale` 的类型不为浮点型。 + - **TypeError** - 当 `prob` 的类型不为浮点型。 + - **TypeError** - 当 `interpolation` 的类型不为 :class:`Inter` 。 + - **ValueError** - 当 `distortion_scale` 取值不在[0, 1]范围内。 + - **ValueError** - 当 `prob` 取值不在[0, 1]范围内。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomResizedCrop.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomResizedCrop.rst new file mode 100644 index 00000000000..4eebc220bf4 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomResizedCrop.rst @@ -0,0 +1,32 @@ +mindspore.dataset.vision.py_transforms.RandomResizedCrop +======================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomResizedCrop(size, scale=(0.08, 1.0), ratio=(0.75, 1.3333333333333333), interpolation=, max_attempts=10) + + 在输入PIL图像上的随机位置裁剪子图，并放缩到指定大小。 + + **参数：** + + - **size** (Union[int, sequence]) - 图像放缩的大小。若输入整型，则放缩至(size, size)大小；若输入2元素序列，则以2个元素分别为高和宽放缩至(height, width)大小。 + - **scale** (Union[list, tuple]，可选) - 裁剪子图的面积相对原图比例的随机选取范围，按照(min, max)顺序排列，默认值：(0.08, 1.0)。 + - **ratio** (Union[list, tuple]，可选) - 裁剪子图的宽高比的随机选取范围，按照(min, max)顺序排列，默认值：(3./4., 4./3.)。 + - **interpolation** (Inter，可选) - 插值方式，取值可为 Inter.NEAREST、Inter.ANTIALIAS、Inter.BILINEAR 或 Inter.BICUBIC。默认值：Inter.BILINEAR。 + + - **Inter.NEAREST**：最近邻插值。 + - **Inter.ANTIALIAS**：抗锯齿插值。 + - **Inter.BILINEAR**：双线性插值。 + - **Inter.BICUBIC**：双三次插值。 + + - **max_attempts** (int，可选) - 生成随机裁剪位置的最大尝试次数，超过该次数时将使用中心裁剪，默认值：10。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **TypeError** - 当 `scale` 的类型不为元组。 + - **TypeError** - 当 `ratio` 的类型不为元组。 + - **TypeError** - 当 `interpolation` 的类型不为 :class:`Inter` 。 + - **TypeError** - 当 `max_attempts` 的类型不为整型。 + - **ValueError** - 当 `size` 不为正数。 + - **ValueError** - 当 `scale` 为负数。 + - **ValueError** - 当 `ratio` 为负数。 + - **ValueError** - 当 `max_attempts` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomRotation.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomRotation.rst new file mode 100644 index 00000000000..ba0be46346a --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomRotation.rst @@ -0,0 +1,30 @@ +mindspore.dataset.vision.py_transforms.RandomRotation +===================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomRotation(degrees, resample=, expand=False, center=None, fill_value=0) + + 将输入PIL图像旋转随机角度。 + + **参数：** + + - **degrees** (Union[int, float, sequence]) - 旋转角度的随机选取范围。若输入单个数字，则从(-degrees, degrees)中随机生成旋转角度；若输入2元素序列，需按(min, max)顺序排列。 + - **resample** (Inter，可选) - 插值方式，取值可为 Inter.NEAREST、Inter.ANTIALIAS、Inter.BILINEAR 或 Inter.BICUBIC。若输入的PIL图像模式为"1"或"P"，将直接使用 Inter.NEAREST 作为插值方式。默认为Inter.NEAREST。 + + - **Inter.NEAREST**：最近邻插值。 + - **Inter.ANTIALIAS**：抗锯齿插值。 + - **Inter.BILINEAR**：双线性插值。 + - **Inter.BICUBIC**：双三次插值。 + + - **expand** (bool，可选) - 若为True，将扩展图像大小使其足以容纳整个旋转图像；若为False，则保持图像大小不变。请注意，扩展时将假设图像为中心旋转且未进行平移。 + - **center** (tuple，可选) - 以图像左上角为原点，旋转中心的位置，按照(width, height)顺序排列。默认值：None，表示中心旋转。 + - **fill_value** (Union[int, tuple]，可选) - 旋转图像之外区域的像素填充值。若输入整型，将以该值填充RGB通道；若输入3元素元组，将分别用于填充R、G、B通道。默认值：0。 + + **异常：** + + - **TypeError** - 当 `degrees` 的类型不为整型、浮点型或序列。 + - **TypeError** - 当 `resample` 的类型不为 :class:`Inter` 。 + - **TypeError** - 当 `expand` 的类型不为布尔型。 + - **TypeError** - 当 `center` 的类型不为元组。 + - **TypeError** - 当 `fill_value` 的类型不为整型或整型序列。 + - **ValueError** - 当 `fill_value` 取值不在[0, 255]范围内。 + - **RuntimeError** - 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomSharpness.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomSharpness.rst new file mode 100644 index 00000000000..95b2e2011ae --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomSharpness.rst @@ -0,0 +1,16 @@ +mindspore.dataset.vision.py_transforms.RandomSharpness +====================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomSharpness(degrees=(0.1, 1.9)) + + 随机调整输入PIL图像的锐度。 + + **参数：** + + - **degrees** (sequence) - 锐度调节系数的随机选取范围，按照(min, max)顺序排列。调节系数为0.0时将返回模糊图像；调节系数为1.0时将返回原始图像；调节系数为2.0时将返回锐化图像。默认值：(0.1,1.9)。 + + **异常：** + + - **TypeError** - 当 `degrees` 的类型不为序列。 + - **ValueError** - 当 `degrees` 为负数。 + - **ValueError** - 当 `degrees` 未按照(min, max)顺序排列。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomVerticalFlip.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomVerticalFlip.rst new file mode 100644 index 00000000000..2a3eee0072f --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomVerticalFlip.rst @@ -0,0 +1,16 @@ +mindspore.dataset.vision.py_transforms.RandomVerticalFlip +========================================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.RandomVerticalFlip(prob=0.5) + + 按照指定的概率随机垂直翻转输入的PIL图像。 + + **参数：** + + - **prob** (float，可选) - 执行垂直翻转的概率，默认值：0.5。 + + **异常：** + + - **TypeError** - 当 `prob` 的类型不为浮点型。 + - **ValueError** - 当 `prob` 取值不在[0, 1]范围内。 + - **RuntimeError** - 当输入图像的shape不为或。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Resize.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Resize.rst new file mode 100644 index 00000000000..f840f73b8bf --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.Resize.rst @@ -0,0 +1,22 @@ +mindspore.dataset.vision.py_transforms.Resize +============================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.Resize(size, interpolation=) + + 将输入PIL图像放缩为指定大小。 + + **参数：** + + - **size** (Union[int, sequence]) - 图像放缩的大小。若输入整型，将调整图像的较短边为此值，而保持图像的宽高比不变；若输入2元素序列，则以2个元素分别为高和宽放缩至(height, width)大小。 + - **interpolation** (Inter，可选) - 插值方式，取值可为 Inter.NEAREST、Inter.ANTIALIAS、Inter.BILINEAR 或 Inter.BICUBIC。默认值：Inter.BILINEAR。 + + - **Inter.NEAREST**：最近邻插值。 + - **Inter.ANTIALIAS**：抗锯齿插值。 + - **Inter.BILINEAR**：双线性插值。 + - **Inter.BICUBIC**：双三次插值。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **TypeError** - 当 `interpolation` 的类型不为 :class:`Inter` 。 + - **ValueError** - 当 `size` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RgbToHsv.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RgbToHsv.rst new file mode 100644 index 00000000000..e73701b3a64 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RgbToHsv.rst @@ -0,0 +1,10 @@ +mindspore.dataset.vision.py_transforms.RgbToHsv +=============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.RgbToHsv(is_hwc=False) + + 将输入的RGB格式numpy.ndarray图像转换为HSV格式。 + + **参数：** + + - **is_hwc** (bool) - 若为True，表示输入图像的维度为(H, W, C)或(N, H, W, C)；否则为(C, H, W)或(N, C, H, W)。默认值：False。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.TenCrop.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.TenCrop.rst new file mode 100644 index 00000000000..a24f3921a5f --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.TenCrop.rst @@ -0,0 +1,17 @@ +mindspore.dataset.vision.py_transforms.TenCrop +============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.TenCrop(size, use_vertical_flip=False) + + 在输入PIL图像的中心与四个角处分别裁剪指定大小的子图，并将其翻转图一并返回。 + + **参数：** + + - **size** (Union[int, sequence]) - 裁剪子图的大小。若输入整型，则以该值为边裁剪(size, size)大小的子图；若输入2元素序列，则以2个元素分别为高和宽裁剪(height, width)大小的子图。 + - **use_vertical_flip** (bool，可选) - 若为True，将对子图进行垂直翻转；否则进行水平翻转。默认值：False。 + + **异常：** + + - **TypeError** - 当 `size` 的类型不为整型或整型序列。 + - **TypeError** - 当 `use_vertical_flip` 的类型不为布尔型。 + - **ValueError** - 当 `size` 不为正数。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToPIL.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToPIL.rst new file mode 100644 index 00000000000..ed7f53b0a3b --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToPIL.rst @@ -0,0 +1,12 @@ +mindspore.dataset.vision.py_transforms.ToPIL +============================================ + +.. py:class:: mindspore.dataset.vision.py_transforms.ToPIL + + 将已解码的numpy.ndarray图像转换为PIL图像。 + + .. note:: 转换模式将根据 :class:`PIL.Image.fromarray` 由图像的数据类型决定。 + + **异常：** + + - **TypeError** - 当输入图像的类型不为 :class:`numpy.ndarray` 或 :class:`PIL.Image` 。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToTensor.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToTensor.rst new file mode 100644 index 00000000000..7f66b2033b0 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToTensor.rst @@ -0,0 +1,15 @@ +mindspore.dataset.vision.py_transforms.ToTensor +=============================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.ToTensor(output_type=) + + 将输入的PIL或numpy.ndarray图像转换为指定数据类型的numpy.ndarray图像，此时像素值取值将由[0, 255]变为[0.0, 1.0]，图像的shape将由(H, W, C)变为(C, H, W)。 + + **参数：** + + - **output_type** (numpy.dtype，可选) - 输出图像的数据类型，默认值：numpy.float32。 + + **异常：** + + - **TypeError** - 当输入图像的类型不为 :class:`numpy.ndarray` 或 :class:`PIL.Image` 。 + - **TypeError** - 输入图像的维度不为2或3。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToType.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToType.rst new file mode 100644 index 00000000000..bc5d1d24ba6 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.ToType.rst @@ -0,0 +1,14 @@ +mindspore.dataset.vision.py_transforms.ToType +============================================= + +.. py:class:: mindspore.dataset.vision.py_transforms.ToType(output_type) + + 将输入的numpy.ndarray图像转换为指定数据类型。 + + **参数：** + + - **output_type** (numpy.dtype) - 输出图像的数据类型，例如numpy.float32。 + + **异常：** + + - **TypeError** - 输入图像的类型不为 :class:`numpy.ndarray` 。 diff --git a/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.UniformAugment.rst b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.UniformAugment.rst new file mode 100644 index 00000000000..65099413fd6 --- /dev/null +++ b/docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.UniformAugment.rst @@ -0,0 +1,19 @@ +mindspore.dataset.vision.py_transforms.UniformAugment +===================================================== + +.. py:class:: mindspore.dataset.vision.py_transforms.UniformAugment(transforms, num_ops=2) + + 从指定序列中均匀采样一批数据处理操作，并按顺序随机执行，即采样出的操作也可能不被执行。 + + 序列中的所有数据处理操作要求具有相同的输入和输出类型，以便后一个操作能够处理前一个操作的输出数据。 + + **参数：** + + - **transforms** (sequence) - 数据处理操作序列。 + - **num_ops** (int，可选) - 均匀采样的数据处理操作数，默认值：2。 + + **异常：** + + - **TypeError** - 当 `transforms` 的类型不为数据处理操作序列。 + - **TypeError** - 当 `num_ops` 的类型不为整型。 + - **ValueError** - 当 `num_ops` 不为正数。