torch.eye#
- 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:
- Keyword Arguments:
out (Tensor,optional) – the output tensor.
dtype (
torch.dtype, optional) – the desired data type of returned tensor.Default: ifNone, uses a global default (seetorch.set_default_dtype()).layout (
torch.layout, optional) – the desired layout of returned Tensor.Default:torch.strided.device (
torch.device, optional) – the desired device of returned tensor.Default: ifNone, uses the current device for the default tensor type(seetorch.set_default_device()).devicewill be the CPUfor CPU tensor types and the current CUDA device for CUDA tensor types.requires_grad (bool,optional) – If autograd should record operations on thereturned tensor. Default:
False.
- Returns:
A 2-D tensor with ones on the diagonal and zeros elsewhere
- Return type:
Example:
>>>torch.eye(3)tensor([[ 1., 0., 0.], [ 0., 1., 0.], [ 0., 0., 1.]])