Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for TorchFix rules #56

Open
5 of 10 tasks
kit1980 opened this issue May 28, 2024 · 7 comments
Open
5 of 10 tasks

Add documentation for TorchFix rules #56

kit1980 opened this issue May 28, 2024 · 7 comments
Labels
docathon-h1-2024 documentation Improvements or additions to documentation easy

Comments

@kit1980
Copy link
Contributor

kit1980 commented May 28, 2024

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

  • 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 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
Copy link
Contributor

arunppsg commented Jun 4, 2024

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

@swayam0322
Copy link

swayam0322 commented Jun 5, 2024

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

  • 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

@swayam0322 swayam0322 mentioned this issue Jun 5, 2024
6 tasks
swayam0322 added a commit to swayam0322/torchfix that referenced this issue Jun 5, 2024
@zabboud
Copy link

zabboud commented Jun 5, 2024

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
Copy link
Contributor Author

kit1980 commented Jun 5, 2024

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

@kit1980
Copy link
Contributor Author

kit1980 commented Jun 5, 2024

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

@sshkhr
Copy link

sshkhr commented Jun 6, 2024

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!

@kit1980
Copy link
Contributor Author

kit1980 commented Jun 6, 2024

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

swayam0322 added a commit to swayam0322/torchfix that referenced this issue Jun 7, 2024
kit1980 pushed a commit that referenced this issue Jun 17, 2024
#59)

Partially addresses #56
Added `TOR101` deprecation doc for `torch.cholesky`,
`torch.chain_matmul`, `torch.qr`, `torch.range`.
@sbrugman sbrugman added the documentation Improvements or additions to documentation label Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docathon-h1-2024 documentation Improvements or additions to documentation easy
Projects
None yet
Development

No branches or pull requests

6 participants