Nigel
/
mindspore
forked from mindspore-Ecosystem/mindspore
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Supplementary API documentation parameters are not marked optional when optional

This commit is contained in:
liu-yongqi-63 2022-04-22 14:58:06 +08:00
parent 5b8ef1a4c1
commit 910194de12
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/api_python/dataset_vision/mindspore.dataset.vision.py_transforms.RandomSharpness.rst
View File

@ -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)。
**异常：**

6
mindspore/python/mindspore/dataset/audio/transforms.py
View File

@ -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.

2
mindspore/python/mindspore/dataset/vision/py_transforms.py
View File

@ -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).