forked from mindspore-Ecosystem/mindspore
!34206 modify mindspore_parallel
Merge pull request !34206 from xumengjuan1/code_docs_a2
This commit is contained in:
commit
12f1291d5e
|
@ -59,6 +59,9 @@ mindspore
|
||||||
mindspore.set_ps_context
|
mindspore.set_ps_context
|
||||||
mindspore.get_ps_context
|
mindspore.get_ps_context
|
||||||
mindspore.reset_ps_context
|
mindspore.reset_ps_context
|
||||||
|
mindspore.set_algo_parameters
|
||||||
|
mindspore.get_algo_parameters
|
||||||
|
mindspore.reset_algo_parameters
|
||||||
|
|
||||||
模型
|
模型
|
||||||
-----
|
-----
|
||||||
|
|
|
@ -0,0 +1,22 @@
|
||||||
|
mindspore.get_algo_parameters
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. py:function:: mindspore.get_algo_parameters(attr_key)
|
||||||
|
|
||||||
|
获取算法参数配置属性。
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
属性名称为必填项。此接口仅在AUTO_PARALLEL模式下工作。
|
||||||
|
|
||||||
|
**参数:**
|
||||||
|
|
||||||
|
- **attr_key** (str) - 属性的key。key包括"fully_use_devices"、"elementwise_op_strategy_follow"、"enable_algo_approxi"、"algo_approxi_epsilon"、"tensor_slice_align_enable”和"tensor_slice_align_size"。
|
||||||
|
|
||||||
|
**返回:**
|
||||||
|
|
||||||
|
根据key返回属性值。
|
||||||
|
|
||||||
|
**异常:**
|
||||||
|
|
||||||
|
- **ValueError** - 无法识别传入的关键字。
|
||||||
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
mindspore.reset_algo_parameters
|
||||||
|
================================
|
||||||
|
|
||||||
|
.. py:function:: mindspore.reset_algo_parameters()
|
||||||
|
|
||||||
|
重置算法参数属性。
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
此接口仅在AUTO_PARALLEL模式下工作。
|
||||||
|
|
||||||
|
重置后,属性值为:
|
||||||
|
|
||||||
|
- fully_use_devices:True
|
||||||
|
- elementwise_op_strategy_follow:False
|
||||||
|
- enable_algo_approxi:False
|
||||||
|
- algo_approxi_epsilon:0.1
|
||||||
|
- tensor_slice_align_enable:False
|
||||||
|
- tensor_slice_align_size:16
|
|
@ -1,9 +1,7 @@
|
||||||
mindspore.parallel
|
mindspore.set_algo_parameters
|
||||||
============================
|
=============================
|
||||||
|
|
||||||
并行相关功能的接口。
|
.. py:function:: mindspore.set_algo_parameters(**kwargs)
|
||||||
|
|
||||||
.. py:function:: mindspore.parallel.set_algo_parameters(**kwargs)
|
|
||||||
|
|
||||||
设置并行策略搜索算法中的参数。有关典型用法,请参见mindspore/tests/ut/python/parallel/test_auto_parallel_resnet.py。
|
设置并行策略搜索算法中的参数。有关典型用法,请参见mindspore/tests/ut/python/parallel/test_auto_parallel_resnet.py。
|
||||||
|
|
||||||
|
@ -22,41 +20,3 @@
|
||||||
**异常:**
|
**异常:**
|
||||||
|
|
||||||
- **ValueError** - 无法识别传入的关键字。
|
- **ValueError** - 无法识别传入的关键字。
|
||||||
|
|
||||||
|
|
||||||
.. py:function:: mindspore.parallel.reset_algo_parameters()
|
|
||||||
|
|
||||||
重置算法参数属性。
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
此接口仅在AUTO_PARALLEL模式下工作。
|
|
||||||
|
|
||||||
重置后,属性值为:
|
|
||||||
|
|
||||||
- fully_use_devices:True
|
|
||||||
- elementwise_op_strategy_follow:False
|
|
||||||
- enable_algo_approxi:False
|
|
||||||
- algo_approxi_epsilon:0.1
|
|
||||||
- tensor_slice_align_enable:False
|
|
||||||
- tensor_slice_align_size:16
|
|
||||||
|
|
||||||
|
|
||||||
.. py:function:: mindspore.parallel.get_algo_parameters(attr_key)
|
|
||||||
|
|
||||||
获取算法参数配置属性。
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
属性名称为必填项。此接口仅在AUTO_PARALLEL模式下工作。
|
|
||||||
|
|
||||||
**参数:**
|
|
||||||
|
|
||||||
- **attr_key** (str) - 属性的key。key包括"fully_use_devices"、"elementwise_op_strategy_follow"、"enable_algo_approxi"、"algo_approxi_epsilon"、"tensor_slice_align_enable”和"tensor_slice_align_size"。
|
|
||||||
|
|
||||||
**返回:**
|
|
||||||
|
|
||||||
根据key返回属性值。
|
|
||||||
|
|
||||||
**异常:**
|
|
||||||
|
|
||||||
- **ValueError** - 无法识别传入的关键字。
|
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
mindspore.parallel
|
|
||||||
==================
|
|
||||||
|
|
||||||
.. automodule:: mindspore.parallel
|
|
||||||
:members:
|
|
|
@ -170,6 +170,9 @@ Context
|
||||||
mindspore.set_ps_context
|
mindspore.set_ps_context
|
||||||
mindspore.get_ps_context
|
mindspore.get_ps_context
|
||||||
mindspore.reset_ps_context
|
mindspore.reset_ps_context
|
||||||
|
mindspore.set_algo_parameters
|
||||||
|
mindspore.get_algo_parameters
|
||||||
|
mindspore.reset_algo_parameters
|
||||||
|
|
||||||
Model
|
Model
|
||||||
-----
|
-----
|
||||||
|
|
Loading…
Reference in New Issue