Community
Join the PyTorch developer community to contribute, learn, and get your questions answered.
Community Stories
Learn how our community solves real, everyday machine learning problems with PyTorch.
Developer Resources
Find resources and get questions answered
Events
Find events, webinars, and podcasts
Forums
A place to discuss PyTorch code, issues, install, research
Models (Beta)
Discover, publish, and reuse pre-trained models
torch.
eye
(
n
,
m
=
None
,
*
,
out
=
None
,
dtype
=
None
,
layout
=
torch.strided
,
device
=
None
,
requires_grad
=
False
)
→
Tensor
Returns a 2-D tensor with ones on the diagonal and zeros elsewhere.
Parameters
n
(
int
) – the number of rows
m
(
int
,
optional
) – the number of columns with default being
n
Keyword Arguments
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
.
Returns
A 2-D tensor with ones on the diagonal and zeros elsewhere
Return type
Tensor
Example:
>>> torch.eye(3)
tensor([[ 1., 0., 0.],
[ 0., 1., 0.],
[ 0., 0., 1.]])
For web site terms of use, trademark policy and other policies applicable to The PyTorch Foundation please see
www.linuxfoundation.org/policies/. The PyTorch Foundation supports the PyTorch open source
project, which has been established as PyTorch Project a Series of LF Projects, LLC. For policies applicable to the PyTorch Project a Series of LF Projects, LLC,
please see www.lfprojects.org/policies/.
