Skip to content
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.

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

Expand docs for the :axes option in Nx.gather/3 #1443

Closed
Benjamin-Philip opened this issue Feb 13, 2024 · 2 comments
Closed

Expand docs for the :axes option in Nx.gather/3 #1443

Benjamin-Philip opened this issue Feb 13, 2024 · 2 comments

Comments

@Benjamin-Philip
Copy link
Contributor

The documentation for the :axes option inNx.gather/3 can do with some clarification:

  • All the examples pertain to collecting subsets. The docs do not explain if and how you can collect scalars.
  • The list "nature" of :axes is not explained. All the examples have only a single axis in the list. What is the difference between axes: [0, 1] and axes: [1]?
  • The description "The :axes option controls which dimensions the indexes point to" can be cryptic to someone new to the library
  • (optional, potentially too verbose) An example of "leading axes" can be helpful to someone new.
@josevalim
Copy link
Collaborator

PRs welcome!

@Benjamin-Philip
Copy link
Contributor Author

I'd be happy to send a PR except that these were issues (at least the first 2) that I encountered myself while reading the docs, i.e. I don't understand the :axes option. If you're okay with going back and forth a bit, so that I can understand the option, I'll send one in a few days. Or else, somebody else could address this?

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

No branches or pull requests

2 participants