Browse Source

modify index of content for chinese python API.

tags/v1.6.0
zhangyi 4 years ago
parent
commit
5ce71e326e
10 changed files with 9 additions and 30 deletions
  1. +9
    -1
      docs/api/api_python/mindspore.train.rst
  2. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst
  3. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst
  4. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst
  5. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst
  6. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst
  7. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst
  8. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst
  9. +0
    -3
      docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst
  10. +0
    -5
      docs/api/api_python/mindspore.train/mindspore.train.summary.SummaryRecord.rst

+ 9
- 1
docs/api/api_python/mindspore.train.rst View File

@@ -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



+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst View File

@@ -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可以收集一些常用信息。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.Callback.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.Callback
==================================

.. py:class:: mindspore.train.callback.Callback

用于构建回调函数的基类。回调函数是一个上下文管理器,在运行模型时被调用。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.rst View File

@@ -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时的配置策略。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.LearningRateScheduler.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.LearningRateScheduler
===============================================

.. py:class:: mindspore.train.callback.LearningRateScheduler(learning_rate_function)

在训练期间更改学习率。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.LossMonitor.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.LossMonitor
=====================================

.. py:class:: mindspore.train.callback.LossMonitor(per_print_times=1)

监控训练的loss。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.ModelCheckpoint.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.ModelCheckpoint
=========================================

.. py:class:: mindspore.train.callback.ModelCheckpoint(prefix='CKP', directory=None, config=None)

checkpoint的回调函数。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.RunContext.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.RunContext
====================================

.. py:class:: mindspore.train.callback.RunContext(original_args)

提供模型的相关信息。


+ 0
- 3
docs/api/api_python/mindspore.train/mindspore.train.callback.TimeMonitor.rst View File

@@ -1,6 +1,3 @@
mindspore.train.callback.TimeMonitor
====================================

.. py:class:: mindspore.train.callback.TimeMonitor(data_size=None)

监控训练时间。


docs/api/api_python/mindspore.train/mindspore.train.summary.rst → docs/api/api_python/mindspore.train/mindspore.train.summary.SummaryRecord.rst View File

@@ -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数据。

Loading…
Cancel
Save