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.

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

Jump to bottom

The jax.numpy.average function is rendering repeatedly in Docs #13853

Open
fnhirwa opened this issue Jan 4, 2023 · 1 comment
Open

The jax.numpy.average function is rendering repeatedly in Docs #13853

fnhirwa opened this issue Jan 4, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@fnhirwa
Copy link
Contributor

fnhirwa commented Jan 4, 2023 •
edited

Description

This is being caused by repetition of the same function at the implementation side
reduction functions
I am going to open a pull request that can fix the mentioned issue

image

What jax/jaxlib version are you using?

No response

Which accelerator(s) are you using?

CPU

Additional system info

Linux

NVIDIA GPU info

No response
@fnhirwa fnhirwa added the bug Something isn't working label Jan 4, 2023
This was referenced Jan 4, 2023
Closed
Closed
@jakevdp
Copy link
Collaborator

jakevdp commented Jan 4, 2023

Hi - thanks for the report. I think this is intended: the jnp.average function has multiple type overloads, and this is how sphinx represents this in the documentation. The key difference in each is the annotation of returned, and how it affects the return value.

Still, I agree that it makes the docs a bit busy. I wonder if there's a way to tell sphinx to avoid repeating the definition?

@jakevdp jakevdp mentioned this issue Jan 4, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
2 participants
@jakevdp @fnhirwa