Skip to content

DOC: Suggested build_ext command may fail on low-resource machines #52529

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

Closed
1 task done
cai-lw opened this issue Apr 7, 2023 · 1 comment · Fixed by #52557
Closed
1 task done

DOC: Suggested build_ext command may fail on low-resource machines #52529

cai-lw opened this issue Apr 7, 2023 · 1 comment · Fixed by #52557
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@cai-lw
Copy link
Contributor

cai-lw commented Apr 7, 2023

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/docs/dev/development/contributing_environment.html#step-3-build-and-install-pandas

Documentation problem

On low resource machines python setup.py build_ext -j 4 may fail due to concurrent compiling jobs exhausting memory.

I had this problem when developing in GitHub Codespace, in which the smallest (and default) machine has only 2 CPU cores and 4GB of memory.

Suggested fix for documentation

Three options:

  1. Add a comment # The number after -j is the number of compiling jobs run in parallel. Change it according to your machine's hardware spec.
  2. Change the command to python setup.py build_ext -j 2.
  3. Setting a minimum specification for codespace machines
@cai-lw cai-lw added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Apr 7, 2023
@phofl
Copy link
Member

phofl commented Apr 8, 2023

Thanks for your report. I'd prefer option 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants