jax-ml/jax · error · TypeError
takes a scalar pred as argument, got
Error message
{prim_name} takes a scalar pred as argument, got {pred} What it means
checkify.check requires a scalar boolean predicate; this fires in the internal _check helper (referencing the user-facing 'check' name) when the predicate is an array or other non-scalar, because check must be a single true/false decision, not an elementwise test.
Solutions
- Reduce the predicate to a scalar: check((x > 0).all()) or pick a specific element
- Verify the pred is boolean — add an explicit cast like jnp.asarray(pred).astype(bool) if needed
- For per-element diagnostics, check each invariant separately or format values into the message
Example fix
# before
checkify.check(x > 0, 'x positive', x) # x is an array
# after
checkify.check((x > 0).all(), 'x positive: {}', x) Defensive patterns
Strategy: type-guard
Validate before calling
def is_scalar_pred(pred) -> bool:
return isinstance(pred, (bool, np.bool_)) or (hasattr(pred, 'shape') and getattr(pred, 'shape', None) == () and str(getattr(pred, 'dtype', '')).startswith('bool')) Type guard
def is_scalar_pred(pred) -> bool:
a = jnp.asarray(pred)
return a.shape == () and a.dtype == jnp.bool_ Prevention
- Always reduce array predicates with .all()/.any()
- Write a small assert helper check_scalar(pred) in test suites
When it happens
Trigger: Passing a non-scalar pred to checkify.check, e.g. an array of booleans, an int, or a shaped tracer instead of a scalar bool.
Common situations: Writing check(x > 0) where x is an array (author intended .all() or .all(axis=...)); passing Python bools of arrays; using debug_check with vectorized conditions.
Related errors
- `addupdate` must be called on `Ref` types
- args argument to jax.scipy.optimize.minimize must be a…
- Argument ' ' of type ' ' is not a valid JAX type
- : arrays must have same number of dimensions, got .
- async done op got , want core.AbstractFuture
AI-assisted analysis of jax-ml/jax@1e1c6a8fc0 (2026-08-27).
Data as JSON: /api/errors/8d7f48e621bc3698.
Report an issue: GitHub.
Appendix: source
Thrown at jax/_src/checkify.py:1295
>>> import jax.numpy as jnp
>>> from jax.experimental import checkify
>>> def f(x):
... checkify.check(x>0, "{x} needs to be positive!", x=x)
... return 1/x
>>> checked_f = checkify.checkify(f)
>>> err, out = jax.jit(checked_f)(-3.)
>>> err.throw() # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
jax._src.checkify.JaxRuntimeError: -3. needs to be positive!
"""
_check(pred, msg, debug, *fmt_args, **fmt_kwargs)
def _check(pred, msg, debug, *fmt_args, **fmt_kwargs):
if not is_scalar_pred(pred):
prim_name = 'debug_check' if debug else 'check'
raise TypeError(f'{prim_name} takes a scalar pred as argument, got {pred}')
for arg in jtu.tree_leaves((fmt_args, fmt_kwargs)):
if not isinstance(arg, (Array, np.ndarray)):
raise TypeError('Formatting arguments to checkify.check need to be '
'PyTrees of arrays, but got '
f'{arg!r} of type {type(arg)}.')
new_error = FailedCheckError(get_traceback(), msg, *fmt_args, **fmt_kwargs)
error = assert_func(init_error, jnp.logical_not(pred), new_error)
_check_error(error, debug=debug)
def _check_error(error, *, debug=False):
if any(map(np.shape, error._pred.values())):
error = _reduce_any_error(error)
err_args, tree_def = tree_flatten(error)
return check_p.bind(*err_args, err_tree=tree_def, debug=debug)
def is_scalar_pred(pred) -> bool:View on GitHub (pinned to 1e1c6a8fc0)