pandas icon indicating copy to clipboard operation
pandas copied to clipboard

DOC: "Accelerated operations" talks about speedup in obsolete versions of Pandas

Open wjandrea opened this issue 1 year ago • 2 comments

Pandas version checks

  • [X] I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/user_guide/basics.html#accelerated-operations

Permalink to specific line:

https://github.com/pandas-dev/pandas/blob/a89f20853591516b4ba45a1fbadbf645247d133e/doc/source/user_guide/basics.rst?plain=1#L161

Documentation problem

0.11.0 is more than 10 years old and, of course, before the first stable release.

Suggested fix for documentation

If the important thing is the speedup you get from enabling a feature, then just talk about the speedup instead of when the feature first became available.

Something like this:

    :header: "Operation", "With speedup (ms)", "Without speedup (ms)", "Ratio"

wjandrea avatar Jun 28 '24 00:06 wjandrea

Thanks for the suggestion! While this change would in fact portray the speed difference, the problem with it is that the speeds may become inaccurate overtime, so I think keeping the version number is necessary.

How about updating it with something like: v2.2.0 with speedup (ms) and v2.2.0 without speedup (ms)

Aloqeely avatar Jun 28 '24 13:06 Aloqeely

I would recommend just removing that timing table section and just linking to https://pandas.pydata.org/pandas-docs/stable/user_guide/enhancingperf.html#eval-performance-comparison instead

mroeschke avatar Jun 28 '24 16:06 mroeschke

Is this still up .. as first time contributor, I would like to work on this if possible ?

TheRockStarDBA avatar Jul 18 '24 20:07 TheRockStarDBA

@BadakalaYashwanth or @mroeschke can I take over this issue ? seems like BadakalaYashwanth has not seen this update.

TheRockStarDBA avatar Jul 19 '24 15:07 TheRockStarDBA

@BadakalaYashwanth or @mroeschke can I take over this issue ? seems like BadakalaYashwanth has not seen this update.

Hi @TheRockStarDBA,

Apologies for missing your update. You can certainly take over the issue. Please let me know if there’s anything specific you need from me or if there are any additional details I should be aware of.

Thanks for stepping in!

Best, Badakala Yaswanth

BadakalaYashwanth avatar Jul 19 '24 15:07 BadakalaYashwanth

take

TheRockStarDBA avatar Jul 19 '24 15:07 TheRockStarDBA

@TheRockStarDBA are you still working on this?

KevsterAmp avatar Aug 04 '24 23:08 KevsterAmp

@KevsterAmp yes .. submitting a PR soon.

TheRockStarDBA avatar Aug 04 '24 23:08 TheRockStarDBA

@TheRockStarDBA Hey, I tried to play a little bit with devin and open source and he chose this issue out of the many "easy" issues that exists in this repo. He solved the problem by removing it but if you have better solution it will probably be better.

anuk909 avatar Aug 05 '24 13:08 anuk909