-
-
Notifications
You must be signed in to change notification settings - Fork 10.9k
Add documentation page on the internal representation of NumPy arrays #15793
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
Comments
Yes, this'd be great! Agree that this is an Explanation |
Just a quick addition: some of the proposed material is also covered in NumPy Internals in the reference guide. This material is pretty dense so I definitely agree that a distillation to a NEP44-style Explanation with a more user-centric theme would be very nice. I mention it here so that it can be drawn upon (and hopefully kept somewhat synced with) if/when anyone undertakes the Explanation doc. |
@melissawm @rgommers , I have tried to analyse it , this issue can be resolved if there is an FAQs section in the documentation , where we'll give a brief eplanation to the questions like these along with the ones which can be sourced from Stack overflow , these type of questions which may sound trivial or basic can sometime be a lot of pain in the workflow for even an experienced developer ,if we look upon this link we'll see that issues of this type are widespread , I'll try to structure a FAQs demo page where questions of such nature can be documented so that we can resolve issues like this which may occur in future too |
Hi @mrityagi , I don't think we have considered a FAQ format for this, initially we thought about an "Explanation" document. However, I do think that the questions might be a good guide into which content to cover, and this might end up being an excellent guide to the internals of NumPy. How does that sound to you? |
@melissawm yeah I think Explanation/Questions sounds more reliable and a more trustworthy word for NumPy , infact we are on the same page with thought process to structure docs like an excellent guide to internals of NumPy . I have tried to give it a structure which can be useful for such issues . Infact I totally agree with you , the need to index them into which content to cover say there can be a topic named Copies and Views , under this we can give explanations like No Copy vs Shallow Copy (ie Views) , Shallow Copy (ie views) vs Deep Copy . |
Hello, @mrityagi - I think we talked about this in the documentation meeting but I'm not sure if you intend to follow up on this? If not maybe @Mukulikaa can pick this up. Thanks! |
Agreed, thanks for flagging! |
In my understanding, based on the definitions in NEP 44, my proposal is to make an Explanation page around the topic.
I am aware about two places in the docs mentioning this topic for NumPy users: the Quickstart tutorial and NumPy: the absolute basics for beginners. The former, starts with the following:
Sometimes, even after five years using NumPy, I have to go with my gut feeling to predict if an operation will trigger a copy in the underlying data. I'd love to have an official documentation page for helping people build a better mental model of this.
Some questions and ideas:
SettingWithCopyWarning
exception in Pandas, which I believe is caused by not having a good understanding of this very same subjectThe text was updated successfully, but these errors were encountered: