Browse Source

!29375 modify doc

Merge pull request !29375 from xumengjuan1/code_docs_xmjformat8
feature/build-system-rewrite
i-robot Gitee 4 years ago
parent
commit
88ef81663f
No known key found for this signature in database GPG Key ID: 173E9B9CA92EEF8F
3 changed files with 4 additions and 4 deletions
  1. +1
    -1
      docs/api/api_python/dataset/mindspore.dataset.Dataset.rst
  2. +2
    -2
      docs/api/api_python/dataset_audio/mindspore.dataset.audio.transforms.FrequencyMasking.rst
  3. +1
    -1
      docs/api/api_python/nn/mindspore.nn.TopKCategoricalAccuracy.rst

+ 1
- 1
docs/api/api_python/dataset/mindspore.dataset.Dataset.rst View File

@@ -15,7 +15,7 @@
- **TypeError:** `apply_func` 的类型不是函数。 - **TypeError:** `apply_func` 的类型不是函数。
- **TypeError:** `apply_func` 未返回Dataset对象。 - **TypeError:** `apply_func` 未返回Dataset对象。
.. py:method:: batch(batch_size, drop_remainder=False, num_parallel_workers=None, per_batch_map=None, input_columns=None, output_columns=None, column_order=None, pad_info=None, python_multiprocessing=False)
.. py:method:: batch(batch_size, drop_remainder=False, num_parallel_workers=None, per_batch_map=None, input_columns=None, output_columns=None, column_order=None, pad_info=None, python_multiprocessing=False, max_rowsize=16)
将数据集中连续 `batch_size` 条数据合并为一个批处理数据。 将数据集中连续 `batch_size` 条数据合并为一个批处理数据。


+ 2
- 2
docs/api/api_python/dataset_audio/mindspore.dataset.audio.transforms.FrequencyMasking.rst View File

@@ -1,7 +1,7 @@
mindspore.dataset.audio.transforms.FrequencyMasking mindspore.dataset.audio.transforms.FrequencyMasking
=================================================== ===================================================


.. py:class:: mindspore.dataset.audio.transforms.FrequencyMasking(iid_masks=False, frequency_mask_param=0, mask_start=0, mask_value=0.0)
.. py:class:: mindspore.dataset.audio.transforms.FrequencyMasking(iid_masks=False, freq_mask_param=0, mask_start=0, mask_value=0.0)


给音频波形施加频域掩码。 给音频波形施加频域掩码。


@@ -10,7 +10,7 @@ mindspore.dataset.audio.transforms.FrequencyMasking
**参数:** **参数:**


- **iid_masks** (bool, 可选) - 是否施加随机掩码,默认值:False。 - **iid_masks** (bool, 可选) - 是否施加随机掩码,默认值:False。
- **frequency_mask_param** (int, 可选) - 当 `iid_masks` 为True时,掩码长度将从[0, freq_mask_param]中均匀采样;当 `iid_masks` 为False时,直接使用该值作为掩码长度。取值范围为[0, freq_length],其中 `freq_length` 为音频波形在频域的长度,默认值:0。
- **freq_mask_param** (int, 可选) - 当 `iid_masks` 为True时,掩码长度将从[0, freq_mask_param]中均匀采样;当 `iid_masks` 为False时,直接使用该值作为掩码长度。取值范围为[0, freq_length],其中 `freq_length` 为音频波形在频域的长度,默认值:0。
- **mask_start** (int, 可选) - 添加掩码的起始位置,只有当 `iid_masks` 为True时,该值才会生效。取值范围为[0, freq_length - frequency_mask_param],其中 `freq_length` 为音频波形在频域的长度,默认值:0。 - **mask_start** (int, 可选) - 添加掩码的起始位置,只有当 `iid_masks` 为True时,该值才会生效。取值范围为[0, freq_length - frequency_mask_param],其中 `freq_length` 为音频波形在频域的长度,默认值:0。
- **mask_value** (float, 可选) - 掩码填充值,默认值:0.0。 - **mask_value** (float, 可选) - 掩码填充值,默认值:0.0。




+ 1
- 1
docs/api/api_python/nn/mindspore.nn.TopKCategoricalAccuracy.rst View File

@@ -7,7 +7,7 @@ mindspore.nn.TopKCategoricalAccuracy


**参数:** **参数:**


**k (int)** - 计算准确率使用的Top类别数。
**k** (int) - 计算准确率使用的Top类别数。


**异常:** **异常:**




Loading…
Cancel
Save