modify api annotation
This commit is contained in:
parent
3299d8f496
commit
fbbf97e318
|
|
@ -77,11 +77,14 @@ Serialization
|
|||
|
||||
mindspore.build_searched_strategy
|
||||
mindspore.export
|
||||
mindspore.load
|
||||
mindspore.parse_print
|
||||
mindspore.load_checkpoint
|
||||
mindspore.load_distributed_checkpoint
|
||||
mindspore.load_param_into_net
|
||||
mindspore.merge_sliced_parameter
|
||||
mindspore.save_checkpoint
|
||||
mindspore.async_ckpt_thread_status
|
||||
|
||||
JIT
|
||||
---
|
||||
|
|
@ -100,6 +103,14 @@ Log
|
|||
mindspore.get_level
|
||||
mindspore.get_log_config
|
||||
|
||||
Automatic Mixed Precision
|
||||
---------------------------
|
||||
|
||||
.. cnmsautosummary::
|
||||
:toctree: mindspore
|
||||
|
||||
mindspore.build_train_network
|
||||
|
||||
Installation Verification
|
||||
--------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@ mindspore.build_searched_strategy
|
|||
|
||||
.. py:class:: mindspore.build_searched_strategy(strategy_filename)
|
||||
|
||||
构建网络中每个参数的策略,用于分布式推理。关于它的使用细节,请参考:`保存和加载模型(HyBrid Parallel模式) <https://www.mindspore.cn/docs/programming_guide/zh-CN/master/save_load_model_hybrid_parallel.html>`_。
|
||||
构建网络中每个参数的策略,用于分布式推理。关于它的使用细节,请参考: `保存和加载模型(HyBrid Parallel模式) <https://www.mindspore.cn/docs/programming_guide/zh-CN/master/save_load_model_hybrid_parallel.html>`_。
|
||||
|
||||
**参数:**
|
||||
|
||||
- **strategy_filename** (str) - 策略文件的名称。
|
||||
**strategy_filename** (str) - 策略文件的名称。
|
||||
|
||||
**返回:**
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ mindspore.load
|
|||
|
||||
加载MindIR文件。
|
||||
|
||||
返回的对象可以由`GraphCell`执行,更多细节参见类:class:`mindspore.nn.GraphCell`。
|
||||
返回的对象可以由 `GraphCell` 执行,更多细节参见类 :class:`mindspore.nn.GraphCell` 。
|
||||
|
||||
**参数:**
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ mindspore.load
|
|||
|
||||
**返回:**
|
||||
|
||||
Object,一个可以由`GraphCell`构成的可执行的编译图。
|
||||
Object,一个可以由 `GraphCell` 构成的可执行的编译图。
|
||||
|
||||
**异常:**
|
||||
|
||||
|
|
|
|||
|
|
@ -5,19 +5,19 @@ mindspore.parse_print
|
|||
|
||||
解析由 mindspore.ops.Print 生成的保存数据。
|
||||
|
||||
将数据打印到屏幕上。也可以通过设置`context`中的参数`print_file_path`来关闭,数据会保存在`print_file_path`指定的文件中。 parse_print 用于解析保存的文件。 更多信息请参考:func:`mindspore.context.set_context` 和:class:`mindspore.ops.Print`。
|
||||
将数据打印到屏幕上。也可以通过设置 `context` 中的参数 `print_file_path` 来关闭,数据会保存在 `print_file_path` 指定的文件中。 parse_print 用于解析保存的文件。 更多信息请参考 :func:`mindspore.context.set_context` 和 :class:`mindspore.ops.Print` 。
|
||||
|
||||
**参数:**
|
||||
|
||||
- **print_file_name** (str) – 保存打印数据的文件名。
|
||||
**print_file_name** (str) – 保存打印数据的文件名。
|
||||
|
||||
**返回:**
|
||||
|
||||
List,由Tensor组成的list。
|
||||
List,由Tensor组成的list。
|
||||
|
||||
**异常:**
|
||||
|
||||
- **ValueError** – 指定的文件名可能为空,请确保输入正确的文件名。
|
||||
**ValueError** – 指定的文件名可能为空,请确保输入正确的文件名。
|
||||
|
||||
**样例:**
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue