torch.Storage

在 PyTorch 中，常规张量是由以下组件定义的多维数组

• 存储：张量的实际数据，存储为连续的、一维的字节数组。

• dtype：张量中元素的数据类型，例如 torch.float32 或 torch.int64。

• shape：一个元组，指示张量在每个维度上的大小。

• 步幅：在每个维度中从一个元素移动到下一个元素所需的步长。

• 偏移量：存储中张量数据开始的起始点。对于新创建的张量，这通常为 0。

这些组件共同定义了张量的结构和数据，其中存储保存实际数据，其余组件充当元数据。

无类型存储 API

torch.UntypedStorage 是元素的连续一维数组。其长度等于张量的字节数。存储充当张量的底层数据容器。通常，在 PyTorch 中使用常规构造函数（例如 zeros()、zeros_like() 或 new_zeros()）创建的张量将生成张量存储和张量本身之间存在一一对应关系的张量。

但是，一个存储可以由多个张量共享。例如，张量的任何视图（通过 view() 或某些（但不是全部）类型的索引（如整数和切片）获得）将指向与原始张量相同的底层存储。当序列化和反序列化共享公共存储的张量时，这种关系会保留，并且张量继续指向相同的存储。有趣的是，反序列化指向单个存储的多个张量可能比反序列化多个独立张量更快。

可以通过 untyped_storage() 方法访问张量存储。这将返回 torch.UntypedStorage 类型的对象。幸运的是，存储具有唯一的标识符，可以通过 torch.UntypedStorage.data_ptr() 方法访问。在常规设置中，具有相同数据存储的两个张量将具有相同的存储 data_ptr。但是，张量本身可以指向两个单独的存储，一个用于其数据属性，另一个用于其 grad 属性。每个都需要自己的 data_ptr()。通常，不保证 torch.Tensor.data_ptr() 和 torch.UntypedStorage.data_ptr() 匹配，并且不应假设为真。

无类型存储在某种程度上独立于构建在其上的张量。实际上，这意味着具有不同 dtype 或形状的张量可以指向相同的存储。这也意味着可以更改张量存储，如下例所示

>>> t = torch.ones(3)
>>> s0 = t.untyped_storage()
>>> s0
 0
 0
 128
 63
 0
 0
 128
 63
 0
 0
 128
 63
[torch.storage.UntypedStorage(device=cpu) of size 12]
>>> s1 = s0.clone()
>>> s1.fill_(0)
 0
 0
 0
 0
 0
 0
 0
 0
 0
 0
 0
 0
[torch.storage.UntypedStorage(device=cpu) of size 12]
>>> # Fill the tensor with a zeroed storage
>>> t.set_(s1, storage_offset=t.storage_offset(), stride=t.stride(), size=t.size())
tensor([0., 0., 0.])

警告

请注意，不建议直接修改张量的存储，如本例所示。此低级操作仅用于教育目的，以演示张量及其底层存储之间的关系。通常，使用标准的 torch.Tensor 方法（例如 clone() 和 fill_()）来实现相同的结果更有效且更安全。

除了 data_ptr 之外，无类型存储还具有其他属性，例如 filename（如果存储指向磁盘上的文件）、device 或 is_cuda 用于设备检查。还可以使用 copy_、fill_ 或 pin_memory 等方法就地或异地操作存储。有关更多信息，请查看下面的 API 参考。请记住，修改存储是低级 API，并且存在风险！大多数这些 API 也存在于张量级别：如果存在，则应优先于其存储对应项。

特殊情况

我们提到，具有非 None grad 属性的张量实际上在其内部具有两个数据块。在这种情况下，untyped_storage() 将返回 data 属性的存储，而梯度的存储可以通过 tensor.grad.untyped_storage() 获得。

>>> t = torch.zeros(3, requires_grad=True)
>>> t.sum().backward()
>>> assert list(t.untyped_storage()) == [0] * 12  # the storage of the tensor is just 0s
>>> assert list(t.grad.untyped_storage()) != [0] * 12  # the storage of the gradient isn't

在某些特殊情况下，张量没有典型的存储，或者根本没有存储

• "meta" 设备上的张量： "meta" 设备上的张量用于形状推断，不保存实际数据。

