Add documentation for TorchFix rules

pytorch-labs / torchfix

TorchFix - a linter for PyTorch-using code with autofix support

Other

98 stars 16 forks source link

Open kit1980 opened 5 months ago

kit1980 commented 5 months ago

Add documentation for the rules to the https://github.com/pytorch-labs/torchfix/blob/main/README.md, see the existing file for examples.

If you what to work on a task, please comment on this issue and link your PR when you have it.

[x] Add doc for TOR102 torch.load without weights_only parameter is unsafe
[ ] Add doc for TOR104 Use of non-public function
[ ] Add doc for TOR201 Find and fix deprecated pretrained parameters in TorchVision models
[ ] Add doc for TOR202 The transform v2.ToTensor() is deprecated
[ ] Add doc for TOR203 Consider replacing 'import torchvision.models as models'
[ ] Add doc for TOR401 Detected DataLoader running with synchronized implementation

arunppsg commented 5 months ago

I would like to take up TOR101 deprecation docs - torch.chain_matmul, torch.cholesky, torch.qr, torch.range.

swayam0322 commented 5 months ago

Hey @kit1980, I would like to work on the issue under the Docathon-2024

[x] Add doc for TOR102 torch.load without weights_only parameter is unsafe
[x] Add doc for TOR104 Use of non-public function
[x] Add doc for TOR201 Find and fix deprecated pretrained parameters in TorchVision models
[x] Add doc for TOR202 The transform v2.ToTensor() is deprecated
[x] Add doc for TOR203 Consider replacing 'import torchvision.models as models'
[x] Add doc for TOR401 Detected DataLoader running with synchronized implementation

zabboud commented 5 months ago

Hey @kit1980, I would like to work on the issue under the Docathon-2024

@swayam0322 -- use / assigntome to make sure that the issue is assigned to you

kit1980 commented 5 months ago

assigntome doesn't work in this repo, just commenting on the issue is fine.

kit1980 commented 5 months ago

But please mention the specific items from the list to you want to do.

sshkhr commented 5 months ago

Hey @kit1980

I can work on the following tasks of the issue:

Let me know if it's okay for me to work on these, and I can send in a PR. Cheers!

kit1980 commented 5 months ago

@sshkhr You don't need to ask. Just check that there is no overlap with what others already commented on.