diff --git a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.MelSpectrogram.rst b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.MelSpectrogram.rst index aeec44011d3..cd2e1607c97 100644 --- a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.MelSpectrogram.rst +++ b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.MelSpectrogram.rst @@ -45,7 +45,7 @@ mindspore.dataset.audio.MelSpectrogram - **ValueError** - 如果 `n_mels` 为负数。 - **ValueError** - 如果 `f_min` 大于 `f_max` 。 - **ValueError** - 如果 `f_max` 为负数。 - - **ValueError** - 当 `f_max`为None时, 如果 `f_min` 大于 `sample_rate // 2` 。 + - **ValueError** - 当 `f_max` 为None时, 如果 `f_min` 大于 `sample_rate // 2` 。 - **ValueError** - 如果 `power` 不为正数。 - **ValueError** - 如果 `pad` 为负数。 - **ValueError** - 如果 `win_length` 不为正数。 diff --git a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.PitchShift.rst b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.PitchShift.rst index ca1b2db638a..b4ae74da8f0 100644 --- a/docs/api/api_python/dataset_audio/mindspore.dataset.audio.PitchShift.rst +++ b/docs/api/api_python/dataset_audio/mindspore.dataset.audio.PitchShift.rst @@ -5,7 +5,7 @@ mindspore.dataset.audio.PitchShift 将波形的音调移动 `n_steps` 步长。 - 参数: + 参数： - **sample_rate** (int) - 波形的采样频率（单位：Hz）。 - **n_steps** (int) - 移动波形的步长。 - **bins_per_octave** (int, 可选) - 每倍频程的步长。默认值：12。 @@ -14,7 +14,7 @@ mindspore.dataset.audio.PitchShift - **hop_length** (int, 可选) - STFT窗口之间的跳跃长度。默认值：None，则将设置为 `win_length // 4` 。 - **window** (WindowType, 可选) - 作用于每一帧的窗口函数。默认值：WindowType.HANN。 - 异常: + 异常： - **TypeError** - 如果 `sample_rate` 的类型不为int。 - **TypeError** - 如果 `n_steps` 的类型不为int。 - **TypeError** - 如果 `bins_per_octave` 的类型不为int。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_random_gamma.rst b/docs/api/api_python/ops/mindspore.ops.func_random_gamma.rst index 09a71f7331f..887d33bcb85 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_random_gamma.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_random_gamma.rst @@ -8,13 +8,13 @@ mindspore.ops.random_gamma 参数： - **shape** (Tensor) - 指定生成随机数的shape。任意维度的Tensor。 - **alpha** (Tensor) - :math:`\alpha` 分布的参数。应该大于0且数据类型为half、float32或者float64。 - - **seed** (int) - 随机数生成器的种子，必须是非负数，默认为None。 + - **seed** (int, 可选) - 随机数生成器的种子，必须是非负数，默认为None。 返回： Tensor。shape是输入 `shape` 、 `alpha` 拼接后的shape。数据类型和alpha一致。 异常： - - **TypeError** – `shape` 不是Tensor。 - - **TypeError** – `alpha` 不是Tensor。 - - **TypeError** – `seed` 的数据类型不是int。 - - **TypeError** – `alpha` 的数据类型不是half、float32或者float64。 + - **TypeError** - `shape` 不是Tensor。 + - **TypeError** - `alpha` 不是Tensor。 + - **TypeError** - `seed` 的数据类型不是int。 + - **TypeError** - `alpha` 的数据类型不是half、float32或者float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_random_poisson.rst b/docs/api/api_python/ops/mindspore.ops.func_random_poisson.rst index aa53d993f58..499998fa100 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_random_poisson.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_random_poisson.rst @@ -12,7 +12,7 @@ mindspore.ops.random_poisson 参数： - **shape** (Tensor) - 表示要从每个分布中采样的随机数张量的形状。必须是一个一维的张量且数据类型必须是 `mindspore.dtype.int32` 或者 `mindspore.dtype.int64` 。 - **rate** (Tensor) - 泊松分布的 :math:`μ` 参数，表示泊松分布的均值，同时也是分布的方差。必须是一个张量，且其数据类型必须是以下类型中的一种：mindspore.dtype.int64，mindspore.dtype.int32，mindspore.dtype.float64，mindspore.dtype.float32或者mindspore.dtype.float16。 - - **seed** (int) - 随机数种子，用于在随机数引擎中产生随机数。必须是一个非负的整数。默认值是None，表示使用0作为随机数种子。 + - **seed** (int, 可选) - 随机数种子，用于在随机数引擎中产生随机数。必须是一个非负的整数。默认值是None，表示使用0作为随机数种子。 - **dtype** (mindspore.dtype) - 表示要生成的随机数张量的数据类型。必须是mindspore.dtype类型，可以是以下值中的一种：mindspore.dtype.int64，mindspore.dtype.int32，mindspore.dtype.float64，mindspore.dtype.float32或者mindspore.dtype.float16。 返回： diff --git a/docs/api/api_python/ops/mindspore.ops.func_shuffle.rst b/docs/api/api_python/ops/mindspore.ops.func_shuffle.rst index 2bb0f0cb253..70ba6105727 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_shuffle.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_shuffle.rst @@ -7,7 +7,7 @@ mindspore.ops.shuffle 参数： - **x** (Tensor) - 需要随机打乱的Tensor。 - - **seed** (int) - 随机数种子，用于生成随机数，必须为非负数。如果 `seed` 为0，则替换为随机生成的值。默认值是None, 表示使用0作为随机数种子。 + - **seed** (int, 可选) - 随机数种子，用于生成随机数，必须为非负数。如果 `seed` 为0，则替换为随机生成的值。默认值是None, 表示使用0作为随机数种子。 返回： Tensor，与输入相同的shape和类型。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_standard_laplace.rst b/docs/api/api_python/ops/mindspore.ops.func_standard_laplace.rst index c50fb4fd264..b6866bccb8b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_standard_laplace.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_standard_laplace.rst @@ -11,14 +11,12 @@ mindspore.ops.standard_laplace 参数： - **shape** (Union[tuple, Tensor]) - 待生成的Tensor的shape。当为tuple类型时，只支持常量值；当为Tensor类型时，支持动态Shape。 - - **seed** (int) - 算子层的随机种子，用于生成随机数。必须是非负的。默认值：None。 + - **seed** (int, 可选) - 算子层的随机种子，用于生成随机数。必须是非负的。默认值：None。 返回： Tensor，其shape为输入 `shape`。数据类型为float32。 异常： - - **TypeError** - `seed` 不是int。 - **TypeError** - `shape` 既不是tuple，也不是Tensor。 - - **ValueError** - `seed` 不是非负的int。 - **ValueError** - `shape` 为tuple时，包含非正的元素。 - **ValueError** - `shape` 为秩不等于1的Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_standard_normal.rst b/docs/api/api_python/ops/mindspore.ops.func_standard_normal.rst index 876ada31e55..cf26216d028 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_standard_normal.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_standard_normal.rst @@ -12,13 +12,11 @@ mindspore.ops.standard_normal 参数： - **shape** (Union[tuple, Tensor]) - 待生成的Tensor的shape。当为tuple类型时，只支持常量值；当为Tensor类型时，支持动态Shape。 - - **seed** (int) - 随机种子，非负值。默认值：None。 + - **seed** (int, 可选) - 随机种子，非负值。默认值：None。 返回： Tensor。shape为输入 `shape` 。数据类型支持float32。 异常： - - **TypeError** - `seed` 不是int类型。 - **TypeError** - `shape` 既不是tuple，也不是Tensor。 - - **ValueError** - `seed` 不是非负的int。 - **ValueError** - `shape` 为tuple时，包含非正的元素。