From 5ce71e326e0e74d24658c452dcf927ad44bbeae7 Mon Sep 17 00:00:00 2001 From: zhangyi Date: Thu, 2 Dec 2021 17:22:08 +0800 Subject: [PATCH] modify index of content for chinese python API. --- docs/api/api_python/mindspore.train.rst | 10 +++++++++- .../mindspore.train.SummaryCollector.rst | 3 --- .../mindspore.train.callback.Callback.rst | 3 --- .../mindspore.train.callback.CheckpointConfig.rst | 3 --- .../mindspore.train.callback.LearningRateScheduler.rst | 3 --- .../mindspore.train.callback.LossMonitor.rst | 3 --- .../mindspore.train.callback.ModelCheckpoint.rst | 3 --- .../mindspore.train.callback.RunContext.rst | 3 --- .../mindspore.train.callback.TimeMonitor.rst | 3 --- ...y.rst => mindspore.train.summary.SummaryRecord.rst} | 5 ----- 10 files changed, 9 insertions(+), 30 deletions(-) rename docs/api/api_python/mindspore.train/{mindspore.train.summary.rst => mindspore.train.summary.SummaryRecord.rst} (96%) diff --git a/docs/api/api_python/mindspore.train.rst b/docs/api/api_python/mindspore.train.rst index 58d494cff8f..e9cc0bf7043 100644 --- a/docs/api/api_python/mindspore.train.rst +++ b/docs/api/api_python/mindspore.train.rst @@ -1,7 +1,15 @@ mindspore.train =============== -.. include:: mindspore.train/mindspore.train.summary.rst +mindspore.train.summary +------------------------ + +用户可以通过SummaryRecord来自定义回调函数或者在自定义训练循环中将需要的数据存储为summary文件和lineage文件，然后使用MindInsight进行可视化分析。 + +.. include:: mindspore.train/mindspore.train.summary.SummaryRecord.rst + +mindspore.train.callback +------------------------ .. include:: mindspore.train/mindspore.train.callback.Callback.rst diff --git a/docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst b/docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst index aa342c8fa19..6d6178f94bc 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.SummaryCollector -========================================= - .. py:class:: mindspore.train.callback.SummaryCollector(summary_dir, collect_freq=10, collect_specified_data=None, keep_default_action=True, custom_lineage_data=None, collect_tensor_freq=None, max_file_size=None, export_options=None) SummaryCollector可以收集一些常用信息。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst index 9e99cb2afa3..13dca1b62a8 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.Callback -================================== - .. py:class:: mindspore.train.callback.Callback 用于构建回调函数的基类。回调函数是一个上下文管理器，在运行模型时被调用。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst index a959c9481db..f69347fc48d 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.CheckpointConfig -========================================== - .. py:class:: mindspore.train.callback.CheckpointConfig(save_checkpoint_steps=1, save_checkpoint_seconds=0, keep_checkpoint_max=5, keep_checkpoint_per_n_minutes=0, integrated_save=True, async_save=False, saved_network=None, append_info=None, enc_key=None, enc_mode='AES-GCM') 保存checkpoint时的配置策略。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst index c1652cc26a6..b3296f8956d 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.LearningRateScheduler -=============================================== - .. py:class:: mindspore.train.callback.LearningRateScheduler(learning_rate_function) 在训练期间更改学习率。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst index 2e8ae0d654d..e64bae7ce4f 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.LossMonitor -===================================== - .. py:class:: mindspore.train.callback.LossMonitor(per_print_times=1) 监控训练的loss。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst index 0ce4be974a8..8c5b78a3d5a 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.ModelCheckpoint -========================================= - .. py:class:: mindspore.train.callback.ModelCheckpoint(prefix='CKP', directory=None, config=None) checkpoint的回调函数。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst index d4c01ad0c0d..36014f86238 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.RunContext -==================================== - .. py:class:: mindspore.train.callback.RunContext(original_args) 提供模型的相关信息。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst b/docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst index 3b6e9087bc6..b9c0f521eb2 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst @@ -1,6 +1,3 @@ -mindspore.train.callback.TimeMonitor -==================================== - .. py:class:: mindspore.train.callback.TimeMonitor(data_size=None) 监控训练时间。 diff --git a/docs/api/api_python/mindspore.train/mindspore.train.summary.rst b/docs/api/api_python/mindspore.train/mindspore.train.summary.SummaryRecord.rst similarity index 96% rename from docs/api/api_python/mindspore.train/mindspore.train.summary.rst rename to docs/api/api_python/mindspore.train/mindspore.train.summary.SummaryRecord.rst index e9ea9b46a6d..52c7c06ab7d 100644 --- a/docs/api/api_python/mindspore.train/mindspore.train.summary.rst +++ b/docs/api/api_python/mindspore.train/mindspore.train.summary.SummaryRecord.rst @@ -1,8 +1,3 @@ -mindspore.train.summary -======================== - -用户可以通过SummaryRecord来自定义回调函数或者在自定义训练循环中将需要的数据存储为summary文件和lineage文件，然后使用MindInsight进行可视化分析。 - .. py:class:: mindspore.train.summary.SummaryRecord(log_dir, file_prefix='events', file_suffix='_MS', network=None, max_file_size=None, raise_exception=False, export_options=None) SummaryRecord用于记录summary数据和lineage数据。