!30925 [dataset][docs][chn] 添加set_enable_watchdog/get_enable_watchdog/set_multiprocessing_timeout_interval/get_multiprocessing_timeout_interval中文文档api

Merge pull request !30925 from xiefangqi/code_docs_add_multiprocessing_chn_api
This commit is contained in:
i-robot 2022-03-07 10:15:36 +00:00 committed by Gitee
commit 7d2764be72
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 40 additions and 0 deletions

View File

@ -37,6 +37,14 @@ API示例所需模块的导入代码如下
bool表示是否启用共享内存。
.. py:function:: mindspore.dataset.config.get_enable_watchdog()
获取当前是否开启watchdog Python线程。默认初始状态是开启。
**返回:**
bool表示是否开启watchdog Python线程。
.. py:function:: mindspore.dataset.config.get_monitor_sampling_interval()
获取性能监控采样时间间隔的全局配置。
@ -45,6 +53,14 @@ API示例所需模块的导入代码如下
int表示性能监控采样间隔时间毫秒
.. py:function:: mindspore.dataset.config.get_multiprocessing_timeout_interval()
获取在多进程下,主进程获取数据超时时,告警日志打印的时间间隔的全局配置。
**返回:**
int表示多进程下主进程获取数据超时时告警日志打印的时间间隔
.. py:function:: mindspore.dataset.config.get_numa_enable()
获取NUMA的启动状态。
@ -137,6 +153,18 @@ API示例所需模块的导入代码如下
- **TypeError** - `enable` 不是布尔数据类型。
.. py:function:: mindspore.dataset.config.set_enable_watchdog(enable)
设置watchdog Python线程是否启用。默认情况下watchdog Python线程是启用的。watchdog Python线程负责清理卡死或假死的子进程。
**参数:**
- **enable** (bool) - 是否开启watchdog Python线程。默认情况下watchdog Python线程是启用的。
**异常:**
- **TypeError** - `enable` 不是布尔数据类型。
.. py:function:: mindspore.dataset.config.set_monitor_sampling_interval(interval)
设置监测采样的默认间隔时间(毫秒)。
@ -149,6 +177,18 @@ API示例所需模块的导入代码如下
- **ValueError** - `interval` 小于等于0或 `interval` 大于MAX_INT_32时 `interval` 无效。
.. py:function:: mindspore.dataset.config.set_multiprocessing_timeout_interval(interval)
设置在多进程下,主进程获取数据超时时,告警日志打印的默认时间间隔(秒)。
**参数:**
- **interval** (int) - 表示多进程下,主进程获取数据超时时,告警日志打印的时间间隔(秒)。
**异常:**
- **ValueError** - `interval` 小于等于0或 `interval` 大于MAX_INT_32时 `interval` 无效。
.. py:function:: mindspore.dataset.config.set_numa_enable(numa_enable)
设置NUMA的默认状态为启动状态。如果 `numa_enable` 为True则需要确保安装了NUMA库。