Skip to content

DOC improve build instructions to be friendlier to first time contributors #21353

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

Merged
merged 3 commits into from
Oct 16, 2021

Conversation

ogrisel
Copy link
Member

@ogrisel ogrisel commented Oct 16, 2021

Based on the feedback of today's Data Umbrella sprint install session, I thought we can further improve our setup instructions:

  • Give explicit instructions to install a base Python environment from Miniforge3 since it supports all major operating systems.
  • Give explicit instructions to setup a dedicated conda-env with the build dependencies
  • Move the compiler instructions below the Python installation step to be able to use Python to introspect the bitness of the platform (32 bit or 64 bit) when installing the compiler.
  • On some linux systems, the wheel package is not automatically installed in newly created virtualenv

Cosmetic: I also tried to use more consistent indentation levels in the bash prompts.

/cc @reshamas

Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If rendered correctly, I'm happy with the nice improvement!

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small comment on the alternative, otherwise LGTM

@ogrisel
Copy link
Member Author

ogrisel commented Oct 16, 2021

Rendering looks good. Merging.

@ogrisel ogrisel merged commit 2ec028d into scikit-learn:main Oct 16, 2021
@ogrisel ogrisel deleted the update-build-instructions branch October 16, 2021 23:24
@reshamas
Copy link
Member

I'm a little confused with the docs.
It looks like the instructions for "Advanced Installation" are here:
https://scikit-learn.org/dev/developers/index.html

But, my process would be to first go to "Contributing Guide" here:
https://scikit-learn.org/dev/developers/contributing.html

But, the instructions for building from source are ("buried") in Step 5:

If you receive errors in building scikit-learn, see the Building from source section.

The "Building from Source" are the instructions that @amueller has been showing at the sprints, and what has worked, but are not very prominent.

Can we add a section:

Building from Source
====================

and point it to: https://scikit-learn.org/dev/developers/index.html

@ogrisel
Copy link
Member Author

ogrisel commented Oct 19, 2021

Thanks for the feedback @reshamas. I agree.

@glemaitre glemaitre mentioned this pull request Oct 23, 2021
10 tasks
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 23, 2021
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants