Browse Source

修改格式v1

feature/build-system-rewrite
yu-han39 huodagu 4 years ago
parent
commit
fec5a02beb
17 changed files with 43 additions and 38 deletions
  1. +4
    -4
      docs/api/api_python/dataset/mindspore.dataset.DIV2KDataset.rst
  2. +1
    -1
      docs/api/api_python/dataset_text/mindspore.dataset.text.JiebaMode.rst
  3. +1
    -1
      docs/api/api_python/dataset_text/mindspore.dataset.text.NormalizeForm.rst
  4. +1
    -1
      docs/api/api_python/dataset_text/mindspore.dataset.text.SentencePieceModel.rst
  5. +5
    -0
      docs/api/api_python/dataset_text/mindspore.dataset.text.SentencePieceVocab.rst
  6. +1
    -1
      docs/api/api_python/dataset_vision/mindspore.dataset.vision.c_transforms.RandomResizeWithBBox.rst
  7. +2
    -2
      docs/api/api_python/mindspore.boost.rst
  8. +7
    -7
      docs/api/api_python/mindspore.dataset.config.rst
  9. +1
    -1
      docs/api/api_python/nn/mindspore.nn.Cell.rst
  10. +11
    -11
      docs/api/api_python/nn/mindspore.nn.Pad.rst
  11. +2
    -2
      docs/api/api_python/ops/mindspore.ops.AvgPool3D.rst
  12. +2
    -2
      docs/api/api_python/ops/mindspore.ops.Dropout.rst
  13. +1
    -1
      docs/api/api_python/ops/mindspore.ops.DynamicShape.rst
  14. +1
    -1
      docs/api/api_python/ops/mindspore.ops.MaskedFill.rst
  15. +1
    -1
      docs/api/api_python/ops/mindspore.ops.MaxPool3D.rst
  16. +1
    -1
      docs/api/api_python/ops/mindspore.ops.Maximum.rst
  17. +1
    -1
      docs/api/api_python/ops/mindspore.ops.TensorShape.rst

+ 4
- 4
docs/api/api_python/dataset/mindspore.dataset.DIV2KDataset.rst View File

@@ -12,8 +12,8 @@ mindspore.dataset.DIV2KDataset
- **dataset_dir** (str) - 包含数据集文件的根目录路径。
- **usage** (str, 可选) - 指定数据集的子集。可取值为'train'、'valid'或'all'。默认值:'train',全部样本图片。
- **downgrade** (str, 可选) - 指定数据集的下采样的模式,可取值为'bicubic'、'unknown'、'mild'、'difficult'或'wild'。默认值:'bicubic'。
- **scale** (str, 可选) - 指定数据集的缩放尺度。当参数`downgrade` 取值为'bicubic'时,此参数可以取值为2、3、4、8。
当参数`downgrade` 取值为'unknown'时,此参数可以取值为2、3、4。当参数`downgrade` 取值为'mild'、'difficult'、'wild'时,此参数仅可以取值为4。默认值:2。
- **scale** (str, 可选) - 指定数据集的缩放尺度。当参数 `downgrade` 取值为'bicubic'时,此参数可以取值为2、3、4、8。
当参数 `downgrade` 取值为'unknown'时,此参数可以取值为2、3、4。当参数 `downgrade` 取值为'mild'、'difficult'、'wild'时,此参数仅可以取值为4。默认值:2。
- **num_samples** (int, 可选) - 指定从数据集中读取的样本数,可以小于数据集总数。默认值:None,读取全部样本图片。
- **num_parallel_workers** (int, 可选) - 指定读取数据的工作线程数。默认值:None,使用mindspore.dataset.config中配置的线程数。
- **shuffle** (bool, 可选) - 是否混洗数据集。默认值:None,下表中会展示不同参数配置的预期行为。
@@ -46,8 +46,8 @@ mindspore.dataset.DIV2KDataset
:widths: 25 25 50
:header-rows: 1
* - 参数 `sampler`
- 参数 `shuffle`
* - 参数 `sampler`
- 参数 `shuffle`
- 预期数据顺序
* - None
- None


