NonTensorData¶

class tensordict.NonTensorData(data: 'Any', _metadata: 'dict | None' = None, _is_non_tensor: 'bool' = True, *, batch_size, device=None, names=None)¶

property device: device¶: 检索 tensor class 的设备类型。

dumps(prefix: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

将 tensordict 保存到磁盘。

此函数是 memmap() 的代理。

classmethod fields()¶

返回描述此数据类的字段的元组。

接受数据类或其实例。元组元素类型为 Field。

classmethod from_tensordict(tensordict, non_tensordict=None, safe=True)¶

用于实例化新的 tensor class 对象的 tensor class 包装器。

参数:

tensordict (TensorDict) – 张量类型字典
non_tensordict (dict) – 包含非张量和嵌套 tensor class 对象的字典

get(key: NestedKey, *args, **kwargs)¶

获取使用输入键存储的值。

参数:

key (字符串, 字符串元组) – 要查询的键。如果是字符串元组，则相当于链式调用 getattr。
default – 如果在 tensorclass 中未找到键，则使用的默认值。

返回:

使用输入键存储的值

classmethod load(prefix: str | pathlib.Path, *args, **kwargs) → T¶

从磁盘加载 tensordict。

此类方法是 load_memmap() 的代理。

load_(prefix: str | pathlib.Path, *args, **kwargs)¶

在当前 tensordict 中从磁盘加载 tensordict。

此类方法是 load_memmap_() 的代理。

classmethod load_memmap(prefix: str | pathlib.Path, device: Optional[device] = None, non_blocking: bool = False, *, out: Optional[TensorDictBase] = None) → T¶

从磁盘加载内存映射的 tensordict。

参数:

prefix (字符串 或 文件夹路径) – 存储已保存 tensordict 的文件夹路径。
device (torch.device 或 等效类型, 可选) – 如果提供，数据将异步转换为该设备。支持 “meta” 设备，在这种情况下，数据不会被加载，而是创建一组空的“meta”张量。这对于在不实际打开任何文件的情况下了解模型总大小和结构非常有用。
non_blocking (布尔值, 可选) – 如果为 True，在将张量加载到设备后不会调用 synchronize。默认为 False。
out (TensorDictBase, 可选) – 可选的 tensordict，数据将写入其中。

示例

>>> from tensordict import TensorDict
>>> td = TensorDict.fromkeys(["a", "b", "c", ("nested", "e")], 0)
>>> td.memmap("./saved_td")
>>> td_load = TensorDict.load_memmap("./saved_td")
>>> assert (td == td_load).all()

此方法还允许加载嵌套的 tensordict。

示例

>>> nested = TensorDict.load_memmap("./saved_td/nested")
>>> assert nested["e"] == 0

tensordict 也可以加载到“meta”设备上，或者作为假张量加载。

示例

>>> import tempfile
>>> td = TensorDict({"a": torch.zeros(()), "b": {"c": torch.zeros(())}})
>>> with tempfile.TemporaryDirectory() as path:
...     td.save(path)
...     td_load = TensorDict.load_memmap(path, device="meta")
...     print("meta:", td_load)
...     from torch._subclasses import FakeTensorMode
...     with FakeTensorMode():
...         td_load = TensorDict.load_memmap(path)
...         print("fake:", td_load)
meta: TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=meta,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=meta,
    is_shared=False)
