Skip to content

Commit 40e021a

Browse files
authored
Use Alerts markdown in Readme (#30)
1 parent 5e51d01 commit 40e021a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ reporting issues.
1313
TorchFix can be used as a Flake8 plugin (linting only) or as a standalone
1414
program (with autofix available for a subset of the lint violations).
1515

16-
Currently TorchFix is in a **beta version** stage, so there are still a lot of rough
16+
> [!WARNING]
17+
> Currently TorchFix is in a **beta version** stage, so there are still a lot of rough
1718
edges and many things can and will change.
1819

1920
## Installation
@@ -36,7 +37,8 @@ TorchFix can also be run as a standalone program: `torchfix .`
3637
Add `--fix` parameter to try to autofix some of the issues (the files will be overwritten!)
3738
To see some additional debug info, add `--show-stderr` parameter.
3839

39-
Please keep in mind that autofix is a best-effort mechanism. Given the dynamic nature of Python,
40+
> [!CAUTION]
41+
> Please keep in mind that autofix is a best-effort mechanism. Given the dynamic nature of Python,
4042
and especially the beta version status of TorchFix, it's very difficult to have
4143
certainty when making changes to code, even for the seemingly trivial fixes.
4244

@@ -83,9 +85,9 @@ for details.
8385

8486
#### torch.nn.utils.weight_norm
8587

86-
This function is deprecated. Use :func:`torch.nn.utils.parametrizations.weight_norm`
87-
which uses the modern parametrization API. The new ``weight_norm`` is compatible
88-
with ``state_dict`` generated from old ``weight_norm``.
88+
This function is deprecated. Use `torch.nn.utils.parametrizations.weight_norm`
89+
which uses the modern parametrization API. The new `weight_norm` is compatible
90+
with `state_dict` generated from old `weight_norm`.
8991

9092
Migration guide:
9193

0 commit comments

Comments
 (0)