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

modify format2function

This commit is contained in:
huodagu 2022-04-27 10:50:51 +08:00
parent 42141e991b
commit aeb67af089
36 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/api_python/dataset/mindspore.dataset.compare.rst
View File

@ -1,7 +1,7 @@
mindspore.dataset.compare
==========================
.. py:method:: mindspore.dataset.compare(pipeline1, pipeline2)
.. py:function:: mindspore.dataset.compare(pipeline1, pipeline2)
比较两个数据处理管道是否相同。

2
docs/api/api_python/dataset/mindspore.dataset.deserialize.rst
View File

@ -1,7 +1,7 @@
mindspore.dataset.deserialize
==============================
.. py:method:: mindspore.dataset.deserialize(input_dict=None, json_filepath=None)
.. py:function:: mindspore.dataset.deserialize(input_dict=None, json_filepath=None)
数据处理管道反序列化，支持输入Python字典或使用 `mindspore.dataset.serialize()` 接口生成的JSON文件。

2
docs/api/api_python/dataset/mindspore.dataset.serialize.rst
View File

@ -1,7 +1,7 @@
mindspore.dataset.serialize
============================
.. py:method:: mindspore.dataset.serialize(dataset, json_filepath='')
.. py:function:: mindspore.dataset.serialize(dataset, json_filepath='')
将数据处理管道序列化成JSON文件。

2
docs/api/api_python/dataset/mindspore.dataset.show.rst
View File

@ -1,7 +1,7 @@
mindspore.dataset.show
======================
.. py:method:: mindspore.dataset.show(dataset, indentation=2)
.. py:function:: mindspore.dataset.show(dataset, indentation=2)
将数据处理管道图写入MindSpore的INFO级别日志文件。

4
docs/api/api_python/mindspore/mindspore.async_ckpt_thread_status.rst
View File

@ -1,7 +1,7 @@
mindspore.async_ckpt_thread_status
=======================================
.. py:class:: mindspore.async_ckpt_thread_status()
.. py:function:: mindspore.async_ckpt_thread_status()
获取异步保存checkpoint文件线程的状态。
@ -9,4 +9,4 @@ mindspore.async_ckpt_thread_status
**返回：**
Bool: True，异步保存checkpoint线程正在运行。False，异步保存checkpoint线程未运行。
Bool: True，异步保存checkpoint线程正在运行。False，异步保存checkpoint线程未运行。

2
docs/api/api_python/mindspore/mindspore.build_searched_strategy.rst
View File

@ -1,7 +1,7 @@
mindspore.build_searched_strategy
=======================================
.. py:class:: mindspore.build_searched_strategy(strategy_filename)
.. py:function:: mindspore.build_searched_strategy(strategy_filename)
构建网络中每个参数的策略，用于分布式推理。关于它的使用细节，请参考： `保存和加载模型（HyBrid Parallel模式） <https://www.mindspore.cn/tutorials/experts/zh-CN/master/parallel/save_load.html>`_。

2
docs/api/api_python/mindspore/mindspore.build_train_network.rst
View File

@ -1,7 +1,7 @@
mindspore.build_train_network
=======================================
.. py:class:: mindspore.build_train_network(network, optimizer, loss_fn=None, level='O0', boost_level='O0', **kwargs)
.. py:function:: mindspore.build_train_network(network, optimizer, loss_fn=None, level='O0', boost_level='O0', **kwargs)
构建混合精度训练网络。

2
docs/api/api_python/mindspore/mindspore.dtype_to_nptype.rst
View File

@ -1,7 +1,7 @@
mindspore.dtype_to_nptype
==========================
.. py:method:: mindspore.dtype_to_nptype(type_)
.. py:function:: mindspore.dtype_to_nptype(type_)
将MindSpore 数据类型转换成NumPy数据类型。

2
docs/api/api_python/mindspore/mindspore.dtype_to_pytype.rst
View File

@ -1,7 +1,7 @@
mindspore.dtype_to_pytype
=========================
.. py:method:: mindspore.dtype_to_pytype(type_)
.. py:function:: mindspore.dtype_to_pytype(type_)
将MindSpore 数据类型转换为Python数据类型。

2
docs/api/api_python/mindspore/mindspore.export.rst
View File

@ -1,7 +1,7 @@
mindspore.export
=================
.. py:class:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs)
.. py:function:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs)
将MindSpore网络模型导出为指定格式的文件。

2
docs/api/api_python/mindspore/mindspore.get_level.rst
View File

@ -1,7 +1,7 @@
mindspore.get_level
======================
.. py:class:: mindspore.get_level()
.. py:function:: mindspore.get_level()
获取日志记录器的级别。

2
docs/api/api_python/mindspore/mindspore.get_log_config.rst
View File

@ -1,7 +1,7 @@
mindspore.get_log_config
=========================
.. py:class:: mindspore.get_log_config()
.. py:function:: mindspore.get_log_config()
获取日志配置。

2
docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst
View File