• 伪张量：PyTorch 编译器使用的另一个内部工具是 FakeTensor，它基于类似的想法。

张量子类或类张量对象也可能显示不寻常的行为。通常，我们不希望许多用例需要在 Storage 级别操作！

class torch.UntypedStorage(*args, **kwargs)

bfloat16()

将此存储转换为 bfloat16 类型。

bool()

将此存储转换为 bool 类型。

byte()

将此存储转换为 byte 类型。

byteswap(dtype)

交换底层数据中的字节。

char()

将此存储转换为 char 类型。

clone()

返回此存储的副本。

complex_double()

将此存储转换为复数双精度类型。

complex_float()

将此存储转换为复数浮点类型。

copy_()

cpu()

如果此存储不在 CPU 上，则返回其 CPU 副本。

cuda(device=None, non_blocking=False)

返回此对象在 CUDA 内存中的副本。

如果此对象已在 CUDA 内存中并且在正确的设备上，则不执行复制，并返回原始对象。

参数

• device (int) – 目标 GPU ID。默认为当前设备。

• non_blocking (bool) – 如果为 True 且源在 pinned 内存中，则复制将相对于主机异步进行。否则，此参数无效。

返回类型

Union[_StorageBase, TypedStorage]

data_ptr()

device: device

double()

将此存储转换为双精度类型。

element_size()

property filename: Optional[str]

返回与此存储关联的文件名。

如果存储在 CPU 上并且是通过 from_file() 创建的，且 shared 为 True，则文件名将为字符串。否则，此属性为 None。

fill_()

float()

将此存储转换为浮点类型。

float8_e4m3fn()

将此存储转换为 float8_e4m3fn 类型

float8_e4m3fnuz()

将此存储转换为 float8_e4m3fnuz 类型

float8_e5m2()

将此存储转换为 float8_e5m2 类型

float8_e5m2fnuz()

将此存储转换为 float8_e5m2fnuz 类型

static from_buffer()

static from_file(filename, shared=False, size=0) → Storage

创建由内存映射文件支持的 CPU 存储。

如果 shared 为 True，则内存将在所有进程之间共享。所有更改都将写入文件。如果 shared 为 False，则存储上的更改不会影响文件。

size 是存储中元素的数量。如果 shared 为 False，则文件必须至少包含 size * sizeof(Type) 字节（Type 是存储的类型，在 UnTypedStorage 的情况下，文件必须至少包含 size 字节）。如果 shared 为 True，则将在需要时创建文件。

参数

• filename (str) – 要映射的文件名

• shared (bool) – 是否共享内存（是否将 MAP_SHARED 或 MAP_PRIVATE 传递给底层的 mmap(2) 调用）

• size (int) – 存储中元素的数量

get_device()

返回类型

int

half()

将此存储转换为半精度类型。

hpu(device=None, non_blocking=False)

返回此对象在 HPU 内存中的副本。

如果此对象已在 HPU 内存中并且在正确的设备上，则不执行复制，并返回原始对象。

参数

• device (int) – 目标 HPU ID。默认为当前设备。

• non_blocking (bool) – 如果为 True 且源在 pinned 内存中，则复制将相对于主机异步进行。否则，此参数无效。

返回类型

Union[_StorageBase, TypedStorage]

int()

将此存储转换为 int 类型。

property is_cuda

property is_hpu

is_pinned(device='cuda')

确定 CPU 存储是否已在设备上 pinned。

参数

device (str 或 torch.device) – 要在其上 pin 内存的设备。默认值：'cuda'。

返回

一个布尔变量。

is_shared()

is_sparse: bool = False

is_sparse_csr: bool = False

long()

将此存储转换为 long 类型。

mps()

如果此存储尚未在 MPS 上，则返回其 MPS 副本。

nbytes()

new()

pin_memory(device='cuda')

将 CPU 存储复制到固定内存，如果尚未固定。

参数

device (str 或 torch.device) – 要在其上 pin 内存的设备。默认值：'cuda'。

返回

一个固定的 CPU 存储。

resizable()

resize_()

share_memory_(*args, **kwargs)

将存储移动到共享内存。

