wassname/jaxtyping
1
0
Fork 0
mirror of https://github.com/wassname/jaxtyping.git synced 2026-09-09 11:24:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doc updates 2

Browse Source
This commit is contained in:
Patrick Kidger
2022-08-30 13:26:41 -07:00
parent 07e735797e
commit 140be9ecec
2 changed files with 24 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+2 -2
View File
@@ -18,7 +18,7 @@ In addition some modifiers can be applied:
- Prepend `#` to a dimension to indicate that it can be that size *or* equal to one -- i.e. broadcasting is acceptable, e.g. `add(x: Float[Array, "#foo"], y: Float[Array, "#foo"]) -> Float[Array, "#foo"]`.
- Prepend `_` to a dimension to disable any runtime checking of that dimension (so that it can be used just as documentation). This can also be used as just `_` on its own: e.g. `"b c _ _"`.
The order of these modifiers does not matter.
When using multiple modifiers, their order does not matter.
As a special case:
- `...`: anonymous zero or more axes (equivalent to `*_`) e.g. `"... c h w"`
@@ -60,7 +60,7 @@ f32[Array, "some_shape"]
### Array
The array should typically be a `jaxtyping.Array`, which is an alias for `jnp.ndarray`.
The array should typically be a `jaxtyping.Array`, which is an alias for `jax.numpy.ndarray`.
But you can use other types as well. `jaxtyping` has support for JAX, NumPy, TensorFlow, and PyTorch, e.g.:
```python