[docs][python] add conda-forge install instructions #3544

raybellwaves · 2020-11-09T01:50:43Z

jameslamb

thanks!

Just a small suggestion. I'll let other reviewers comment on whether we want to document this here before I approve, but in my opinion this is a good addition.

jameslamb · 2020-11-09T04:32:35Z

docs/Python-Intro.rst

+
+    conda install -c conda-forge lightgbm
+
+**Note**: The `lightgbm-feedstock <https://github.com/conda-forge/lightgbm-feedstock>`_.  is not maintained by LightGBM maintainers.


Suggested change

**Note**: The `lightgbm-feedstock <https://github.com/conda-forge/lightgbm-feedstock>`_. is not maintained by LightGBM maintainers.

**Note**: The `lightgbm conda-forge package <https://github.com/conda-forge/lightgbm-feedstock>`_ is not maintained by LightGBM maintainers.

I'm doubt that we should document conda installation at all, because we do not maintain it and hence cannot guarantee the quality (#3414) and frequency of version updates. We don't aim to document all available ways to install LightGBM via all available package managers in the world.

I actually didn't even know about https://anaconda.org/anaconda/lightgbm that you just mentioned in #3544 (comment) . I think that's reason enough to give some guidance in our docs about how to install with conda.

We don't aim to document all available ways to install LightGBM via all available package managers in the world.

Ok but this isn't an obscure package manager like nix or snap. I think it's common, in machine learning projects in Python, to prefer conda install to pip install and I think that explicitly stating "yes this exists but we don't maintain it" in our documentation is useful.

Sorry, I'm not 100% sold on this.

ok, I'll defer to what you decide.

I think we should ask other maintainers.

ok. @henry0312 or @guolinke what do you think? The question is:

should the LightGBM Python documentation explicitly mention installing with conda install, even though we don't maintain the conda packages?

gently ping @henry0312 or @guolinke for an opinion

sorry for missing this.
I think pip is the "lighter" way, as it requires fewer dependencies. So we prefer to install via pip.
Many machine learning tools have heavy dependencies, such as cuda, so they prefer conda, which pre-installs these dependencies.

However, I think we can still provide the conda install command, but clarify that we don't maintain it.

thanks! Ok I agree with that. I can review from here.

StrikerRUS · 2020-11-09T11:52:52Z

Why conda-forge but not official conda channel?

raybellwaves · 2020-11-09T17:01:26Z

Why conda-forge but not official conda channel?

In my experience conda-forge is more up to date than the anaconda channel.

e.g. conda-forge is at v3.0.0 (last update 8 days ago) and anaconda is at v2.3.0 (last update 8 months and 11 days ago)

raybellwaves · 2020-11-09T17:07:03Z

I apologize for having some of the convo regarding this in the issue chat here

The other thing to discuss is where to put this. I feel it should go in https://github.com/microsoft/LightGBM/blob/master/python-package/README.rst#installation and the install instructions in https://lightgbm.readthedocs.io/en/latest/Python-Intro.html#install are updated from

You can install LightGBM via pip

pip install lightgbm
Refer to Python-package folder for the detailed installation guide.

To verify your installation, try to import lightgbm in Python:

import lightgbm as lgb

to

Refer to Python-package folder for the installation guide.

To verify your installation, try to import lightgbm in Python:

import lightgbm as lgb

ghost · 2020-11-10T16:06:52Z

All CLA requirements met.

jameslamb

@raybellwaves sorry for our delay on reviewing this! Thanks for working on it. Can you please see my recent review comments?

docs/Python-Intro.rst

python-package/README.rst

Co-authored-by: James Lamb <jaylamb20@gmail.com>

StrikerRUS

@raybellwaves Thanks for your contribution! I have just few minor comments.

StrikerRUS · 2021-01-10T13:53:36Z

python-package/README.rst

+Install from `conda-forge <https://anaconda.org/conda-forge/lightgbm>`_
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''


Suggested change

Install from `conda-forge <https://anaconda.org/conda-forge/lightgbm>`_

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

Install from `conda-forge channel <https://anaconda.org/conda-forge/lightgbm>`_ Using ``conda``

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

