p60975123
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

!29211 Fix link format in the summary_record docstring 

Merge pull request !29211 from maning202007/code_docs_fix_link_format_master
This commit is contained in:
i-robot 2022-01-18 12:22:40 +00:00 committed by Gitee
parent 33a0c1ddbc 0f01a1e4dc
commit cd81f15dc5
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
mindspore/python/mindspore/train/summary/summary_record.py
View File

@ -258,23 +258,23 @@ class SummaryRecord:
value (Union[Tensor, GraphProto, TrainLineage, EvaluationLineage, DatasetGraph, UserDefinedInfo]): \
The value to store.
- The data type of value should be 'GraphProto' (see mindspore/ccsrc/anf_ir.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/anf_ir.proto>) object
- The data type of value should be 'GraphProto' (see `mindspore/ccsrc/anf_ir.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/anf_ir.proto>`_) object
when the plugin is 'graph'.
- The data type of value should be 'Tensor' object when the plugin is 'scalar', 'image', 'tensor'
or 'histogram'.
- The data type of value should be a 'TrainLineage' object when the plugin is 'train_lineage',
see mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>.
see `mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>`_.
- The data type of value should be a 'EvaluationLineage' object when the plugin is 'eval_lineage',
see mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>.
see `mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>`_.
- The data type of value should be a 'DatasetGraph' object when the plugin is 'dataset_graph',
see mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>.
see `mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>`_.
- The data type of value should be a 'UserDefinedInfo' object when the plugin is 'custom_lineage_data',
see mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>.
see `mindspore/ccsrc/lineage.proto
<https://gitee.com/mindspore/mindspore/blob/master/mindspore/ccsrc/utils/lineage.proto>`_.
Raises:
ValueError: `plugin` is not in the optional value。