+ 1
- 1
docs/api/api_python/dataset_text/mindspore.dataset.text.JiebaMode.rst View File

@@ -5,7 +5,7 @@

:class:`JiebaTokenizer` 的枚举值。

可选的枚举值包括:`JiebaMode.MIX`、`JiebaMode.MP`和`JiebaMode.HMM`。
可选的枚举值包括: `JiebaMode.MIX` `JiebaMode.MP` `JiebaMode.HMM`

- **JiebaMode.MIX** - 使用最大概率法和隐马尔可夫模型算法混合进行分词。
- **JiebaMode.MP** - 使用最大概率法算法进行分词。


+ 1
- 1
docs/api/api_python/dataset_text/mindspore.dataset.text.NormalizeForm.rst View File

@@ -5,7 +5,7 @@

:class:`NormalizeUTF8` 的枚举值。

可选的枚举值包括:`NormalizeForm.NONE`、`NormalizeForm.NFC`、`NormalizeForm.NFKC`、`NormalizeForm.NFD`和`NormalizeForm.NFKD`。
可选的枚举值包括: `NormalizeForm.NONE` `NormalizeForm.NFC` `NormalizeForm.NFKC` `NormalizeForm.NFD` `NormalizeForm.NFKD`

- **NormalizeForm.NONE** - 对输入字符串不做任何处理。
- **NormalizeForm.NFC** - 对输入字符串进行C形式规范化。


+ 1
- 1
docs/api/api_python/dataset_text/mindspore.dataset.text.SentencePieceModel.rst View File

@@ -5,7 +5,7 @@

`SentencePiece` 分词方法的枚举类。

可选的枚举值包括:`SentencePieceModel.UNIGRAM`、`SentencePieceModel.BPE`、`SentencePieceModel.CHAR`和`SentencePieceModel.WORD`
可选的枚举值包括: `SentencePieceModel.UNIGRAM` `SentencePieceModel.BPE` `SentencePieceModel.CHAR` `SentencePieceModel.WORD`

- **SentencePieceModel.UNIGRAM** - Unigram语言模型意味着句子中的下一个单词被假定为独立于模型生成的前一个单词。
- **SentencePieceModel.BPE** - 指字节对编码算法,它取代了最频繁的对句子中的字节数,其中包含一个未使用的字节。


+ 5
- 0
docs/api/api_python/dataset_text/mindspore.dataset.text.SentencePieceVocab.rst View File

@@ -10,6 +10,7 @@
从数据集构建SentencePiece。

**参数:**

- **dataset** (Dataset) - 表示用于构建SentencePiece对象的数据集。
- **col_names** (list) - 表示列名称的列表。
- **vocab_size** (int) - 表示词汇大小。
@@ -24,6 +25,7 @@
- **params** (dict):表示没有传入参数的字典。

**返回:**

SentencePieceVocab,从数据集构建的vocab。

@@ -32,6 +34,7 @@
从单词列表中构建一个SentencePiece对象。

**参数:**

- **file_path** (list) - 表示包含SentencePiece列表的文件的路径。
- **vocab_size** (int) - 表示词汇大小。
- **character_coverage** (float) - 表示模型涵盖的字符数。推荐的默认值为:0.9995适用于具有丰富字符集的语言,如日文或中文,1.0适用于具有小字符集的其他语言。
@@ -50,6 +53,7 @@
max_sentencepiece_length 16

**返回:**

SentencePieceVocab,表示从文件中构建的vocab。

@@ -58,6 +62,7 @@
将模型保存到给定的文件路径。

**参数:**
- **vocab** (SentencePieceVocab) - 表示一个SentencePiece对象。
- **path** (str) - 表示存储模型的路径。
- **filename** (str) - 表示文件名称。

+ 1
- 1
docs/api/api_python/dataset_vision/mindspore.dataset.vision.c_transforms.RandomResizeWithBBox.rst View File

