From 246e9581002f1def4e8f45f5a550cb8e74789280 Mon Sep 17 00:00:00 2001 From: zhangyi Date: Tue, 25 Jan 2022 14:28:23 +0800 Subject: [PATCH] fix some error format. --- .../api_python/dataset/mindspore.dataset.BuiltinSampler.rst | 4 ++-- docs/api/api_python/dataset/mindspore.dataset.zip.rst | 3 +++ .../nn/{mindspore.nn.conv2d.rst => mindspore.nn.Conv2d.rst} | 0 ...conv2dtranspose.rst => mindspore.nn.Conv2dTranspose.rst} | 0 docs/api/api_python/nn/mindspore.nn.FTRL.rst | 2 +- docs/api/api_python/nn/mindspore.nn.LazyAdam.rst | 2 +- docs/api/api_python/nn/mindspore.nn.PipelineCell.rst | 3 +++ docs/api/api_python/nn/mindspore.nn.ProximalAdagrad.rst | 2 +- .../api_python/train/mindspore.train.SummaryCollector.rst | 6 +++--- 9 files changed, 14 insertions(+), 8 deletions(-) rename docs/api/api_python/nn/{mindspore.nn.conv2d.rst => mindspore.nn.Conv2d.rst} (100%) rename docs/api/api_python/nn/{mindspore.nn.conv2dtranspose.rst => mindspore.nn.Conv2dTranspose.rst} (100%) diff --git a/docs/api/api_python/dataset/mindspore.dataset.BuiltinSampler.rst b/docs/api/api_python/dataset/mindspore.dataset.BuiltinSampler.rst index dc5d3129cef..d4c227d596b 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.BuiltinSampler.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.BuiltinSampler.rst @@ -1,11 +1,11 @@ .. py:method:: add_child(sampler) 为给定采样器添加子采样器。子采样器接收父采样器输出数据作为输入，并应用其采样逻辑返回新的采样结果。 - + **参数：** - **sampler** (Sampler) - 用于从数据集中选择样本的对象。仅支持内置采样器（DistributedSampler、PKSampler、RandomSampler、SequentialSampler、SubsetRandomSampler、WeightedRandomSampler）。 .. py:method:: get_child() - 获取给定采样器的子采样器。 + 获取给定采样器的子采样器。 diff --git a/docs/api/api_python/dataset/mindspore.dataset.zip.rst b/docs/api/api_python/dataset/mindspore.dataset.zip.rst index 512f193a73b..37af0744b17 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.zip.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.zip.rst @@ -1,3 +1,6 @@ +mindspore.dataset.zip +===================== + .. py:function:: mindspore.dataset.zip(datasets) 将多个dataset对象按列进行合并压缩。 diff --git a/docs/api/api_python/nn/mindspore.nn.conv2d.rst b/docs/api/api_python/nn/mindspore.nn.Conv2d.rst similarity index 100% rename from docs/api/api_python/nn/mindspore.nn.conv2d.rst rename to docs/api/api_python/nn/mindspore.nn.Conv2d.rst diff --git a/docs/api/api_python/nn/mindspore.nn.conv2dtranspose.rst b/docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst similarity index 100% rename from docs/api/api_python/nn/mindspore.nn.conv2dtranspose.rst rename to docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst diff --git a/docs/api/api_python/nn/mindspore.nn.FTRL.rst b/docs/api/api_python/nn/mindspore.nn.FTRL.rst index d60408aa482..8db976ee94a 100644 --- a/docs/api/api_python/nn/mindspore.nn.FTRL.rst +++ b/docs/api/api_python/nn/mindspore.nn.FTRL.rst @@ -75,4 +75,4 @@ mindspore.nn.FTRL - **ValueError** - `initial_accum`、`l1` 或 `l2` 小于0。 -.. include:: mindspore.nn.optim_target_unique_for_sparse.rst \ No newline at end of file + .. include:: mindspore.nn.optim_target_unique_for_sparse.rst \ No newline at end of file diff --git a/docs/api/api_python/nn/mindspore.nn.LazyAdam.rst b/docs/api/api_python/nn/mindspore.nn.LazyAdam.rst index 9f8f2219c01..2e8ea0ab222 100644 --- a/docs/api/api_python/nn/mindspore.nn.LazyAdam.rst +++ b/docs/api/api_python/nn/mindspore.nn.LazyAdam.rst @@ -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 diff --git a/docs/api/api_python/nn/mindspore.nn.PipelineCell.rst b/docs/api/api_python/nn/mindspore.nn.PipelineCell.rst index e065b01dfad..af73b988c48 100644 --- a/docs/api/api_python/nn/mindspore.nn.PipelineCell.rst +++ b/docs/api/api_python/nn/mindspore.nn.PipelineCell.rst @@ -1,3 +1,6 @@ +mindspore.nn.PipelineCell +========================= + .. py:class:: mindspore.nn.PipelineCell(network, micro_size) 将MiniBatch切分成更细粒度的MicroBatch，用于流水线并行的训练中。 diff --git a/docs/api/api_python/nn/mindspore.nn.ProximalAdagrad.rst b/docs/api/api_python/nn/mindspore.nn.ProximalAdagrad.rst index c2d700af016..1d613a71fe3 100644 --- a/docs/api/api_python/nn/mindspore.nn.ProximalAdagrad.rst +++ b/docs/api/api_python/nn/mindspore.nn.ProximalAdagrad.rst @@ -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 diff --git a/docs/api/api_python/train/mindspore.train.SummaryCollector.rst b/docs/api/api_python/train/mindspore.train.SummaryCollector.rst index c69ce52cd90..d6f5ee0d319 100644 --- a/docs/api/api_python/train/mindspore.train.SummaryCollector.rst +++ b/docs/api/api_python/train/mindspore.train.SummaryCollector.rst @@ -5,7 +5,7 @@ 它可以帮助收集loss、学习率、计算图等。 SummaryCollector还可以允许通过 `summary算子 `_ 将数据收集到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文件。 **异常：**