Skip to content

Commit 1eaf737

Browse files
Update README.md
1 parent 1dd8964 commit 1eaf737

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1-
<h1 align='center'>torchtyping</h1>
2-
<h2 align='center'>Type annotations for a tensor's shape, dtype, names, ...</h2>
1+
# Please use jaxtyping instead
2+
3+
*Welcome! For new projects I now **strongly** recommend using my newer [jaxtyping](https://github.com/google/jaxtyping) project instead. It supports PyTorch, doesn't actually depend on JAX, and unlike TorchTyping it is compatible with static type checkers. The 'jax' in the name is now historical!*
4+
5+
<br>
6+
<br>
7+
<br>
38

4-
*Welcome! For new projects I now **strongly** recommend using my newer [jaxtyping](https://github.com/google/jaxtyping) project instead. It supports PyTorch, doesn't actually depend on JAX, and unlike TorchTyping it is compatible with static type checkers. :)*
9+
The original torchtyping README is as follows.
510

611
---
712

13+
<h1 align='center'>torchtyping</h1>
14+
<h2 align='center'>Type annotations for a tensor's shape, dtype, names, ...</h2>
15+
816
Turn this:
917
```python
1018
def batch_outer_product(x: torch.Tensor, y: torch.Tensor) -> torch.Tensor:

0 commit comments

Comments
 (0)