对于已在共享内存中的存储以及 CUDA 存储（它们不需要为了跨进程共享而移动）来说，这是一个空操作。共享内存中的存储无法调整大小。

请注意，为了缓解诸如 this 之类的问题，从同一对象的多个线程调用此函数是线程安全的。但是，在没有适当同步的情况下，在 self 上调用任何其他函数是**不**线程安全的。有关更多详细信息，请参阅 多进程最佳实践。

注意

当删除对共享内存中存储的所有引用时，关联的共享内存对象也将被删除。PyTorch 有一个特殊的清理过程，以确保即使当前进程意外退出，也会发生这种情况。

值得注意的是 share_memory_() 和 from_file() 与 shared = True 之间的区别

1. share_memory_ 使用 shm_open(3) 创建 POSIX 共享内存对象，而 from_file() 使用 open(2) 打开用户传递的文件名。

2. 两者都使用带有 MAP_SHARED 的 mmap(2) 调用，以将文件/对象映射到当前的虚拟地址空间

3. share_memory_ 将在映射对象后调用 shm_unlink(3)，以确保在没有进程打开对象时释放共享内存对象。torch.from_file(shared=True) 不会取消链接该文件。该文件是持久性的，将一直保留到用户删除它为止。

返回

self

short()

将此存储转换为 short 类型。

size()

返回类型

int

to(*, device, non_blocking=False)

tolist()

返回包含此存储元素的列表。

type(dtype=None, non_blocking=False)

返回类型

Union[_StorageBase, TypedStorage]

untyped()

旧版类型化存储

警告

出于历史原因，PyTorch 之前使用过类型化存储类，这些类现已弃用，应避免使用。以下详细介绍了此 API，以防您遇到它，尽管强烈建议不要使用它。除了 torch.UntypedStorage 之外的所有存储类都将在未来版本中移除，并且在所有情况下都将使用 torch.UntypedStorage。

torch.Storage 是与默认数据类型 (torch.get_default_dtype()) 对应的存储类的别名。例如，如果默认数据类型是 torch.float，则 torch.Storage 解析为 torch.FloatStorage。

类似于 torch.FloatStorage、torch.IntStorage 等，torch.<type>Storage 和 torch.cuda.<type>Storage 类实际上从未被实例化。调用它们的构造函数会创建一个带有适当 torch.dtype 和 torch.device 的 torch.TypedStorage。torch.<type>Storage 类具有与 torch.TypedStorage 相同的所有类方法。

torch.TypedStorage 是特定 torch.dtype 元素的连续一维数组。它可以被赋予任何 torch.dtype，并且内部数据将被适当地解释。torch.TypedStorage 包含一个 torch.UntypedStorage，它将数据保存为字节的无类型数组。

每个步长 torch.Tensor 都包含一个 torch.TypedStorage，用于存储 torch.Tensor 查看的所有数据。

class torch.TypedStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

bfloat16()

将此存储转换为 bfloat16 类型。

bool()

将此存储转换为 bool 类型。

byte()

将此存储转换为 byte 类型。

char()

将此存储转换为 char 类型。

clone()

返回此存储的副本。

complex_double()

将此存储转换为复数双精度类型。

complex_float()

将此存储转换为复数浮点类型。

copy_(source, non_blocking=None)

cpu()

如果此存储不在 CPU 上，则返回其 CPU 副本。

cuda(device=None, non_blocking=False)

返回此对象在 CUDA 内存中的副本。

如果此对象已在 CUDA 内存中并且在正确的设备上，则不执行复制，并返回原始对象。

参数

• device (int) – 目标 GPU ID。默认为当前设备。

• non_blocking (bool) – 如果为 True 且源在 pinned 内存中，则复制将相对于主机异步进行。否则，此参数无效。

返回类型

Self

data_ptr()

property device

double()

将此存储转换为双精度类型。

dtype: dtype

element_size()

property filename: Optional[str]

如果存储是从文件内存映射的，则返回与此存储关联的文件名。如果存储不是通过内存映射文件创建的，则返回 None。

fill_(value)

float()

将此存储转换为浮点类型。

float8_e4m3fn()

将此存储转换为 float8_e4m3fn 类型

