easier LightGBM install

[remrama]

The LightGBM requirement is pip installable but their documentation doesn't say so. I remember finding this very frustrating after I struggled (and failed) with a clunky install based on their docs only to later find out it's a simple one-liner.

I think it'd be nice if the SleepStaging class documentation just included this as a parenthetical after mentioning the requirement.

To run the automatic sleep staging, you must install the LightGBM and antropy packages (both are easily installed with pip).

Or just linking to the LightGBM pypi site instead of docs.

To run the automatic sleep staging, you must install the LightGBM and antropy packages.

Alternatively, just include them in requirements.txt? I supposed you were aiming to keep it lightweight, which is totally fine, but I think that this a core feature of YASA so wouldn't be that weird if it was included in the full install.

[raphaelvallat]

Hi @remrama,

Both are actually included in the requirements.txt file. However I see now that lightgbm is not included in the setup.py file — we should absolutely fix this. I also like your first suggestion to enhance the documentation.

Please feel free to submit a PR!

Thanks Raphael