This should resolve #95 by simply adding lightgbm to the setup.py file. I tested with a local re-install and the automatic sleep staging worked without any additional install of lightgbm.
In the original issue, I suggested the SleepStaging doc should reference the pip (or conda) installable versions of lightgbm. But now that it comes installed with YASA, I don't think that's necessary anymore. However, now that the user doesn't need to install neither antropy nor lightgbm manually, I find that doc wording a bit misleading in a different way. It's worded as the user should be installing them manually ("To run the automatic sleep staging, you must install..."). Is the point just to acknowledge their use?
Assuming you want that note kept in, I reworded it slightly to just say that the automatic staging uses them rather than asking the user to install them. But if it's all the same to you I would just take that whole comment out. It's confusing to me because the algorithm requires a lot of other packages too. And since the user doesn't need to install anything else it doesn't feel pertinent. But either is cool with me!
This should resolve #95 by simply adding
lightgbmto thesetup.pyfile. I tested with a local re-install and the automatic sleep staging worked without any additional install oflightgbm.In the original issue, I suggested the
SleepStagingdoc should reference the pip (or conda) installable versions oflightgbm. But now that it comes installed with YASA, I don't think that's necessary anymore. However, now that the user doesn't need to install neitherantropynorlightgbmmanually, I find that doc wording a bit misleading in a different way. It's worded as the user should be installing them manually ("To run the automatic sleep staging, you must install..."). Is the point just to acknowledge their use?Assuming you want that note kept in, I reworded it slightly to just say that the automatic staging uses them rather than asking the user to install them. But if it's all the same to you I would just take that whole comment out. It's confusing to me because the algorithm requires a lot of other packages too. And since the user doesn't need to install anything else it doesn't feel pertinent. But either is cool with me!