!27908 Add docs description for ps server recovery

Merge pull request !27908 from zyli2020/ps_cache_feature
This commit is contained in:
i-robot 2021-12-20 12:02:05 +00:00 committed by Gitee
commit 1fb6040804
2 changed files with 3 additions and 2 deletions

View File

@ -330,7 +330,7 @@ MindSpore上下文用于配置当前执行环境包括执行模式、执
**参数:**
- **enable_ps** (bool) - 表示是否启用参数服务器训练模式。只有在enable_ps设置为True后环境变量才会生效。默认值False。
- **config_file_path** (string) - 配置文件路径,用于容灾恢复等。默认值:''。
- **config_file_path** (string) - 配置文件路径,用于容灾恢复等, 目前参数服务器训练模式仅支持Server容灾。默认值:''。
- **scheduler_manage_port** (int) - 调度器HTTP端口对外开放用于接收和处理用户扩容/缩容等请求。默认值11202。
- **enable_ssl** (bool) - 设置是否打开SSL认证。默认值True。
- **client_password** (str) - 用于解密客户端证书密钥的密码。默认值:''。

View File

@ -965,7 +965,8 @@ def set_ps_context(**kwargs):
enable_ps (bool): Whether to enable parameter server training mode.
Only after enable_ps is set True, the environment variables will be effective.
Default: False.
config_file_path (string): Configuration file path used by recovery. Default: ''.
config_file_path (string): Configuration file path used by recovery, parameter server training mode only
supports Server disaster recovery currently. Default: ''.
scheduler_manage_port (int): scheduler manage port used to scale out/in. Default: 11202.
enable_ssl (bool): Set PS SSL mode enabled or disabled. Default: False.
client_password (str): Password to decrypt the secret key stored in the client certificate. Default: ''.