fake: TensorDict(
    fields={
        a: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=cpu,
    is_shared=False)

load_state_dict(state_dict: dict[str, Any], strict=True, assign=False, from_flatten=False)¶: 尝试将 state_dict 就地加载到目标 tensorclass 上。

maybe_to_stack()¶: 如果 NonTensorData 对象具有非空的 batch-size，则将其转换为 NonTensorStack 对象。

memmap(prefix: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False, existsok: bool = True) → T¶

将所有张量写入新 tensordict 中对应的内存映射张量上。

参数:

prefix (字符串) – 存储内存映射张量的目录前缀。目录树结构将模仿 tensordict 的结构。
copy_existing (布尔值) – 如果为 False（默认值），当 tensordict 中的条目已是存储在磁盘上并有关联文件的张量，但未按 prefix 保存到正确位置时，将引发异常。如果为 True，任何现有张量将被复制到新位置。

关键字参数:

num_threads (整型, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (布尔值, 可选) – 如果为 True 且 num_threads>0，该方法将返回 tensordict 的 future 对象。
share_non_tensor (布尔值, 可选) – 如果为 True，非张量数据将在进程间共享，并且在单个节点内的任何 worker 上进行的写入操作（例如就地更新或设置）将更新所有其他 worker 上的值。如果非张量叶子数量很高（例如，共享大量非张量数据堆栈），这可能导致 OOM 或类似错误。默认为 False。
existsok (布尔值, 可选) – 如果为 False，则如果同一路径中已存在张量，将引发异常。默认为 True。

然后 TensorDict 被锁定，这意味着任何非就地写入操作（例如，重命名、设置或删除条目）将引发异常。一旦 tensordict 被解锁，内存映射属性将变为 False，因为不再保证跨进程的身份一致性。

返回:: 如果 return_early=False，则返回一个张量存储在磁盘上的新 tensordict；否则返回一个 TensorDictFuture 实例。

注意

以这种方式序列化对于深度嵌套的 tensordict 可能很慢，因此不建议在训练循环中调用此方法。

memmap_(prefix: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False, existsok: bool = True) → T¶

将所有张量就地写入对应的内存映射张量上。

参数:

prefix (字符串) – 存储内存映射张量的目录前缀。目录树结构将模仿 tensordict 的结构。
copy_existing (布尔值) – 如果为 False（默认值），当 tensordict 中的条目已是存储在磁盘上并有关联文件的张量，但未按 prefix 保存到正确位置时，将引发异常。如果为 True，任何现有张量将被复制到新位置。

关键字参数:

num_threads (整型, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (布尔值, 可选) – 如果为 True 且 num_threads>0，该方法将返回 tensordict 的 future 对象。可以使用 future.result() 查询结果 tensordict。
share_non_tensor (布尔值, 可选) – 如果为 True，非张量数据将在进程间共享，并且在单个节点内的任何 worker 上进行的写入操作（例如就地更新或设置）将更新所有其他 worker 上的值。如果非张量叶子数量很高（例如，共享大量非张量数据堆栈），这可能导致 OOM 或类似错误。默认为 False。
existsok (布尔值, 可选) – 如果为 False，则如果同一路径中已存在张量，将引发异常。默认为 True。

然后 TensorDict 被锁定，这意味着任何非就地写入操作（例如，重命名、设置或删除条目）将引发异常。一旦 tensordict 被解锁，内存映射属性将变为 False，因为不再保证跨进程的身份一致性。

返回:: 如果 return_early=False，则返回 self；否则返回一个 TensorDictFuture 实例。

注意

以这种方式序列化对于深度嵌套的 tensordict 可能很慢，因此不建议在训练循环中调用此方法。

memmap_like(prefix: Optional[str] = None, copy_existing: bool = False, *, existsok: bool = True, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

创建一个无内容的内存映射 tensordict，其形状与原始 tensordict 相同。

参数:

prefix (字符串) – 存储内存映射张量的目录前缀。目录树结构将模仿 tensordict 的结构。
copy_existing (布尔值) – 如果为 False（默认值），当 tensordict 中的条目已是存储在磁盘上并有关联文件的张量，但未按 prefix 保存到正确位置时，将引发异常。如果为 True，任何现有张量将被复制到新位置。

关键字参数:

num_threads (整型, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (布尔值, 可选) – 如果为 True 且 num_threads>0，该方法将返回 tensordict 的 future 对象。
share_non_tensor (布尔值, 可选) – 如果为 True，非张量数据将在进程间共享，并且在单个节点内的任何 worker 上进行的写入操作（例如就地更新或设置）将更新所有其他 worker 上的值。如果非张量叶子数量很高（例如，共享大量非张量数据堆栈），这可能导致 OOM 或类似错误。默认为 False。
existsok (布尔值, 可选) – 如果为 False，则如果同一路径中已存在张量，将引发异常。默认为 True。

然后 TensorDict 被锁定，这意味着任何非就地写入操作（例如，重命名、设置或删除条目）将引发异常。一旦 tensordict 被解锁，内存映射属性将变为 False，因为不再保证跨进程的身份一致性。

返回:: 一个新的 TensorDict 实例，如果 return_early=False，则数据存储为内存映射张量；否则为一个 TensorDictFuture 实例。

注意

这是将一组大型缓冲区写入磁盘的推荐方法，因为 memmap_() 会复制信息，这对于大型内容来说可能会很慢。

示例

>>> td = TensorDict({
...     "a": torch.zeros((3, 64, 64), dtype=torch.uint8),
...     "b": torch.zeros(1, dtype=torch.int64),
... }, batch_size=[]).expand(1_000_000)  # expand does not allocate new memory
>>> buffer = td.memmap_like("/path/to/dataset")

memmap_refresh_()¶

如果内存映射的 tensordict 具有 saved_path，则刷新其内容。

如果未关联路径，此方法将引发异常。

save(prefix: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

将 tensordict 保存到磁盘。

此函数是 memmap() 的代理。

set(key: NestedKey, value: Any, inplace: bool = False, non_blocking: bool = False)¶

设置一个新的键值对。

参数:

key (str, str 元组) – 要设置的键名。如果为 str 元组，则等同于连续调用 getattr 后再最终调用 setattr。
value (Any) – 要存储在张量类中的值。
inplace (bool, 可选) – 如果为 True，set 将尝试原地更新值。如果为 False 或键不存在，则值将被简单地写入其目标位置。

返回:

self

state_dict(destination=None, prefix='', keep_vars=False, flatten=False) → dict[str, Any]¶: 返回一个 state_dict 字典，可用于从张量类保存和加载数据。

tolist()¶

如果批大小不为空，则将数据转换为列表。

如果批大小为空，则返回数据。

unbind(dim: int)¶

返回一个元组，其中包含沿指定维度解除绑定的索引张量类实例。

结果张量类实例将与初始张量类实例共享存储。

NonTensorData¶

文档

教程

资源