@ -1,7 +1,7 @@
mindspore.get_py_obj_dtype
===========================
.. py:method:: mindspore.get_py_obj_dtype(obj)
.. py:function:: mindspore.get_py_obj_dtype(obj)
将Python数据类型转换为MindSpore数据类型。

2
docs/api/api_python/mindspore/mindspore.get_seed.rst
View File

@ -1,7 +1,7 @@
mindspore.get_seed
===================
.. py:class:: mindspore.get_seed()
.. py:function:: mindspore.get_seed()
获取随机种子。

2
docs/api/api_python/mindspore/mindspore.issubclass_.rst
View File

@ -1,7 +1,7 @@
mindspore.issubclass\_
=======================
.. py:method:: mindspore.issubclass_(type_, dtype)
.. py:function:: mindspore.issubclass_(type_, dtype)
判断 `type_` 是否为 `dtype` 的子类。

2
docs/api/api_python/mindspore/mindspore.load.rst
View File

@ -1,7 +1,7 @@
mindspore.load
=======================================
.. py:class:: mindspore.load(file_name, **kwargs)
.. py:function:: mindspore.load(file_name, **kwargs)
加载MindIR文件。

2
docs/api/api_python/mindspore/mindspore.load_checkpoint.rst
View File

@ -1,7 +1,7 @@
mindspore.load_checkpoint
==========================
.. py:class:: mindspore.load_checkpoint(ckpt_file_name, net=None, strict_load=False, filter_prefix=None, dec_key=None, dec_mode="AES-GCM")
.. py:function:: mindspore.load_checkpoint(ckpt_file_name, net=None, strict_load=False, filter_prefix=None, dec_key=None, dec_mode="AES-GCM")
加载checkpoint文件。

2
docs/api/api_python/mindspore/mindspore.load_distributed_checkpoint.rst
View File

@ -1,7 +1,7 @@
mindspore.load_distributed_checkpoint
======================================
.. py:method:: mindspore.load_distributed_checkpoint(network, checkpoint_filenames, predict_strategy=None, train_strategy_filename=None, strict_load=False, dec_key=None, dec_mode='AES-GCM')
.. py:function:: mindspore.load_distributed_checkpoint(network, checkpoint_filenames, predict_strategy=None, train_strategy_filename=None, strict_load=False, dec_key=None, dec_mode='AES-GCM')
给分布式预测加载checkpoint文件到网络，用于分布式推理。关于分布式推理的细节，请参考： https://www.mindspore.cn/tutorials/experts/zh-CN/master/parallel/distributed_inference.html 。

2
docs/api/api_python/mindspore/mindspore.load_param_into_net.rst
View File

@ -1,7 +1,7 @@
mindspore.load_param_into_net
=============================
.. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False)
.. py:function:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False)
将参数加载到网络中，返回网络中没有被加载的参数列表。

2
docs/api/api_python/mindspore/mindspore.merge_sliced_parameter.rst
View File

@ -1,7 +1,7 @@
mindspore.merge_sliced_parameter
=================================
.. py:method:: mindspore.merge_sliced_parameter(sliced_parameters, strategy=None)
.. py:function:: mindspore.merge_sliced_parameter(sliced_parameters, strategy=None)
将参数切片合并为一个完整的参数，用于分布式推理。关于它的细节，请参考：`保存和加载模型（HyBrid Parallel模式） <https://www.mindspore.cn/tutorials/experts/zh-CN/master/parallel/save_load.html>`_。

2
docs/api/api_python/mindspore/mindspore.ms_function.rst
View File

@ -1,7 +1,7 @@
mindspore.ms_function
=====================
.. py:class:: mindspore.ms_function(fn=None, obj=None, input_signature=None, hash_args=None)
.. py:function:: mindspore.ms_function(fn=None, obj=None, input_signature=None, hash_args=None)
将Python函数编译为一张可调用的MindSpore图。

2
docs/api/api_python/mindspore/mindspore.parse_print.rst
View File

@ -1,7 +1,7 @@
mindspore.parse_print
=======================================
.. py:class:: mindspore.parse_print(print_file_name)
.. py:function:: mindspore.parse_print(print_file_name)
解析由 mindspore.ops.Print 生成的数据文件。

2
docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst
View File

@ -1,7 +1,7 @@
mindspore.pytype_to_dtype
=========================
.. py:method:: mindspore.pytype_to_dtype(obj)
.. py:function:: mindspore.pytype_to_dtype(obj)
将Python数据类型转换为MindSpore数据类型。

2
docs/api/api_python/mindspore/mindspore.restore_group_info_list.rst
View File

@ -1,7 +1,7 @@
mindspore.restore_group_info_list
=======================================
.. py:class:: mindspore.restore_group_info_list(group_info_file_name)
.. py:function:: mindspore.restore_group_info_list(group_info_file_name)
从group_info_file_name指向的文件中提取得到通信域的信息，在该通信域内的所有设备的checkpoint文件均与存储group_info_file_name的设备相同，可以直接进行替换。通过配置环境变量GROUP_INFO_FILE以在编译阶段存储下该通信域信息，例如"export GROUP_INFO_FILE=/data/group_info.pb"。

