From 910194de121b6735354d579bdddec8ae482f0d2c Mon Sep 17 00:00:00 2001 From: liu-yongqi-63 Date: Fri, 22 Apr 2022 14:58:06 +0800 Subject: [PATCH] Supplementary API documentation parameters are not marked optional when optional --- ...ndspore.dataset.vision.py_transforms.RandomSharpness.rst | 2 +- mindspore/python/mindspore/dataset/audio/transforms.py | 6 +++--- mindspore/python/mindspore/dataset/vision/py_transforms.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) 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 index e2ba387e2b1..fb8528ba5c7 100644 --- 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 @@ -7,7 +7,7 @@ mindspore.dataset.vision.py_transforms.RandomSharpness **参数:** - - **degrees** (Sequence[float, float]) - 锐度调节系数的随机选取范围,按照(min, max)顺序排列。调节系数为0.0时将返回模糊图像;调节系数为1.0时将返回原始图像;调节系数为2.0时将返回锐化图像。默认值:(0.1, 1.9)。 + - **degrees** (Sequence[float, float],可选) - 锐度调节系数的随机选取范围,按照(min, max)顺序排列。调节系数为0.0时将返回模糊图像;调节系数为1.0时将返回原始图像;调节系数为2.0时将返回锐化图像。默认值:(0.1, 1.9)。 **异常:** diff --git a/mindspore/python/mindspore/dataset/audio/transforms.py b/mindspore/python/mindspore/dataset/audio/transforms.py index 219be13b331..0e733ff0ec9 100644 --- a/mindspore/python/mindspore/dataset/audio/transforms.py +++ b/mindspore/python/mindspore/dataset/audio/transforms.py @@ -862,7 +862,7 @@ class FrequencyMasking(AudioTensorOperation): from [0, freq_mask_param]; When `iid_masks` is False, directly use it as length of the mask. The value should be in range of [0, freq_length], where `freq_length` is the length of audio waveform in frequency domain. Default: 0. - mask_start (int): Starting point to apply mask, only works when `iid_masks` is True. The value should + mask_start (int, optional): Starting point to apply mask, only works when `iid_masks` is True. The value should be in range of [0, freq_length - freq_mask_param], where `freq_length` is the length of audio waveform in frequency domain. Default: 0. mask_value (float, optional): Value to assign to the masked columns. Default: 0.0. @@ -1533,11 +1533,11 @@ class TimeMasking(AudioTensorOperation): Args: iid_masks (bool, optional): Whether to apply different masks to each example/channel. Default: False. - time_mask_param (int): When `iid_masks` is True, length of the mask will be uniformly sampled + time_mask_param (int, optional): When `iid_masks` is True, length of the mask will be uniformly sampled from [0, time_mask_param]; When `iid_masks` is False, directly use it as length of the mask. The value should be in range of [0, time_length], where `time_length` is the length of audio waveform in time domain. Default: 0. - mask_start (int): Starting point to apply mask, only works when `iid_masks` is True. The value should + mask_start (int, optional): Starting point to apply mask, only works when `iid_masks` is True. The value should be in range of [0, time_length - time_mask_param], where `time_length` is the length of audio waveform in time domain. Default: 0. mask_value (float, optional): Value to assign to the masked columns. Default: 0.0. diff --git a/mindspore/python/mindspore/dataset/vision/py_transforms.py b/mindspore/python/mindspore/dataset/vision/py_transforms.py index f6a43bd7822..7c0ab61e35f 100644 --- a/mindspore/python/mindspore/dataset/vision/py_transforms.py +++ b/mindspore/python/mindspore/dataset/vision/py_transforms.py @@ -1582,7 +1582,7 @@ class RandomSharpness(py_transforms.PyTensorOperation): Adjust the sharpness of the input PIL Image by a random degree. Args: - degrees (Sequence[float, float]): Range of sharpness adjustment degree to select from, arranged + degrees (Sequence[float, float], optional): Range of sharpness adjustment degree to select from, arranged in order of (min, max). A degree of 0.0 gives a blurred image, a degree of 1.0 gives the original image and a degree of 2.0 gives a sharpened image. Default: (0.1, 1.9).