Skip to content

DOC Point users to pretty conda-forge install page #30617

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 1 commit into from
Jan 10, 2025

Conversation

betatim
Copy link
Member

@betatim betatim commented Jan 10, 2025

TIL from @jakirkham that conda-forge/miniforge has a pretty and good looking page with install instructions: https://conda-forge.org/download/

I updated the docs to point people there instead of the IMHO somewhat scary/unexpected GitHub page we were currently using. I think that page is a bit unusual for people who aren't familiar with GitHub already, where as the new page looks official and nice. In addition people have been mentioning that the GitHub install page gets flagged by browsers as "this site contains harmful content" (probably because of curl foo | bash style instructions) and the new page doesn't get flagged.

I tried to replace the occurrences of the miniforge GitHub link.

I also tried to update the "branding"/wording so that we talk about installing conda-forge instead of miniforge. I think it is helpful to use the same words/brand that appears on the top of the page we link to. At least I find it jarring when I get told "To install foo go to X" and then X talks about "installing bar". @jakirkham is "conda-forge installer" the word you use/we should use? I've lost track of the various combos of mini x conda x mamba x forge so please point out what the right one is if I got it wrong.

Copy link

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: e6d9102. Link to the linter CI: here

@betatim
Copy link
Member Author

betatim commented Jan 10, 2025

One question that I should know the answer to but don't: will this update the instructions on https://scikit-learn.org/stable/ when we merge it? If not, is it easy to do that? It would be nice to have these nicer install instructions before we release 1.7 (or would they get updated with 1.6.1?)

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM!

@jeremiedbb
Copy link
Member

One question that I should know the answer to but don't: will this update the instructions on https://scikit-learn.org/stable/ when we merge it? If not, is it easy to do that? It would be nice to have these nicer install instructions before we release 1.7 (or would they get updated with 1.6.1?)

It will if we backport it in the 1.6.X branch. The stable version of the website is built from the 1.6.X branch while the dev version of the website is built from the main branch.

@jeremiedbb jeremiedbb added the To backport PR merged in master that need a backport to a release branch defined based on the milestone. label Jan 10, 2025
@jeremiedbb jeremiedbb merged commit 5691f26 into scikit-learn:main Jan 10, 2025
38 checks passed
@jakirkham
Copy link
Contributor

Thanks Tim for putting this together! Also thanks Olivier and Jeremie for your help reviewing! 🙏

This is great to see 😄

Hope scikit-learn users find this helpful. Also agree with all your points about this being a gentle entry for new users. Would be interested in hearing any feedback you hear from users about this page. Open to iterating on further improvements as needed

I also tried to update the "branding"/wording so that we talk about installing conda-forge instead of miniforge. I think it is helpful to use the same words/brand that appears on the top of the page we link to. At least I find it jarring when I get told "To install foo go to X" and then X talks about "installing bar". @jakirkham is "conda-forge installer" the word you use/we should use? I've lost track of the various combos of mini x conda x mamba x forge so please point out what the right one is if I got it wrong.

Ah you have asked a deep question about naming 😅

It is a good question though. Also you have nicely pointed out that we (conda-forge) have unfortunately confused folks with all the different variants we created over the years 😬

We are trying to cutdown on this. For example Miniforge now ships with Mamba. Also conda-forge dropped PyPy. So we were able to deprecate and recently remove these two installers ( conda-forge/miniforge#704 ). We are now down to just Miniforge

It is tricky to balance the interest in the latest thing and keeping things manageable for new users while simultaneously not trying to bloat the installer. In other words the famous 3 options, which you can only pick 2 of 😂. We have moved a bit towards the latter. Though there are plenty of interesting developments on the horizon. Welcome feedback on how we can handle this better 🙂

Though to get back to the heart of your question. Miniforge is the brand (and interestingly the repo with the most stars in conda-forge). Just as you have the conda-forge download page also reference conda-forge installer on the download page just as you do. Think it is ok to refer to conda-forge installer here (as we are also doing the same). Also expect that may make more sense to a user seeing this for the first time

I guess the one thing I wonder about is how much stuff users expect a conda-forge installer to contain. We have had conversations with user groups that express interest in having more battery included installers (like with the PyData stack). So it will be interesting to see whether this particular name gives the impression more is (or should be) included in the installer

Anyways happy with what we have here. Based on what feedback comes up we can always adapt things as needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation To backport PR merged in master that need a backport to a release branch defined based on the milestone.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants