Skip to content

Commit 1360a45

Browse files
committed
Fix quickstart snippet
1 parent e301a1f commit 1360a45

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/content/get-started.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,16 @@ Now you're ready to jump into our [examples](https://github.com/pasteurlabs/tess
6262

6363
## Sharp edges
6464

65-
- **Arrays vs. array-like objects**: Tesseract-JAX ist stricter than Tesseract Core in that all array inputs to Tesseracts must be JAX or NumPy arrays, not just any array-like (such as Python floats or lists). As a result, you may need to convert your inputs to JAX arrays before passing them to Tesseract-JAX, including scalar values.
65+
- **Arrays vs. array-like objects**: Tesseract-JAX is stricter than Tesseract Core in that all array inputs to Tesseracts must be JAX or NumPy arrays, not just any array-like (such as Python floats or lists). As a result, you may need to convert your inputs to JAX arrays before passing them to Tesseract-JAX, including scalar values.
6666

6767
```python
6868
from tesseract_core import Tesseract
6969
from tesseract_jax import apply_tesseract
7070

71-
tess = Tesseract.from_image("vectoradd")
72-
apply_tesseract(tess, {"a": 1.0, "b": 2.0}) # ❌ raises an error
73-
apply_tesseract(tess, {"a": jnp.array(1.0), "b": jnp.array(2.0)}) # ✅ works
71+
tess = Tesseract.from_image("vectoradd_jax")
72+
with Tesseract.from_image("vectoradd_jax") as tess:
73+
apply_tesseract(tess, {"a": {"v": jnp.array([1.0])}, "b": {"v": jnp.array([2.0])}}) # ✅ works
74+
apply_tesseract(tess, {"a": {"v": [1.0]}, "b": {"v": [2.0]}}) # ❌ raises an error
7475
```
7576
- **Additional required endpoints**: Tesseract-JAX requires the [`abstract_eval`](https://docs.pasteurlabs.ai/projects/tesseract-core/latest/content/api/endpoints.html#abstract-eval) Tesseract endpoint to be defined for all operations. This is because JAX mandates abstract evaluation of all operations before they are executed. Additionally, many gradient transformations like `jax.grad` require [`vector_jacobian_product`](https://docs.pasteurlabs.ai/projects/tesseract-core/latest/content/api/endpoints.html#vector-jacobian-product) to be defined.
7677

0 commit comments

Comments
 (0)