pandas-dev / pandas

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more
https://pandas.pydata.org
BSD 3-Clause "New" or "Revised" License
42.57k stars 17.56k forks source link

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

Open wjandrea opened 3 days ago

wjandrea commented 3 days ago

Pandas version checks

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"
Aloqeely commented 2 days ago

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)

mroeschke commented 2 days ago

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