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

Add Warning for Ubuntu LTS installation instructions #3670

Merged
merged 4 commits into from
Apr 2, 2024

Conversation

beny-dl
Copy link
Contributor

@beny-dl beny-dl commented Mar 29, 2024

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:

  • Included a note for Ubuntu LTS users about the older libmlpack-dev version.
  • Recommended building mlpack from source or using Docker for accessing the latest version.

Appreciate your review and feedback on this documentation update.

Copy link

mlpack-bot bot commented Mar 29, 2024

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:

  • All code should follow the style guide
  • Documentation added for any new functionality
  • Tests added for any new functionality
  • Tests that are added follow the testing guide
  • Headers and license information added to the top of any new code files
  • HISTORY.md updated if the changes are big or user-facing
  • All CI checks should be passing

Thank you again for your contributions! 👍

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
Copy link
Contributor

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.

Copy link
Contributor Author

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!

Copy link

@mlpack-bot mlpack-bot bot left a 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. 👍

Copy link

mlpack-bot bot commented Apr 2, 2024

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 COPYRIGHT.txt and you haven't already, please feel free to push a change to this PR---or, if it gets merged before you can, feel free to open another PR.

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. 👍

@conradsnicta conradsnicta merged commit 964f0c1 into mlpack:master Apr 2, 2024
15 of 18 checks passed
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.

None yet

2 participants