@@ -7,4 +7,4 @@ mindspore.dataset.vision.c_transforms.RandomResizeWithBBox

**参数:**

- **size** (Union[int, sequence]) - 调整后图像的输出大小。如果 `size` 是一个整数,图像的短边将被调整为`size`大小,并依据短边的调整比例相应调整图像长边的大小。如果 `size` 是一个长度为2的序列,其输入格式应该为 (height, width)。
- **size** (Union[int, sequence]) - 调整后图像的输出大小。如果 `size` 是一个整数,图像的短边将被调整为 `size` 大小,并依据短边的调整比例相应调整图像长边的大小。如果 `size` 是一个长度为2的序列,其输入格式应该为 (height, width)。

+ 2
- 2
docs/api/api_python/mindspore.boost.rst View File

@@ -128,8 +128,8 @@ Boost能够自动加速网络,如减少BN/梯度冻结/累积梯度等。

其中:

- pca_mat (array): 维度(k*n),k是n_components的大小,n是权重的大小。
- bk (array): 维度(k*k),bk是拟牛顿法中的对称正定矩阵。
- pca_mat (array): 维度(k*n),k是n_components的大小,n是权重的大小。
- bk (array): 维度(k*k),bk是拟牛顿法中的对称正定矩阵。

我们需要找到满足以下条件的m:



+ 7
- 7
docs/api/api_python/mindspore.dataset.config.rst View File

@@ -133,7 +133,7 @@ API示例所需模块的导入代码如下:

.. py:function:: mindspore.dataset.config.set_enable_shared_mem(enable)

设置共享内存标志的是否启用。如果 `shared_mem_enable` 为True,则使用共享内存队列将数据传递给为数据集操作而创建的进程,而这些数据集操作将设置`python_multiprocessing`为True。
设置共享内存标志的是否启用。如果 `shared_mem_enable` 为True,则使用共享内存队列将数据传递给为数据集操作而创建的进程,而这些数据集操作将设置 `python_multiprocessing` 为True。

**参数:**

@@ -159,7 +159,7 @@ API示例所需模块的导入代码如下:

.. py:function:: mindspore.dataset.config.set_numa_enable(numa_enable)

设置NUMA的默认状态为启动状态。如果`numa_enable`为True,则需要确保安装了NUMA库。
设置NUMA的默认状态为启动状态。如果 `numa_enable` 为True,则需要确保安装了NUMA库。

**参数:**

@@ -194,11 +194,11 @@ API示例所需模块的导入代码如下:

**异常:**

- **ValueError** - 当`size`小于等于0或`size`大于`MAX_INT_32`时,线程的队列容量无效。
- **ValueError** - 当 `size` 小于等于0或 `size` 大于 `MAX_INT_32` 时,线程的队列容量无效。

.. note::
用于预取的总内存可能会随着工作线程数量的增加而快速增长,所以当工作线程数量大于4时,每个工作线程的预取大小将减少。
每个工作线程在运行时预取大小将是`prefetchsize` * (4 / `num_parallel_workers`)。
每个工作线程在运行时预取大小将是 `prefetchsize` * (4 / `num_parallel_workers` )。

.. py:function:: mindspore.dataset.config.set_seed(seed)
@@ -206,7 +206,7 @@ API示例所需模块的导入代码如下:
如果设置了种子,生成的随机数将被固定,这有助于产生确定性结果。

.. note::
此函数在Python随机库和numpy.random库中设置种子,以便随机进行确定性Python增强。此函数应与创建的每个迭代器一起调用,以重置随机种子。在管道中,这并不保证`num_parallel_workers`大于1。
此函数在Python随机库和numpy.random库中设置种子,以便随机进行确定性Python增强。此函数应与创建的每个迭代器一起调用,以重置随机种子。在管道中,这并不保证 `num_parallel_workers` 大于1。

**参数:**

@@ -214,7 +214,7 @@ API示例所需模块的导入代码如下:

**异常:**

