torchfix icon indicating copy to clipboard operation
torchfix copied to clipboard

Add documentation for TorchFix rules

Open kit1980 opened this issue 1 year ago • 7 comments

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.

TOR101 Use of deprecated function

  • [x] Add doc for torch.chain_matmul
  • [x] Add doc for torch.cholesky
  • [x] Add doc for torch.qr
  • [x] Add doc for torch.range

The rest

  • [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

kit1980 avatar May 28 '24 20:05 kit1980

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

arunppsg avatar Jun 04 '24 17:06 arunppsg

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

swayam0322 avatar Jun 05 '24 06:06 swayam0322

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

zabboud avatar Jun 05 '24 22:06 zabboud

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

kit1980 avatar Jun 05 '24 22:06 kit1980

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

kit1980 avatar Jun 05 '24 22:06 kit1980

Hey @kit1980

I can work on the following tasks of the issue:

TOR101 Use of deprecated function

  • [ ] Add doc for torch.chain_matmul
  • [ ] Add doc for torch.cholesky
  • [ ] Add doc for torch.qr
  • [ ] Add doc for torch.range

The rest

  • [ ] Add doc for TOR203 Consider replacing 'import torchvision.models as models'

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

sshkhr avatar Jun 06 '24 14:06 sshkhr

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

kit1980 avatar Jun 06 '24 20:06 kit1980