Shortcuts

What is PyTorch?

It’s a Python-based scientific computing package targeted at two sets of audiences:

  • A replacement for NumPy to use the power of GPUs
  • a deep learning research platform that provides maximum flexibility and speed

Getting Started

Tensors

Tensors are similar to NumPy’s ndarrays, with the addition being that Tensors can also be used on a GPU to accelerate computing.

from __future__ import print_function
import torch

Construct a 5x3 matrix, uninitialized:

x = torch.empty(5, 3)
print(x)

Out:

tensor([[ 3.5274e-35,  3.0819e-41,  1.7431e+31],
        [ 4.5776e-41, -2.7703e+03,  4.5776e-41],
        [-1.1466e+03,  4.5776e-41, -2.5713e+03],
        [ 4.5776e-41,  1.0878e+31,  4.5776e-41],
        [ 1.0879e+31,  4.5776e-41, -1.3934e+04]])

Construct a randomly initialized matrix:

x = torch.rand(5, 3)
print(x)

Out:

tensor([[0.3231, 0.8529, 0.8825],
        [0.4089, 0.2260, 0.1355],
        [0.1589, 0.8079, 0.8936],
        [0.9116, 0.6615, 0.3421],
        [0.8433, 0.7444, 0.8530]])

Construct a matrix filled zeros and of dtype long:

x = torch.zeros(5, 3, dtype=torch.long)
print(x)

Out:

tensor([[0, 0, 0],
        [0, 0, 0],
        [0, 0, 0],
        [0, 0, 0],
        [0, 0, 0]])

Construct a tensor directly from data:

x = torch.tensor([5.5, 3])
print(x)

Out:

tensor([5.5000, 3.0000])

or create a tensor based on an existing tensor. These methods will reuse properties of the input tensor, e.g. dtype, unless new values are provided by user

x = x.new_ones(5, 3, dtype=torch.double)      # new_* methods take in sizes
print(x)

x = torch.randn_like(x, dtype=torch.float)    # override dtype!
print(x)                                      # result has the same size

Out:

tensor([[1., 1., 1.],
        [1., 1., 1.],
        [1., 1., 1.],
        [1., 1., 1.],
        [1., 1., 1.]], dtype=torch.float64)
tensor([[-0.6637,  0.2651, -0.5369],
        [ 0.1688, -0.2723,  1.8381],
        [-0.9423, -1.7050,  0.1831],
        [-0.4818, -0.7804, -1.3767],
        [-1.3778,  0.8425, -0.3808]])

Get its size:

print(x.size())

Out:

torch.Size([5, 3])

Note

torch.Size is in fact a tuple, so it supports all tuple operations.

Operations

There are multiple syntaxes for operations. In the following example, we will take a look at the addition operation.

Addition: syntax 1

y = torch.rand(5, 3)
print(x + y)

Out:

tensor([[-0.5208,  0.7914,  0.0644],
        [ 0.4282,  0.4557,  2.6910],
        [-0.0622, -1.0434,  0.2861],
        [-0.0949, -0.3743, -0.4322],
        [-1.0761,  1.6251,  0.0488]])

Addition: syntax 2

print(torch.add(x, y))

Out:

tensor([[-0.5208,  0.7914,  0.0644],
        [ 0.4282,  0.4557,  2.6910],
        [-0.0622, -1.0434,  0.2861],
        [-0.0949, -0.3743, -0.4322],
        [-1.0761,  1.6251,  0.0488]])

Addition: providing an output tensor as argument

result = torch.empty(5, 3)
torch.add(x, y, out=result)
print(result)

Out:

tensor([[-0.5208,  0.7914,  0.0644],
        [ 0.4282,  0.4557,  2.6910],
        [-0.0622, -1.0434,  0.2861],
        [-0.0949, -0.3743, -0.4322],
        [-1.0761,  1.6251,  0.0488]])

Addition: in-place

# adds x to y
y.add_(x)
print(y)

Out:

tensor([[-0.5208,  0.7914,  0.0644],
        [ 0.4282,  0.4557,  2.6910],
        [-0.0622, -1.0434,  0.2861],
        [-0.0949, -0.3743, -0.4322],
        [-1.0761,  1.6251,  0.0488]])

Note

Any operation that mutates a tensor in-place is post-fixed with an _. For example: x.copy_(y), x.t_(), will change x.

You can use standard NumPy-like indexing with all bells and whistles!

print(x[:, 1])

Out:

tensor([ 0.2651, -0.2723, -1.7050, -0.7804,  0.8425])

Resizing: If you want to resize/reshape tensor, you can use torch.view:

x = torch.randn(4, 4)
y = x.view(16)
z = x.view(-1, 8)  # the size -1 is inferred from other dimensions
print(x.size(), y.size(), z.size())

Out:

torch.Size([4, 4]) torch.Size([16]) torch.Size([2, 8])

If you have a one element tensor, use .item() to get the value as a Python number

x = torch.randn(1)
print(x)
print(x.item())

Out:

tensor([1.4933])
1.493319034576416

Read later:

100+ Tensor operations, including transposing, indexing, slicing, mathematical operations, linear algebra, random numbers, etc., are described here.

NumPy Bridge

Converting a Torch Tensor to a NumPy array and vice versa is a breeze.

The Torch Tensor and NumPy array will share their underlying memory locations, and changing one will change the other.

Converting a Torch Tensor to a NumPy Array

a = torch.ones(5)
print(a)

Out:

tensor([1., 1., 1., 1., 1.])
b = a.numpy()
print(b)

Out:

[1. 1. 1. 1. 1.]

See how the numpy array changed in value.

a.add_(1)
print(a)
print(b)

Out:

tensor([2., 2., 2., 2., 2.])
[2. 2. 2. 2. 2.]

Converting NumPy Array to Torch Tensor

See how changing the np array changed the Torch Tensor automatically

import numpy as np
a = np.ones(5)
b = torch.from_numpy(a)
np.add(a, 1, out=a)
print(a)
print(b)

Out:

[2. 2. 2. 2. 2.]
tensor([2., 2., 2., 2., 2.], dtype=torch.float64)

All the Tensors on the CPU except a CharTensor support converting to NumPy and back.

CUDA Tensors

Tensors can be moved onto any device using the .to method.

# let us run this cell only if CUDA is available
# We will use ``torch.device`` objects to move tensors in and out of GPU
if torch.cuda.is_available():
    device = torch.device("cuda")          # a CUDA device object
    y = torch.ones_like(x, device=device)  # directly create a tensor on GPU
    x = x.to(device)                       # or just use strings ``.to("cuda")``
    z = x + y
    print(z)
    print(z.to("cpu", torch.double))       # ``.to`` can also change dtype together!

Out:

tensor([2.4933], device='cuda:0')
tensor([2.4933], dtype=torch.float64)

Total running time of the script: ( 0 minutes 5.795 seconds)

Gallery generated by Sphinx-Gallery

Docs

Access comprehensive developer documentation for PyTorch

View Docs

Tutorials

Get in-depth tutorials for beginners and advanced developers

View Tutorials

Resources

Find development resources and get your questions answered

View Resources