- **ValueError** - `seed` 小于0或 `seed` 大于MAX_UINT_32时,`seed` 无效。
- **ValueError** - `seed` 小于0或 `seed` 大于MAX_UINT_32时, `seed` 无效。

.. py:function:: mindspore.dataset.config.set_sending_batches(batch_num)
@@ -223,7 +223,7 @@ API示例所需模块的导入代码如下:

**参数:**

- **batch_num** (int) - 表示总的发送批次。当设置了`batch_num`时,它将会等待,除非增加发送批次。默认值为0,表示将发送数据集中的所有批次。
- **batch_num** (int) - 表示总的发送批次。当设置了 `batch_num` 时,它将会等待,除非增加发送批次。默认值为0,表示将发送数据集中的所有批次。

**异常:**



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

@@ -345,7 +345,7 @@
指定输入/输出tensor的分布策略,其余算子的策略推导得到。在PyNative模式下,可以利用此方法指定某个cell以图模式进行分布式执行。
in_axes/out_axes需要为元组类型,其中的每一个元素指定对应的输入/输出的tensor分布策略,其类型需要为元组,
可参考:`mindspore.ops.Primitive.shard`的描述,也可以设置为None,会默认以数据并行执行。
可参考: `mindspore.ops.Primitive.shard` 的描述,也可以设置为None,会默认以数据并行执行。
.. note:: 需设置为Pyative模式,并且全自动并行(AUTO_PARALLEL),同时search mode为sharding_propagation,或半自动并行(SEMI_AUTO_PARALLEL)。


+ 11
- 11
docs/api/api_python/nn/mindspore.nn.Pad.rst View File

@@ -9,17 +9,17 @@ mindspore.nn.Pad

- **paddings** (tuple) - 填充大小,其shape为(N, 2),N是输入数据的维度,填充的元素为int类型。对于 `x` 的第 `D` 个维度,paddings[D, 0]表示要在输入Tensor的第 `D` 个维度之前扩展的大小,paddings[D, 1]表示在输入Tensor的第 `D` 个维度后面要扩展的大小。输出的每个维度D的填充大小为: :math:`paddings[D, 0] + input\_x.dim\_size(D) + paddings[D, 1]`

.. code-block::
# 假设参数和输入如下:
mode = "CONSTANT".
paddings = [[1,1], [2,2]].
x = [[1,2,3], [4,5,6], [7,8,9]].
# `x` 的第一个维度为3, `x` 的第二个维度为3。
# 根据以上公式可得:
# 输出的第一个维度是paddings[0][0] + 3 + paddings[0][1] = 1 + 3 + 1 = 5。
# 输出的第二个维度是paddings[1][0] + 3 + paddings[1][1] = 2 + 3 + 2 = 7。
# 所以最终的输出shape为(5, 7)
.. code-block::
# 假设参数和输入如下:
mode = "CONSTANT".
paddings = [[1,1], [2,2]].
x = [[1,2,3], [4,5,6], [7,8,9]].
# `x` 的第一个维度为3, `x` 的第二个维度为3。
# 根据以上公式可得:
# 输出的第一个维度是paddings[0][0] + 3 + paddings[0][1] = 1 + 3 + 1 = 5。
# 输出的第二个维度是paddings[1][0] + 3 + paddings[1][1] = 2 + 3 + 2 = 7。
# 所以最终的输出shape为(5, 7)

- **mode** (str) - 指定填充模式。取值为"CONSTANT","REFLECT","SYMMETRIC"。默认值:"CONSTANT"。



+ 2
- 2
docs/api/api_python/ops/mindspore.ops.AvgPool3D.rst View File

@@ -43,12 +43,12 @@

