-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add Warning for Ubuntu LTS installation instructions #3670
Conversation
Thanks for opening your first pull request in this repository! Someone will review it when they have a chance. In the mean time, please be sure that you've handled the following things, to make the review process quicker and easier:
Thank you again for your contributions! 👍 |
doc/quickstart/cpp.md
Outdated
repositories may not always be the latest. This can lead to issues, such as | ||
missing header files (e.g., mlpack.hpp missing in versions prior to 4.0). To | ||
ensure compatibility with the latest mlpack features and examples, we recommend | ||
either building mlpack from source or using Docker, as explained in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest to omit mention of Docker, as that can muddle the problem further.
If a novice user is unable to figure that there is a clash between old and new versions of mlpack, I don't think sending them to the Docker path is helpful.
An advanced user will be able to figure out that Docker is an option anyway, by reading the instructions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, that sounds like a good idea. I'm even thinking that all the second part of the paragraph might be unnecessary. But I guess it doesn't hurt to have it.
Anyway, I committed a version with the docker part removed. Thanks for the feedback!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Second approval provided automatically after 24 hours. 👍
Hello there! Thanks for your contribution. I see that this is your first contribution to mlpack. If you'd like to add your name to the list of contributors in In addition, if you'd like some stickers to put on your laptop, I'd be happy to help get them in the mail for you. Just send an email with your physical mailing address to stickers@mlpack.org, and then one of the mlpack maintainers will put some stickers in an envelope for you. It may take a few weeks to get them, depending on your location. 👍 |
Description:
This PR refines the installation section of the mlpack Quickstart guide to better serve Ubuntu LTS users, who may face issues due to outdated libmlpack-dev versions in their repositories (currently version 3.4.2). The lack of the mlpack.hpp header in these versions can hinder new users' ability to run mlpack successfully.
Changes:
libmlpack-dev
version.Appreciate your review and feedback on this documentation update.