empty¶

Documentation¶

treetensor.torch.empty(*args, **kwargs)[source]¶

In treetensor, you can use ones to create a tree of tensors with the uninitialized values.

Example:

>>> import torch
>>> import treetensor.torch as ttorch
>>> ttorch.empty(2, 3)  # the same as torch.empty(2, 3)
tensor([[-1.3267e-36,  3.0802e-41,  2.3000e+00],
        [ 2.3000e+00,  2.3000e+00,  2.3000e+00]])

>>> ttorch.empty({'a': (2, 3), 'b': {'x': (4, )}})
<Tensor 0x7ff363bb6080>
├── a --> tensor([[-3.6515e+14,  4.5900e-41, -1.3253e-36],
│                 [ 3.0802e-41,  2.3000e+00,  2.3000e+00]])
└── b --> <Tensor 0x7ff363bb66d8>
    └── x --> tensor([-3.6515e+14,  4.5900e-41, -3.8091e-38,  3.0802e-41])

Torch Version Related

This documentation is based on torch.empty in torch v2.4.1+cu121. Its arguments’ arrangements depend on the version of pytorch you installed.

If some arguments listed here are not working properly, please check your pytorch’s version with the following command and find its documentation.

python -c 'import torch;print(torch.__version__)'

The arguments and keyword arguments supported in torch v2.4.1+cu121 is listed below.

Description From Torch v2.4.1+cu121¶

torch.empty(*size, *, out=None, dtype=None, layout=torch.strided, device=None, requires_grad=False, pin_memory=False, memory_format=torch.contiguous_format) → Tensor ¶

Returns a tensor filled with uninitialized data. The shape of the tensor is defined by the variable argument size.

Args:

size (int…): a sequence of integers defining the shape of the output tensor.: Can be a variable number of arguments or a collection like a list or tuple.

Keyword args:

out (Tensor, optional): the output tensor. dtype (torch.dtype, optional): the desired data type of returned tensor.

Default: if None, uses a global default (see torch.set_default_tensor_type()).

layout (torch.layout, optional): the desired layout of returned Tensor.: Default: torch.strided.
device (torch.device, optional): the desired device of returned tensor.: Default: if None, uses the current device for the default tensor type (see torch.set_default_tensor_type()). device will be the CPU for CPU tensor types and the current CUDA device for CUDA tensor types.
requires_grad (bool, optional): If autograd should record operations on the: returned tensor. Default: False.
pin_memory (bool, optional): If set, returned tensor would be allocated in: the pinned memory. Works only for CPU tensors. Default: False.
memory_format (torch.memory_format, optional): the desired memory format of: returned Tensor. Default: torch.contiguous_format.

Example:

>>> a=torch.empty((2,3), dtype=torch.int32, device = 'cuda')
>>> torch.empty_like(a)
tensor([[0, 0, 0],
        [0, 0, 0]], device='cuda:0', dtype=torch.int32)