Skip to content

Conversation

@jakevdp
Copy link
Collaborator

@jakevdp jakevdp commented Dec 16, 2025

This matches NumPy's behavior and also aligns with the next revision of the Array API standard in the case of meshgrid and broadcast_arrays.

I plan to merge this for JAX v0.9.0 unless there are unforseen issues downstream.

This changes the return types of jnp.atleast_*d, jnp.broadcast_arrays, jnp.meshgrid, jnp.ogrid, and jnp.histogramdd.
@jakevdp jakevdp self-assigned this Dec 16, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jakevdp, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the jax.numpy library to align its function return types with the behavior expected in NumPy 2.0 and the Array API standard. Specifically, functions that previously returned lists of arrays will now return tuples of arrays, ensuring consistency and future compatibility. This change impacts several array manipulation and generation functions within JAX, making the library more consistent with the broader Python scientific computing ecosystem.

Highlights

  • Return Type Alignment: Modified several jax.numpy functions, including ogrid, histogramdd, broadcast_arrays, atleast_1d, atleast_2d, atleast_3d, and meshgrid, to consistently return tuples of arrays instead of lists of arrays.
  • NumPy 2.0 Compatibility: These changes align jax.numpy's behavior with the upcoming NumPy 2.0 standard and the next revision of the Array API standard, particularly for meshgrid and broadcast_arrays.
  • Type Hint Updates: Updated type annotations in both implementation files and .pyi stub files to reflect the new tuple return types for the affected functions, ensuring type consistency.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request consistently updates several JAX NumPy functions, including _Ogrid.__getitem__, histogramdd, broadcast_arrays, atleast_1d, atleast_2d, atleast_3d, meshgrid, and _broadcast_arrays, to return tuples of arrays instead of lists of arrays. This change involves modifying function signatures, return statements, and docstring examples in jax/_src/numpy/index_tricks.py, jax/_src/numpy/lax_numpy.py, and jax/_src/numpy/util.py, along with updating the corresponding type hints in jax/numpy/__init__.pyi. A review comment specifically clarified and confirmed the correctness of using tuple[()] as the type hint for functions that return an empty tuple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant