Enhance README with LightGBM Installation Guidance for Mac M1 Users #1766
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
xisen-w
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This update introduces additional guidance in the README for Mac users with M1 chips who encounter issues installing LightGBM, a dependency of PyQlib. A new section under installation tips provides a workaround for the common
wheel buildingerror related to missing OpenMP dependencies.Motivation and Context
During the installation of PyQlib on Mac systems with M1 chips, users may face difficulties building LightGBM due to missing OpenMP dependencies. This issue has been highlighted in several community discussions. The added instructions aim to streamline the installation process, enhancing user experience and supporting broader adoption of PyQlib on Mac platforms.
How Has This Been Tested?
The provided solution has been manually tested on a Mac with an M1 chip. Following the updated README instructions resulted in a successful installation of PyQlib, including the correct setup of LightGBM.
Screenshots of Test Results (if appropriate):
Not entirely applicable as this update involves documentation only. The results for installation are shown
Types of changes
I've added a specific tip for Mac M1 users in the README, outlining the need to install
libompusing Homebrew before attempting to install PyQlib. This step addresses a common issue where the installation process fails due to missing OpenMP dependencies required by LightGBM. The aim is to make the setup process smoother for Mac users and minimize installation-related inquiries.