fix some error format.

This commit is contained in:
zhangyi 2022-01-25 14:28:23 +08:00
parent 55c6ff5dab
commit 246e958100
9 changed files with 14 additions and 8 deletions

View File

@ -1,11 +1,11 @@
.. py:method:: add_child(sampler)
为给定采样器添加子采样器。子采样器接收父采样器输出数据作为输入,并应用其采样逻辑返回新的采样结果。
**参数:**
- **sampler** (Sampler) - 用于从数据集中选择样本的对象。仅支持内置采样器DistributedSampler、PKSampler、RandomSampler、SequentialSampler、SubsetRandomSampler、WeightedRandomSampler
.. py:method:: get_child()
获取给定采样器的子采样器。
获取给定采样器的子采样器。

View File

@ -1,3 +1,6 @@
mindspore.dataset.zip
=====================
.. py:function:: mindspore.dataset.zip(datasets)
将多个dataset对象按列进行合并压缩。

View File

@ -75,4 +75,4 @@ mindspore.nn.FTRL
- **ValueError** - `initial_accum``l1``l2` 小于0。
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst

View File

@ -69,4 +69,4 @@ mindspore.nn.LazyAdam
- **ValueError** - `beta1``beta2` 不在0.0,1.0)范围内。
- **ValueError** - `weight_decay` 小于0。
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst

View File

@ -1,3 +1,6 @@
mindspore.nn.PipelineCell
=========================
.. py:class:: mindspore.nn.PipelineCell(network, micro_size)
将MiniBatch切分成更细粒度的MicroBatch用于流水线并行的训练中。

View File

@ -66,4 +66,4 @@ mindspore.nn.ProximalAdagrad
- **ValueError** - `accum``l1``l2``weight_decay` 小于0。
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst
.. include:: mindspore.nn.optim_target_unique_for_sparse.rst

View File

@ -5,7 +5,7 @@
它可以帮助收集loss、学习率、计算图等。
SummaryCollector还可以允许通过 `summary算子 <https://www.mindspore.cn/mindinsight/docs/zh-CN/master/summary_record.html#summarysummarycollector>`_ 将数据收集到summary文件中。
.. note::
.. note::
- 不允许在回调列表中存在多个SummaryCollector实例。
- 并非所有信息都可以在训练阶段或评估阶段收集。
- SummaryCollector始终记录summary算子收集的数据。
@ -25,7 +25,7 @@
- **collect_input_data** (bool) - 表示是否为每次训练收集数据集。目前仅支持图像数据。如果数据集中有多列数据则第一列应为图像数据。默认值True。
- **collect_dataset_graph** (bool) - 表示是否收集训练阶段的数据集图。默认值True。
- **histogram_regular** (Union[str, None]) - 收集参数分布页面的权重和偏置并在MindInsight中展示。此字段允许正则表达式控制要收集的参数。不建议一次收集太多参数因为这会影响性能。注如果收集的参数太多并且内存不足训练将会失败。默认值None表示只收集网络的前五个超参。
- **keep_default_action** (bool) - 此字段影响 `collect_specified_data` 字段的收集行为。True表示设置指定数据后其他数据按默认设置收集。False表示设置指定数据后只收集指定数据不收集其他数据。默认值True。
- **custom_lineage_data** (Union[dict, None]) - 允许您自定义数据并将数据显示在MindInsight的lineage页面上。在自定义数据中key支持str类型value支持str、int和float类型。默认值None表示不存在自定义数据。
- **collect_tensor_freq** (Optional[int]) - 语义与 `collect_freq` 的相同但仅控制TensorSummary。由于TensorSummary数据太大无法与其他summary数据进行比较因此此参数用于降低收集量。默认情况下收集TensorSummary数据的最大step数量为20但不会超过收集其他summary数据的step数量。例如给定 `collect_freq=10` 当总step数量为600时TensorSummary将收集20个step而收集其他summary数据时会收集61个step。但当总step数量为20时TensorSummary和其他summary将收集3个step。另外请注意在并行模式下会平均分配总的step数量这会影响TensorSummary收集的step的数量。默认值None表示要遵循上述规则。
@ -33,7 +33,7 @@
- **export_options** (Union[None, dict]) - 表示对导出的数据执行自定义操作。注:导出的文件的大小不受 `max_file_size` 的限制。您可以使用字典自定义导出的数据。例如,您可以设置{'tensor_format':'npy'}将tensor导出为 `npy` 文件。支持控制的数据如下所示。默认值None表示不导出数据。
- **tensor_format** (Union[str, None]) - 自定义导出的tensor的格式。支持["npy", None]。默认值None表示不导出tensor。
- **npy** - 将tensor导出为NPY文件。
**异常:**