float8_e4m3fnuz()

将此存储转换为 float8_e4m3fnuz 类型

float8_e5m2()

将此存储转换为 float8_e5m2 类型

float8_e5m2fnuz()

将此存储转换为 float8_e5m2fnuz 类型

classmethod from_buffer(*args, **kwargs)

classmethod from_file(filename, shared=False, size=0) → Storage

创建由内存映射文件支持的 CPU 存储。

如果 shared 为 True，则内存将在所有进程之间共享。所有更改都将写入文件。如果 shared 为 False，则存储上的更改不会影响文件。

size 是存储中的元素数量。如果 shared 为 False，则文件必须至少包含 size * sizeof(Type) 字节（Type 是存储的类型）。如果 shared 为 True，则将在需要时创建文件。

参数

• filename (str) – 要映射的文件名

• shared (bool) –

  是否共享内存（是否将 MAP_SHARED 或 MAP_PRIVATE 传递给底层的 mmap(2) 调用）

• size (int) – 存储中元素的数量

get_device()

返回类型

int

half()

将此存储转换为半精度类型。

hpu(device=None, non_blocking=False)

返回此对象在 HPU 内存中的副本。

如果此对象已在 HPU 内存中并且在正确的设备上，则不执行复制，并返回原始对象。

参数

• device (int) – 目标 HPU ID。默认为当前设备。

• non_blocking (bool) – 如果为 True 且源在 pinned 内存中，则复制将相对于主机异步进行。否则，此参数无效。

返回类型

Self

int()

将此存储转换为 int 类型。

property is_cuda

property is_hpu

is_pinned(device='cuda')

确定 CPU TypedStorage 是否已在设备上固定。

参数

device (str 或 torch.device) – 要在其上固定内存的设备。默认值：'cuda'

返回

一个布尔变量。

is_shared()

is_sparse: bool = False

long()

将此存储转换为 long 类型。

nbytes()

pickle_storage_type()

pin_memory(device='cuda')

将 CPU TypedStorage 复制到固定内存，如果尚未固定。

参数

device (str 或 torch.device) – 要在其上 pin 内存的设备。默认值：'cuda'。

返回

一个固定的 CPU 存储。

resizable()

resize_(size)

share_memory_()

请参阅 torch.UntypedStorage.share_memory_()

short()

将此存储转换为 short 类型。

size()

to(*, device, non_blocking=False)

返回此对象在设备内存中的副本。

如果此对象已在正确的设备上，则不执行复制，并返回原始对象。

参数

• device (int) – 目标设备。

• non_blocking (bool) – 如果为 True 且源在 pinned 内存中，则复制将相对于主机异步进行。否则，此参数无效。

返回类型

Self

tolist()

返回包含此存储元素的列表。

type(dtype=None, non_blocking=False)

如果未提供 dtype，则返回类型，否则将此对象转换为指定的类型。

如果这已经是正确的类型，则不执行复制，并返回原始对象。

参数

• dtype (type 或 string) – 期望的类型

• non_blocking (bool) – 如果为 True，且源在 pinned memory 中，目标在 GPU 上，反之亦然，则相对于主机异步执行复制。否则，此参数无效。

• **kwargs – 为了兼容性，可能包含键 async 以代替 non_blocking 参数。async 参数已弃用。

返回类型

Union[_StorageBase, TypedStorage, str]

untyped()

返回内部 torch.UntypedStorage。

class torch.DoubleStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.float64

class torch.FloatStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.float32

class torch.HalfStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.float16

class torch.LongStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.int64

class torch.IntStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.int32

class torch.ShortStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.int16

class torch.CharStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.int8

class torch.ByteStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.uint8

class torch.BoolStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.bool

class torch.BFloat16Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.bfloat16

class torch.ComplexDoubleStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.complex128

class torch.ComplexFloatStorage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.complex64

class torch.QUInt8Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.quint8

class torch.QInt8Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.qint8

class torch.QInt32Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.qint32

class torch.QUInt4x2Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.quint4x2

class torch.QUInt2x4Storage(*args, wrap_storage=None, dtype=None, device=None, _internal=False)

dtype: torch.dtype = torch.quint2x4