!44180 modify format

Merge pull request !44180 from 俞涵/code_docs_1010
This commit is contained in:
i-robot 2022-10-19 06:37:13 +00:00 committed by Gitee
commit 082e07896f
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
7 changed files with 18 additions and 18 deletions

View File

@ -1,7 +1,7 @@
mindspore.dataset.Dataset.padded_batch
======================================
.. py:method:: mindspore.dataset.Dataset.padded_batch(batch_size, drop_remainder=False, num_parallel_workers=None, pad_info=None
.. py:method:: mindspore.dataset.Dataset.padded_batch(batch_size, drop_remainder=False, num_parallel_workers=None, pad_info=None)
将数据集中连续 `batch_size` 条数据合并为一个批处理数据其中batch成一个Tensor前可选择使用pad_info预先将样本补齐。

View File

@ -138,7 +138,7 @@ mindspore.rewrite
返回:
当前SymbolTree中节点的生成器。
.. py:method:: mindspore.rewrite.SymbolTree.print_node_tabulate()
.. py:method:: mindspore.rewrite.SymbolTree.print_node_tabulate()
打印当前SymbolTree的节点信息表格。

View File

@ -9,12 +9,12 @@ mindspore.obfuscate_model
- **obf_config** (dict) - 模型混淆配置选项字典。
- **type** (str) - 混淆类型,目前支持动态混淆,即'dynamic'。
- **original_model_path** (str) - 待混淆的MindIR模型地址。如果该模型是加密文件的则需要在`kwargs`中传入`enc_key``enc_mode`
- **original_model_path** (str) - 待混淆的MindIR模型地址。如果该模型是加密文件的则需要在 `kwargs` 中传入 `enc_key` `enc_mode`
- **save_model_path** (str) - 混淆模型的保存地址。
- **model_inputs** (list[Tensor]) - 模型的推理输入Tensor的值可以是随机的和使用`export()`接口类似。
- **model_inputs** (list[Tensor]) - 模型的推理输入Tensor的值可以是随机的和使用 `export()` 接口类似。
- **obf_ratio** (Union[str, float]) - 全模型算子的混淆比例,可取浮点数(0, 1]或者字符串"small"、"medium"、"large"。
- **customized_func** (function) - 在自定义函数模式下需要设置的Python函数用来控制混淆结构中的选择分支走向。它的返回值需要是bool类型且是恒定的用户可以参考不透明谓词进行设置。如果设置了`customized_func`,那么在使用`load`接口导入模型的时候,需要把这个函数也传入。
- **obf_password** (int) - 秘密口令用于password模式是一个大于0的整数。如果用户设置了`obf_password`,那么在部署混淆模型的时候,需要在`nn.GraphCell()`接口中传入`obf_password`。需要注意的是,如果用户同时设置了`customized_func``obf_password`那么password模式将会被采用。
- **customized_func** (function) - 在自定义函数模式下需要设置的Python函数用来控制混淆结构中的选择分支走向。它的返回值需要是bool类型且是恒定的用户可以参考不透明谓词进行设置。如果设置了 `customized_func` ,那么在使用 `load` 接口导入模型的时候,需要把这个函数也传入。
- **obf_password** (int) - 秘密口令用于password模式是一个大于0的整数。如果用户设置了 `obf_password` ,那么在部署混淆模型的时候,需要在 `nn.GraphCell()` 接口中传入 `obf_password` 。需要注意的是,如果用户同时设置了 `customized_func` `obf_password` 那么password模式将会被采用。
- **kwargs** (dict) - 配置选项字典。

View File

@ -16,7 +16,7 @@ mindspore.nn.FractionalMaxPool3d
- **output_size** (Union[int, tuple[int]]) - 目标输出大小。如果是整数则表示输出目标的深、高和宽。如果是tuple其值必须包含三个整数值分别表示目标输出的深、高和宽。默认值是 `None`
- **output_ratio** (Union[float, tuple[float]]) - 目标输出shape与输入shape的比率。通过输入shape和 `output_ratio` 确定输出shape。支持数据类型float16、float32、double数值介于0到1之间。默认值是 `None`
- **return_indices** (bool) - 如果为 `True` ,返回分数最大池化的最大值的的索引值。默认值是 `False`
- **random_samples** (Tensor) - 随机步长。支持的数据类型float16、float32、double。shape为 :math:`(N, C, 3)` 的Tensor。数值介于0到1之间。默认值是 `None`
- **_random_samples** (Tensor) - 随机步长。支持的数据类型float16、float32、double。shape为 :math:`(N, C, 3)` 的Tensor。数值介于0到1之间。默认值是 `None`
输入:
- **input_x** (Tensor) - 4维或5维的张量支持的数据类型float16、float32、double、int32、int64。支持shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})`

View File

@ -13,15 +13,15 @@ mindspore.ops.broadcast_to
- 情况一如果目标shape该维的值为-1 则输出shape该维的值为对应输入shape该维的值。比如说输入shape为 :math:`(3, 3)` 目标shape为 :math:`(-1, 3)` 则输出shape为 :math:`(3, 3)`
- 情况二如果目标shape该维的值不为-1但是输入shape该维的值为1则输出shape该维的值为目标shape该维的值。比如说输入shape为 :math:` (1, 3)` 目标shape为 :math:`(8, 3)` 则输出shape为 :math:`(8, 3)`
- 情况二如果目标shape该维的值不为-1但是输入shape该维的值为1则输出shape该维的值为目标shape该维的值。比如说输入shape为 :math:`(1, 3)` 目标shape为 :math:`(8, 3)` 则输出shape为 :math:`(8, 3)`
- 情况三如果两个shape对应值不满足以上情况则说明不支持由输入shape广播到目标shape。
至此输出shape后面m维就确定好了现在看一下前面 :math:`*` 维,有以下两种情况:
- 如果额外的 :math:`*` 维中不含有-1则输入shape从低维度补充维度使之与目标shape维度一致比如说目标shape为 :math:` (3, 1, 4, 1, 5, 9)` 输入shape为 :math:`(1, 5, 9)` 则输入shape增维变成 :math:`(1, 1, 1, 1, 5, 9)`根据上面提到的情况二可以得出输出shape为 :math:` (3, 1, 4, 1, 5, 9)`
- 如果额外的 :math:`*` 维中不含有-1则输入shape从低维度补充维度使之与目标shape维度一致比如说目标shape为 :math:`(3, 1, 4, 1, 5, 9)` 输入shape为 :math:`(1, 5, 9)` 则输入shape增维变成 :math:`(1, 1, 1, 1, 5, 9)`根据上面提到的情况二可以得出输出shape为 :math:`(3, 1, 4, 1, 5, 9)`
- 如果额外的 :math:`*` 维中含有-1说明此时该-1对应一个不存在的维度不支持广播。比如说目标shape为 :math:` (3, -1, 4, 1, 5, 9)` 输入shape为 :math:`(1, 5, 9)` ,此时不进行增维处理,而是直接报错。
- 如果额外的 :math:`*` 维中含有-1说明此时该-1对应一个不存在的维度不支持广播。比如说目标shape为 :math:`(3, -1, 4, 1, 5, 9)` 输入shape为 :math:`(1, 5, 9)` ,此时不进行增维处理,而是直接报错。
参数:
- **x** (Tensor) - 第一个输入任意维度的Tensor数据类型为float16、float32、int32、int8、uint8、bool。

View File

@ -25,16 +25,16 @@ mindspore.train.BackupAndRestore
参数:
- **run_context** (RunContext) - 包含模型的一些基本信息。详情请参考 :class:`mindspore.train.RunContext`
.. py:method:: on_train_end(run_context)
在训练结束时判断是否删除备份的checkpoint文件。
参数:
- **run_context** (RunContext) - 包含模型的一些基本信息。详情请参考 :class:`mindspore.train.RunContext`
.. py:method:: on_train_epoch_end(run_context)
在每个epoch结束时判断是否需要备份checkpoint文件。
参数:
- **run_context** (RunContext) - 包含模型的一些基本信息。详情请参考 :class:`mindspore.train.RunContext`
.. py:method:: on_train_end(run_context)
在训练结束时判断是否删除备份的checkpoint文件。
参数:
- **run_context** (RunContext) - 包含模型的一些基本信息。详情请参考 :class:`mindspore.train.RunContext`

View File

@ -1253,7 +1253,7 @@ class FractionalMaxPool3d(Cell):
Supported shape :math:`(N, C, 3)`
Inputs:
- **imput_x** (Tensor) - The input of FractionalMaxPool3d, which is a 4D or 5D tensor.
- **input_x** (Tensor) - The input of FractionalMaxPool3d, which is a 4D or 5D tensor.
Tensor of data type : float16, float32, double, int32, int64.
Supported shape :math:`(N, C, D_{in}, H_{in}, W_{in})` .