Add docs for torch.chain_matmul, torch.qr, torch.range, torch.cholesky (

#59)

Partially addresses #56
Added `TOR101` deprecation doc for `torch.cholesky`,
`torch.chain_matmul`, `torch.qr`, `torch.range`.

README.md

@@ -110,5 +110,37 @@ This function is deprecated. Use the `torch.nn.attention.sdpa_kernel` context ma
 Migration guide:
 Each boolean input parameter (defaulting to true unless specified) of `sdp_kernel` corresponds to a `SDPBackened`. If the input parameter is true, the corresponding backend should be added to the input list of `sdpa_kernel`.
 
+#### torch.chain_matmul
+
+This function is deprecated in favor of `torch.linalg.multi_dot`.
+
+Migration guide:
+`multi_dot` accepts a list of two or more tensors whereas `chain_matmul` accepted multiple tensors as input arguments. For migration, convert the multiple tensors in argument of  `chain_matmul` into a list of two or more tensors for `multi_dot`.
+
+Example: Replace `torch.chain_matmul(a, b, c)` with `torch.linalg.multi_dot([a, b, c])`.
+
+#### torch.cholesky
+
+`torch.cholesky()` is deprecated in favor of `torch.linalg.cholesky()`.
+
+Migration guide:
+* `L = torch.cholesky(A)` should be replaced with `L = torch.linalg.cholesky(A)`.
+* `L = torch.cholesky(A, upper=True)` should be replaced with `L = torch.linalg.cholesky(A).mH`
+
+#### torch.qr
+
+`torch.qr()` is deprecated in favor of `torch.linalg.qr()`.
+
+Migration guide:
+* The usage `Q, R = torch.qr(A)` should be replaced with `Q, R = torch.linalg.qr(A)`.
+* The boolean parameter `some` of `torch.qr` is replaced with a string parameter `mode` in `torch.linalg.qr`. The corresponding change in usage is from `Q, R = torch.qr(A, some=False)` to `Q, R = torch.linalg.qr(A, mode="complete")`.
+
+#### torch.range
+
+The function `torch.range()` is deprecated as its usage is incompatible with Python's builtin range. Instead, use `torch.arange()` as it produces values in `[start, end)`.
+
+Migration guide:
+* `torch.range(start, end)` produces values in the range of `[start, end]`. But `torch.arange(start, end)` produces values in `[start, end)`. For step size of 1, migrate usage from `torch.range(start, end, 1)` to `torch.arange(start, end+1, 1)`.
+
 ## License
 TorchFix is BSD License licensed, as found in the LICENSE file.