2
docs/api/api_python/mindspore/mindspore.run_check.rst
View File

@ -1,6 +1,6 @@
mindspore.run_check
===================
.. py:method:: mindspore.run_check()
.. py:function:: mindspore.run_check()
提供了便捷的API用以查询MindSpore的安装是否成功。

2
docs/api/api_python/mindspore/mindspore.save_checkpoint.rst
View File

@ -1,7 +1,7 @@
mindspore.save_checkpoint
=========================
.. py:class:: mindspore.save_checkpoint(save_obj, ckpt_file_name, integrated_save=True, async_save=False, append_dict=None, enc_key=None, enc_mode="AES-GCM")
.. py:function:: mindspore.save_checkpoint(save_obj, ckpt_file_name, integrated_save=True, async_save=False, append_dict=None, enc_key=None, enc_mode="AES-GCM")
将网络权重保存到checkpoint文件中。

2
docs/api/api_python/mindspore/mindspore.set_dump.rst
View File

@ -1,7 +1,7 @@
mindspore.set_dump
==================
.. py:class:: mindspore.set_dump(target, enabled=True)
.. py:function:: mindspore.set_dump(target, enabled=True)
启用或者禁用 `target` 及其子节点的Dump数据功能。

2
docs/api/api_python/mindspore/mindspore.set_seed.rst
View File

@ -1,7 +1,7 @@
mindspore.set_seed
===================
.. py:class:: mindspore.set_seed(seed)
.. py:function:: mindspore.set_seed(seed)
设置全局种子。

2
docs/api/api_python/nn/mindspore.nn.auc.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.auc
================
.. py:class:: mindspore.nn.auc(x, y, reorder=False)
.. py:function:: mindspore.nn.auc(x, y, reorder=False)
使用梯形法则计算曲线下面积AUC（Area Under the Curve，AUC）。这是一个一般函数，给定曲线上的点，
用于计算ROC (Receiver Operating Curve, ROC) 曲线下的面积。

2
docs/api/api_python/nn/mindspore.nn.cosine_decay_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.cosine_decay_lr
==============================
.. py:class:: mindspore.nn.cosine_decay_lr(min_lr, max_lr, total_step, step_per_epoch, decay_epoch)
.. py:function:: mindspore.nn.cosine_decay_lr(min_lr, max_lr, total_step, step_per_epoch, decay_epoch)
基于余弦衰减函数计算学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.exponential_decay_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.exponential_decay_lr
=======================================
.. py:class:: mindspore.nn.exponential_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
.. py:function:: mindspore.nn.exponential_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
基于指数衰减函数计算学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.inverse_decay_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.inverse_decay_lr
=============================
.. py:class:: mindspore.nn.inverse_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
.. py:function:: mindspore.nn.inverse_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
基于逆时衰减函数计算学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.natural_exp_decay_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.natural_exp_decay_lr
=================================
.. py:class:: mindspore.nn.natural_exp_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
.. py:function:: mindspore.nn.natural_exp_decay_lr(learning_rate, decay_rate, total_step, step_per_epoch, decay_epoch, is_stair=False)
基于自然指数衰减函数计算学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.piecewise_constant_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.piecewise_constant_lr
====================================
.. py:class:: mindspore.nn.piecewise_constant_lr(milestone, learning_rates)
.. py:function:: mindspore.nn.piecewise_constant_lr(milestone, learning_rates)
获取分段常量学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.polynomial_decay_lr.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.polynomial_decay_lr
====================================
.. py:class:: mindspore.nn.polynomial_decay_lr(learning_rate, end_learning_rate, total_step, step_per_epoch, decay_epoch, power, update_decay_epoch=False)
.. py:function:: mindspore.nn.polynomial_decay_lr(learning_rate, end_learning_rate, total_step, step_per_epoch, decay_epoch, power, update_decay_epoch=False)
基于多项式衰减函数计算学习率。每个step的学习率将会被存放在一个列表中。

2
docs/api/api_python/nn/mindspore.nn.thor.rst
View File

@ -1,7 +1,7 @@
mindspore.nn.thor
==================
.. py:class:: mindspore.nn.thor(net, learning_rate, damping, momentum, weight_decay=0.0, loss_scale=1.0, batch_size=32, use_nesterov=False, decay_filter=<function <lambda> at 0x0000029724CFA048>, split_indices=None, enable_clip_grad=False, frequency=100)
.. py:function:: mindspore.nn.thor(net, learning_rate, damping, momentum, weight_decay=0.0, loss_scale=1.0, batch_size=32, use_nesterov=False, decay_filter=<function <lambda> at 0x0000029724CFA048>, split_indices=None, enable_clip_grad=False, frequency=100)
通过二阶算法THOR更新参数。