@StrikerRUS I previously recommended removing the "Using" part (#3544 (comment)). I think it makes the title more verbose but doesn't provide any additional information

Ah, I see, OK!

Then please partly ignore my previous suggestion. And I think it will make sense to remove the "Using" part from Install from PyPI Using pip heading above.

Thanks for the discussion. I'm unsure on what the suggestion is here. You are welcome to push to my branch.

sorry for the confusion. I just pushed 5a91ca1 to resolve this thread.

and ffd78bd to address @StrikerRUS 's suggestion.

python-package/README.rst

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

jameslamb

thanks Ray, looks good to me!

StrikerRUS

@raybellwaves Thanks a lot for your contribution!
@jameslamb Thanks for the help!

github-actions · 2023-08-24T02:43:01Z

This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

DOC: add conda-forge install instructions

c009390

raybellwaves requested review from jameslamb, Laurae2 and StrikerRUS as code owners November 9, 2020 01:50

jameslamb requested changes Nov 9, 2020

View reviewed changes

DOC: add conda-forge instructions

bd572ee

raybellwaves requested review from chivee, henry0312 and wxchan as code owners November 10, 2020 16:06

raybellwaves added 2 commits November 10, 2020 11:08

DOC: fix hyperlink

ce3b6d8

DOC: point to installation guide

ae4562a

jameslamb added doc awaiting review labels Nov 10, 2020

jameslamb requested changes Jan 9, 2021

View reviewed changes

docs/Python-Intro.rst Outdated Show resolved Hide resolved

python-package/README.rst Outdated Show resolved Hide resolved

python-package/README.rst Outdated Show resolved Hide resolved

StrikerRUS removed the awaiting review label Jan 9, 2021

StrikerRUS requested review from StrikerRUS and removed request for StrikerRUS January 9, 2021 14:45

raybellwaves and others added 6 commits January 9, 2021 21:24

add detailed

57a8cf9

Update python-package/README.rst

a5f1e0f

Co-authored-by: James Lamb <jaylamb20@gmail.com>

Update python-package/README.rst

542dc40

Co-authored-by: James Lamb <jaylamb20@gmail.com>

rm characters

f6ce001

add pip install

fdbfac3

add :

2ecc53a

StrikerRUS requested changes Jan 10, 2021

View reviewed changes

raybellwaves and others added 2 commits January 11, 2021 09:54

Update python-package/README.rst

22618ad

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

Update python-package/README.rst

d13bf41

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

jameslamb added 2 commits January 11, 2021 09:04

remove pip from header

5a91ca1

channel

ffd78bd

jameslamb approved these changes Jan 11, 2021

View reviewed changes

jameslamb requested a review from StrikerRUS January 11, 2021 15:10

StrikerRUS approved these changes Jan 11, 2021

View reviewed changes

StrikerRUS changed the title ~~DOC: add conda-forge install instructions~~ [docs][python] add conda-forge install instructions Jan 11, 2021

StrikerRUS merged commit 78d31d9 into microsoft:master Jan 11, 2021

StrikerRUS mentioned this pull request Jan 15, 2022

Linux CI jobs hang forever after completing all Python tests successfully #4948

Closed

github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs][python] add conda-forge install instructions #3544

[docs][python] add conda-forge install instructions #3544

raybellwaves commented Nov 9, 2020

jameslamb left a comment

jameslamb Nov 9, 2020

StrikerRUS Nov 9, 2020 •

edited

jameslamb Nov 9, 2020

StrikerRUS Nov 11, 2020

jameslamb Nov 11, 2020

StrikerRUS Nov 11, 2020

jameslamb Nov 11, 2020

jameslamb Dec 22, 2020

guolinke Jan 9, 2021

jameslamb Jan 9, 2021

StrikerRUS commented Nov 9, 2020

raybellwaves commented Nov 9, 2020

raybellwaves commented Nov 9, 2020

ghost commented Nov 10, 2020 •

edited by ghost

jameslamb left a comment

StrikerRUS left a comment

StrikerRUS Jan 10, 2021

jameslamb Jan 10, 2021

StrikerRUS Jan 10, 2021 •

edited

raybellwaves Jan 11, 2021

jameslamb Jan 11, 2021

jameslamb Jan 11, 2021

jameslamb left a comment

StrikerRUS left a comment

github-actions bot commented Aug 24, 2023


		conda install -c conda-forge lightgbm

		Note: The `lightgbm-feedstock <https://github.com/conda-forge/lightgbm-feedstock>`_. is not maintained by LightGBM maintainers.

	Note: The `lightgbm-feedstock <https://github.com/conda-forge/lightgbm-feedstock>`_. is not maintained by LightGBM maintainers.
	Note: The `lightgbm conda-forge package <https://github.com/conda-forge/lightgbm-feedstock>`_ is not maintained by LightGBM maintainers.

		Install from `conda-forge <https://anaconda.org/conda-forge/lightgbm>`_
		'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

[docs][python] add conda-forge install instructions #3544

[docs][python] add conda-forge install instructions #3544

Conversation

raybellwaves commented Nov 9, 2020

jameslamb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StrikerRUS Nov 9, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StrikerRUS commented Nov 9, 2020

raybellwaves commented Nov 9, 2020

raybellwaves commented Nov 9, 2020

ghost commented Nov 10, 2020 • edited by ghost

jameslamb left a comment

Choose a reason for hiding this comment

StrikerRUS left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StrikerRUS Jan 10, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jameslamb left a comment

Choose a reason for hiding this comment

StrikerRUS left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 24, 2023

StrikerRUS Nov 9, 2020 •

edited

ghost commented Nov 10, 2020 •

edited by ghost

StrikerRUS Jan 10, 2021 •

edited