Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Should we create an FAQ (or see if we already have a place) #27871

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

Open
seberg opened this issue Nov 27, 2024 · 6 comments
Open

DOC: Should we create an FAQ (or see if we already have a place) #27871

seberg opened this issue Nov 27, 2024 · 6 comments

Comments

@seberg
Copy link
Member

seberg commented Nov 27, 2024

There are a few pitfalls that come up more than others:

  • OpenBLAS/BLAS threading, causing slowdowns with multi-processing.
    • For this one, I think it may be fine to link to
  • General confusion about numerical precision
  • ...?

We had discussed this once in the triage meeting, because these keep coming up every now and then. It might not help much for users, but may just be helpful to have an easy link available on issues.

Please feel free to edit or comment other things. More than two things may be good if we have a FAQ.

@rgommers
Copy link
Member

A FAQ seems like a not so good idea. FAQs almost always are quite incomplete and go out of date over time. We used to have one a long time ago IIRC, and it was exactly like that - a random grab bag of stuff with mostly outdated specific problems.

For topics like threading and numerical precision, it'd be great to have good docs pages, that will be quite valuable. That still solves the problem at hand here (you can link to the relevant page) without starting a FAQ.

@rgommers
Copy link
Member

Note that there is already https://numpy.org/devdocs/user/troubleshooting-importerror.html, which has already started degrading, a number of entries haven't been relevant in quite a while.

@StanFromIreland
Copy link
Contributor

+1 For the idea. I can get started working on this if help is wanted.

@melissawm
Copy link
Member

Instead of an FAQ, adding a couple pages to the "Advanced usage and interoperability" section of the main ToCtree or to the https://numpy.org/devdocs/dev/underthehood.html section sounds like a good idea.

I think the best strategy would be for someone to have a chat with @seberg and pick his brain on the main things to mention - maybe at a docs meeting?

@amitsubhashchejara
Copy link
Contributor

@melissawm The "Advanced usage and interoperability" section sounds like a good idea, but please can you shortly summarize what the discussion here is about? I want to contribute and think about it.

@mattip
Copy link
Member

mattip commented Dec 2, 2024

You can look through the issues for problems with OpenBLAS threading and oversubscription, like #27174, #27605, #16990. Numerical floating point precision comes up in issues like #23733, #25269, #27782. There are more.

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

No branches or pull requests

6 participants