mindspore2022/docs/api/api_python/mindspore.context_ps.txt

get_ps_context(attr_key)

    根据key获取参数服务器训练模式上下文中的属性值。

    参数：
        attr_key (str)：属性的key。

            - enable_ps (bool)：表示是否启用参数服务器训练模式。
            - config_file_path (string)：配置文件路径，用于容灾恢复等。
            - scheduler_manage_port (int)：调度器HTTP端口，对外开放用于接收和处理用户扩容/缩容等请求。
            - enable_ssl (bool)：设置是否打开SSL认证。
            - client_password (str)：用于解密客户端证书密钥的密码。
            - server_password (str)：用于解密服务端证书密钥的密码。

    返回：
        根据key返回属性值。

    异常：
        ValueError：输入key不是参数服务器训练模式上下文中的属性。

    样例：
        >>> context.get_ps_context(enable_ps)
    

reset_ps_context()

    将参数服务器训练模式上下文中的属性重置为默认值。各字段的含义及其默认值见'set_ps_context'接口。

    样例：
        >>> context.reset_ps_context()
   
set_ps_context(**kwargs)

    设置参数服务器训练模式的上下文。

    注：
        需要给参数服务器训练模式设置其他的环境变量。
        这些环境变量如下所示：

        MS_SERVER_NUM：表示参数服务器数量。

        MS_WORKER_NUM：表示工作进程数量。

        MS_SCHED_HOST：表示调度器IP地址。

        MS_SCHED_PORT：表示调度器开启的监听端口。

        MS_ROLE：表示进程角色，角色列表如下：

            MS_SCHED：表示调度器。

            MS_WORKER：表示工作进程。

            MS_PSERVER/MS_SERVER：表示参数服务器。

    参数：
        enable_ps (bool)：表示是否启用参数服务器训练模式。
                          只有在enable_ps设置为True后，环境变量才会生效。
                          默认值：False。
        config_file_path (string)：配置文件路径，用于容灾恢复等。
                                   默认值：''。
        scheduler_manage_port (int)：调度器HTTP端口，对外开放用于接收和处理用户扩容/缩容等请求。
                                     默认值：11202。
        enable_ssl (bool)：设置是否打开SSL认证。
                           默认值：True。
        client_password (str)：用于解密客户端证书密钥的密码。
                               默认值：''。
        server_password (str)：用于解密服务端证书密钥的密码。
                               默认值：''。


    异常：
        ValueError：输入key不是参数服务器训练模式上下文中的属性。

    样例：
        >>> context.set_ps_context(enable_ps=True, enable_ssl=True, client_password='123456', server_password='123456')