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: Write user guide page on apply/map/transform methods #61126

Open
datapythonista opened this issue Mar 15, 2025 · 3 comments · May be fixed by #61195
Open

DOC: Write user guide page on apply/map/transform methods #61126

datapythonista opened this issue Mar 15, 2025 · 3 comments · May be fixed by #61195
Assignees
Labels
Apply Apply, Aggregate, Transform, Map Docs

Comments

@datapythonista
Copy link
Member

There is some information in our documentation regarding how to use user defined functions in pandas. The API pages of the used methods, and these sections:

My understanding is that we've been mostly discouraging the use of functions like apply, or at least the community has with many posts and comments regarding apply is slow, which seem fair. With the work going on supporting JIT compilers on these functions (see #54666 and #61032) this can hopefully change, and allow in some cases for clearer code while not compromising speed.

I think it may be difficult to communicate all the information related to udf in the existing sections on group by and FAQ pages and in the API docs. A dedicated page in the users guide that guides users on when to use udf, a general idea of the API, the differences between the different methods, the options available... seems a better idea.

Also, the APIs of the different methods are quite inconsistent, and in some cases cumbersome. I think writing this page will be a good exercise to identify cases when explaining the functionality to the users is complex and not intuitive, and see if we can address them.

@datapythonista datapythonista added Apply Apply, Aggregate, Transform, Map Docs labels Mar 15, 2025
@arthurlw
Copy link
Contributor

I'm interested in working on this user guide. Just to clarify, this user guide should provide guidance on everything about udfs (when to use them, their differences, etc), rather than just document what they do, correct?

@arthurlw
Copy link
Contributor

take

@arthurlw arthurlw linked a pull request Mar 28, 2025 that will close this issue
5 tasks
@rhshadrach
Copy link
Member

Also, the APIs of the different methods are quite inconsistent, and in some cases cumbersome.

Related: #40112

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Apply Apply, Aggregate, Transform, Map Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants