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

Why the name "mllaunchpad" and not the more conventional "ml-launchpad"? #62

Open
schuderer opened this issue Feb 8, 2020 · 1 comment
Labels
faq (Candidates for) an FAQ in ML Launchpad

Comments

@schuderer
Copy link
Owner

schuderer commented Feb 8, 2020

Usually, python distributions use a hyphen - to separate words. Why does ML Launchpad stick everything together? People that are used to the hyphen convention might try (and fail) to install ml-launchpad.

@schuderer schuderer added the faq (Candidates for) an FAQ in ML Launchpad label Feb 8, 2020
@schuderer
Copy link
Owner Author

schuderer commented Feb 8, 2020

It was a tough choice to deviate from the convention, but using mllaunchpad has (in our opinion) the smallest chance for mistakes.

We want the same name for the installable package (distribution) and the importable package.

We observed how particularly new Python users struggle with this. They find a code snippet that has an import awesome_package in it, and subsequently run pip install awesome_package (instead of pip install awesome-package). Or that they see code with import slack in it and actually install the wrong package with pip install slack.

I personally am used to this convention. But we observed this mistake several times already, and this is a compromise which doesn't require renaming the complete ML Launchpad project.

Edit: We are planning to use a hyphen to separate ML Launchpad related distributions, e.g. mllaunchpad-spark (which will be separate packages, published and installable separately from core mllaunchpad).

@schuderer schuderer changed the title Why the name "mllaunchpad" and not the recommended "ml-launchpad" Why the name "mllaunchpad" and not the more conventional "ml-launchpad" Feb 8, 2020
@schuderer schuderer changed the title Why the name "mllaunchpad" and not the more conventional "ml-launchpad" Why the name "mllaunchpad" and not the more conventional "ml-launchpad"? Feb 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
faq (Candidates for) an FAQ in ML Launchpad
Projects
None yet
Development

No branches or pull requests

1 participant