Skip to content

Commit

Permalink
docs(README): update rule code assignment policy
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrugman authored Sep 12, 2024
1 parent 4b1667f commit 734fc10
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,16 @@ To enable them, use standard flake8 configuration options for the plugin mode or
If you encounter a bug or some other problem with TorchFix, please file an issue on
https://github.com/pytorch-labs/torchfix/issues.

## Rule code assignment policy
## Rule Code Assignment Policy

New rule codes are assigned incrementally across the following categories:

* **TOR0XX**: Errors in general-purpose PyTorch usage (e.g. removed function usage).
* **TOR1XX**: Warnings in PyTorch usage (e.g. deprecated functions)
* **TOR2XX**: TorchVision features
* **TOR4XX**: Performance tuning and optimization features (e.g. profiling tools).
* **TOR9XX**: Testing and unstable features.
* **TOR0XX, TOR1XX**: General-purpose `torch` functionality.
* **TOR2XX**: Domain-specific rules, such as TorchVision.
* **TOR4XX**: Noisy rules that are disabled by default.
* **TOR9XX**: Internal rules specific for `pytorch/pytorch` repo, other users should not use these.

TOR0, TOR1 and TOR2 are enabled by default.

## Rules

Expand Down

0 comments on commit 734fc10

Please sign in to comment.