- **TypeError** - `kernel_size` 、 `strides` 或 `pad` 既不是int也不是tuple。
- **TypeError** - `ceil_mode` 或 `count_include_pad` 不是bool。
- **TypeError** - `pad_mode` 或`data_format` 不是string。
- **TypeError** - `pad_mode` 或 `data_format` 不是string。
- **TypeError** - `divisor_override` 不是int。
- **ValueError** - `kernel_size` 或 `strides` 中的数字不是正数。
- **ValueError** - `kernel_size` 或 `strides` 是长度不等于3的tuple。
- **ValueError** - `pad_mode` 不是'same','valid',或'pad'。
- **ValueError** - `pad` 是长度不等于6的tuple。
- **ValueError** - `pad` 的元素小于0。
- **ValueError** - `pad_mode` 不等于'pad'且`pad`不等于0或(0, 0, 0, 0, 0, 0)。
- **ValueError** - `pad_mode` 不等于'pad'且 `pad` 不等于0或(0, 0, 0, 0, 0, 0)。
- **ValueError** - `data_format` 不是'NCDHW'。

+ 2
- 2
docs/api/api_python/ops/mindspore.ops.Dropout.rst View File

@@ -3,7 +3,7 @@

.. py:class:: mindspore.ops.Dropout(keep_prob=0.5, Seed0=0, Seed1=0)

Dropout是一种正则化手段,该算子根据丢弃概率 :math:`1 - keep\_prob` ,在训练过程中随机将一些神经元输出设置为0,通过阻止神经元节点间的相关性来减少过拟合。
Dropout是一种正则化手段,该算子根据丢弃概率 :math:`1 - keep\_prob` ,在训练过程中随机将一些神经元输出设置为0,通过阻止神经元节点间的相关性来减少过拟合。

**参数:**

@@ -23,6 +23,6 @@
**异常:**

- **TypeError** - `keep_prob` 不是float。
- **TypeError** - `Seed0` 或`Seed1` 不是int。
- **TypeError** - `Seed0` 或 `Seed1` 不是int。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **TypeError** - `x` 不是Tensor。

+ 1
- 1
docs/api/api_python/ops/mindspore.ops.DynamicShape.rst View File

@@ -3,4 +3,4 @@ mindspore.ops.DynamicShape

.. py:class:: mindspore.ops.DynamicShape

与`TensorShape`相同,`DynamicShape`将会被`TensorShape`替换,请使用`TensorShape`。
`TensorShape` 相同, `DynamicShape` 将会被 `TensorShape` 替换,请使用 `TensorShape`

+ 1
- 1
docs/api/api_python/ops/mindspore.ops.MaskedFill.rst View File

@@ -5,7 +5,7 @@ mindspore.ops.MaskedFill

掩码为True位置的值将被指定的值填充。

`input`和 `mask` 的shape需相同或可广播。
`input` 和 `mask` 的shape需相同或可广播。

**输入:**



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.MaxPool3D.rst View File

@@ -18,7 +18,7 @@ mindspore.ops.MaxPool3D
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长,整数类型,表示深、高和宽的移动步长,或者是三个整数组成的元组,表示深、高和宽移动步长。默认值:1。
- **pad_mode** (str) - 指定池化填充模式,可选值有:"same"或"valid"。默认值:"valid"。

- same:输出的宽度于输入整数`stride`后的值相同。
- same:输出的宽度于输入整数 `stride` 后的值相同。
- valid:在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- pad:对输入进行填充。 在输入的深度、高度和宽度方向上填充 `pad` 大小的0。如果设置此模式, `pad` 必须大于或等于0。



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.Maximum.rst View File

@@ -27,5 +27,5 @@ mindspore.ops.Maximum

**异常:**

- **TypeError** - `x`和 `y` 不是以下之一:Tensor,Number,bool。
- **TypeError** - `x` 和 `y` 不是以下之一:Tensor,Number,bool。
- **ValueError** - `x` 和 `y` 的shape不相同。

+ 1
- 1
docs/api/api_python/ops/mindspore.ops.TensorShape.rst View File

@@ -11,7 +11,7 @@ mindspore.ops.TensorShape

**输出:**

Tensor,输入`input_x`的shape
Tensor,输入 `input_x` 的shape

**异常:**



Loading…
Cancel
Save