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.

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

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

Open
1 task done
wjandrea opened this issue Jun 28, 2024 · 2 comments · May be fixed by #59157
Open
1 task done

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

wjandrea opened this issue Jun 28, 2024 · 2 comments · May be fixed by #59157

Comments

@wjandrea
Copy link
Contributor

Pandas version checks

  • 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:

:header: "Operation", "0.11.0 (ms)", "Prior Version (ms)", "Ratio to Prior"

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 wjandrea added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 28, 2024
@Aloqeely
Copy link
Member

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 Aloqeely removed the Needs Triage Issue that has not been reviewed by a pandas team member label Jun 28, 2024
@mroeschke
Copy link
Member

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

BadakalaYashwanth pushed a commit to BadakalaYashwanth/Open-Source-Accelerated-operations-pandas--59130 that referenced this issue Jul 1, 2024
@BadakalaYashwanth BadakalaYashwanth linked a pull request Jul 1, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants