Skip to content

Fix vjp type annotation #33938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix vjp type annotation #33938

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions jax/_src/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2152,19 +2152,19 @@ def _temporary_dtype_exception(a, a_) -> bool:
def vjp(fun: Callable[..., T],
*primals: Any,
has_aux: Literal[False] = False,
reduce_axes: Sequence[AxisName] = ()) -> tuple[T, Callable]:
reduce_axes: Sequence[AxisName] = ()) -> tuple[T, VJP]:
...

@overload
def vjp(fun: Callable[..., tuple[T, U]], *primals: Any,
has_aux: Literal[True],
reduce_axes: Sequence[AxisName] = ()) -> tuple[T, Callable, U]:
reduce_axes: Sequence[AxisName] = ()) -> tuple[T, VJP, U]:
...

@partial(api_boundary, repro_api_name="jax.vjp")
def vjp(
fun: Callable, *primals, has_aux: bool = False, reduce_axes=()
) -> tuple[Any, Callable] | tuple[Any, Callable, Any]:
) -> tuple[Any, VJP] | tuple[Any, VJP, Any]:
"""Compute a (reverse-mode) vector-Jacobian product of ``fun``.

:py:func:`grad` is implemented as a special case of :py:func:`vjp`.
Expand Down
Loading