vsplit() in PyTorch

*Memos:

• My post explains split().
• My post explains hsplit().
• My post explains dsplit().
• My post explains tensor_split().
• My post explains chunk().
• My post explains unbind().

vsplit() can vertically split a 2D or more D tensor into 1 or more tensors as shown below:

*Memos:

• vsplit() can be used with torch and a tensor.
• The 1st argument(tensor of int, float, complex or bool) with torch or using a tensor(tensor of int, float, complex or bool) is input(Required).
• The 2nd argument(int) with torch or the 1st argument(int) with a tensor is sections(Required).
• The 2nd argument(tuple of int or list of int) with torch or the 1st argument(tuple of int or list of int) with a tensor is indices(Required).
• The total number of the zero or more elements of the one or more returned tensors changes.
• The one or more returned tensors keep the dimension of the input tensor.

import torch

my_tensor = torch.tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]])

torch.vsplit(input=my_tensor, sections=1)
my_tensor.vsplit(1)
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),)

torch.vsplit(input=my_tensor, sections=3)
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(0,))
torch.vsplit(input=my_tensor, indices=(-3,))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(1,))
torch.vsplit(input=my_tensor, indices=(-2,))
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(2,))
torch.vsplit(input=my_tensor, indices=(-1,))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(3,))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(0, 0))
torch.vsplit(input=my_tensor, indices=(0, -3))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(0, 1))
torch.vsplit(input=my_tensor, indices=(0, -2))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(0, 2))
torch.vsplit(input=my_tensor, indices=(0, -1))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(0, 3))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(1, 0))
torch.vsplit(input=my_tensor, indices=(1, -3))
# (tensor([[0, 1, 2, 3]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(1, 1))
torch.vsplit(input=my_tensor, indices=(1, -2))
# (tensor([[0, 1, 2, 3]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(1, 2))
torch.vsplit(input=my_tensor, indices=(1, -1))
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(1, 3))
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(2, 0))
torch.vsplit(input=my_tensor, indices=(2, -3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(2, 1))
torch.vsplit(input=my_tensor, indices=(2, -2))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(2, 2))
torch.vsplit(input=my_tensor, indices=(2, -1))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(2, 3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(3, 0))
torch.vsplit(input=my_tensor, indices=(3, -3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(3, 1))
torch.vsplit(input=my_tensor, indices=(3, -2))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(3, 2))
torch.vsplit(input=my_tensor, indices=(3, -1))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(3, 3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(-1, 0))
torch.vsplit(input=my_tensor, indices=(-1, -3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-1, 1))
torch.vsplit(input=my_tensor, indices=(-1, -2))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-1, 2))
torch.vsplit(input=my_tensor, indices=(-1, -1))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-1, 3))
# (tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(-2, 0))
# (tensor([[0, 1, 2, 3]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-2, 1))
# (tensor([[0, 1, 2, 3]]),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-2, 2))
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-2, 3))
# (tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

torch.vsplit(input=my_tensor, indices=(-3, 0))
torch.vsplit(input=my_tensor, indices=(-3, -3))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-3, 1))
torch.vsplit(input=my_tensor, indices=(-3, -2))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3]]),
#  tensor([[4, 5, 6, 7], [8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-3, 2))
torch.vsplit(input=my_tensor, indices=(-3, -1))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7]]),
#  tensor([[8, 9, 10, 11]]))

torch.vsplit(input=my_tensor, indices=(-3, 3))
# (tensor([], size=(0, 4), dtype=torch.int64),
#  tensor([[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]),
#  tensor([], size=(0, 4), dtype=torch.int64))

my_tensor = torch.tensor([[0., 1., 2., 3.],
                          [4., 5., 6., 7.],
                          [8., 9., 10., 11.]])
torch.vsplit(input=my_tensor, sections=1)
# (tensor([[0., 1., 2., 3.],
#          [4., 5., 6., 7.],
#          [8., 9., 10., 11.]]),)

my_tensor = torch.tensor([[0.+0.j, 1.+0.j, 2.+0.j, 3.+0.j],
                          [4.+0.j, 5.+0.j, 6.+0.j, 7.+0.j],
                          [8.+0.j, 9.+0.j, 10.+0.j, 11.+0.j]])
torch.vsplit(input=my_tensor, sections=1)
# (tensor([[0.+0.j, 1.+0.j, 2.+0.j, 3.+0.j],
#          [4.+0.j, 5.+0.j, 6.+0.j, 7.+0.j],
#          [8.+0.j, 9.+0.j, 10.+0.j, 11.+0.j]]),)

my_tensor = torch.tensor([[True, False, True, False],
                          [False, True, False, True],
                          [True, False, True, False]])
torch.vsplit(input=my_tensor, sections=1)
# (tensor([[True, False, True, False],
#          [False, True, False, True],
#          [True, False, True, False]]),)