mindspore.mint.distributed.TCPStore

class mindspore.mint.distributed.TCPStore(host_name, port, world_size=None, is_master=False, timeout=timedelta(seconds=300), wait_for_workers=True, multi_tenant=False, master_listen_fd=None, use_libuv=True)[源代码]

一种基于传输控制协议（TCP）的分布式键值存储实现方法。

说明

该功能通过CPU实现，不涉及任何与Ascend相关的硬件操作。
目前TCPStore类构造函数除了 host_name 、 port 、 world_size 、 is_master 、 timeout 和 wait_for_workers ，其他提供的所有参数均不支持，为预留参数，设置无效。
当前TcpStore功能受限，仅支持key小于4k、value小于1G场景，复杂场景待支持。

参数：

host_name (str) - 服务器存储应运行的主机名或 IP 地址。当前仅支持用户传入 IP 地址。
port (int) - 服务器存储应侦听传入请求的端口。
world_size (int，可选) - 存储用户总数（客户端数量 + 服务器数量 1 ）。默认值为 None ，表示存储用户数量不固定。该参数只对服务器有效。
is_master (bool，可选) - 初始化服务器存储时为 True ，初始化客户端存储时为 False 。默认值为 False 。
timeout (timedelta，可选) - 初始化期间存储使用的超时时长，默认值为 timedelta(seconds=300) 。
wait_for_workers (bool，可选) - 是否等待所有工作进程连接到服务器存储。这仅在 world_size 为固定值时适用。默认值为 True 。该参数只对服务器有效。
multi_tenant (bool，无效参数，可选) - 如果为 True，则当前进程中具有相同主机/端口的所有 TCPStore 实例将使用相同的底层 TCPServer 。默认值为 False 。
master_listen_fd (int，无效参数，可选) - 如果指定，则底层 TCPServer 将侦听此文件描述符，该文件描述符必须是已绑定到端口的套接字。在某些情况下有助于避免端口分配竞争。默认值为 None （意味着服务器创建一个新的套接字并尝试将其绑定到端口）。
use_libuv (bool，无效参数，可选) - 如果为 True ，则将 libuv 用于 TCPServer 后端。默认值为 True 。

返回：

TCPStore 对象。

支持平台：

Ascend

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> from mindspore.mint.distributed import TCPStore
>>> store = TCPStore("127.0.0.1", 1234)

mindspore.mint.add(key, amount)[源代码]

第一次调用 add 函数时，给定一个键值，会在存储中创建一个带有该键值对应的计数器，计数器的初始值为 amount 。后续使用相同键调用 add 函数会进行增量操作按数量进行计数。

参数：

key (str) - 计数器值将被增加的键。
amount (int) - 计数器将增加的数值。

返回：

int，返回 key 对应的计数器的值。

异常：

TypeError - 当 key 不是字符串。
TypeError - 当 amount 不是整数。
RuntimeError - 如果 add 和 set 传入相同的 key ，且 set 传入的 value 无法正确转换成数值，此时调用 add 会报错。

支持平台：

Ascend

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> from mindspore.mint.distributed import TCPStore
>>> store = TCPStore("127.0.0.1", 1234)
>>> store.add("first_key", 1)

mindspore.mint.delete_key(key)[源代码]

从存储中删除与 key 关联的键值对。

参数：

key (str) - 要从存储中删除的 key 。

返回：

bool，如果成功删除了该键，则返回 True ，否则返回 False 。

异常：

TypeError - 当 key 不是字符串。

支持平台：

Ascend

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> from mindspore.mint.distributed import TCPStore
>>> store = TCPStore("127.0.0.1", 1234)
>>> store.set("first_key", "first_value")
>>> # This should return true
>>> store.delete_key("first_key")

mindspore.mint.get(key)[源代码]

检索与存储中给定 key 关联的值。如果存储中不存在 key ，此函数将等待类初始化设置的超时时间 timeout ，然后抛出异常。

参数：

key (str) - 该函数将返回与此键关联的值。

返回：

bytes，如果 key 在存储中，则返回与 key 关联的值。

异常：

TypeError - 当 key 不是字符串。
RuntimeError - 当 get 执行超时。

支持平台：

Ascend

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> from mindspore.mint.distributed import TCPStore
>>> store = TCPStore("127.0.0.1", 1234)
>>> store.set("first_key", "first_value")
>>> data = store.get("first_key")
>>> print(data)

mindspore.mint.set(key, value)[源代码]

根据提供的 key 和 value 将键值对插入到存储中。如果存储中已经存在 key ，它将使用新提供的 value 覆盖旧值。

参数：

key (str) - 要添加到存储中的键。
value (Union[bytes, str]) - 要添加到存储中的键值对的value。

异常：

TypeError - 当 key 不是字符串。
TypeError - 当 value 不是字符串或者字节类型。

支持平台：

Ascend

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> from mindspore.mint.distributed import TCPStore
>>> store = TCPStore("127.0.0.1", 1234)
>>> store.set("first_key", "first_value")