Fix the Doc of pivot in torch.lu #159616
Description
📚 The doc issue
The doc of torch.lu() shows its description as below:
Line 2127 in d994027
Think that it should be the same as:
pytorch/torch/linalg/__init__.py
Lines 2460 to 2461 in 83e2ea8
I accept that it should raise error, but need to note on doc.
Both have the same action on repro, especially on CPU aspect:
Repro
import torch
import numpy as np
data = np.random.rand(10, 10)
input_data = torch.from_numpy(data).float()
torch.lu(input_data, pivot=False) # RuntimeError: linalg.lu_factor: LU without pivoting is not implemented on the CPU
torch.linalg.lu_factor(input_data, pivot=False) # RuntimeError: linalg.lu_factor: LU without pivoting is not implemented on the CPUThanks for noting!
Suggest a potential alternative/fix
- Fix the doc of
torch.lu()to meet the usage limitaion.