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

[docs] remove pmml redirect, simplify some other docs #6490

Merged
merged 2 commits into from
Jun 18, 2024

Conversation

jameslamb
Copy link
Collaborator

I'm planning to invest heavily in the project's documentation for the next release. I think there are some opportunities to make things simpler and to make it more likely that people are able to find the information they need without turning to Stack Overflow or the issues pages.

This proposes the following:

  • removing the pmml/ folder
  • removes language about preferred style in the Python README
  • other small removals

@@ -156,8 +156,6 @@ Qi Meng, Guolin Ke, Taifeng Wang, Wei Chen, Qiwei Ye, Zhi-Ming Ma, Tie-Yan Liu.

Huan Zhang, Si Si and Cho-Jui Hsieh. "[GPU Acceleration for Large-scale Tree Boosting](https://arxiv.org/abs/1706.08359)". SysML Conference, 2018.

**Note**: If you use LightGBM in your GitHub projects, please add `lightgbm` in the `requirements.txt`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was added back in #2192, around when GitHub first added the Used By metric (#2192 (comment)) that you can view on the repo homepage.

image

I think having it here could be confused as a documentation of how to use the project, and that it should be removed to simplify the instructions a bit.

@@ -11,8 +11,6 @@ Preparation

32-bit Python is not supported. Please install 64-bit version. If you have a strong need to install with 32-bit Python, refer to `Build 32-bit Version with 32-bit Python section <#build-32-bit-version-with-32-bit-python>`__.

`setuptools <https://pypi.org/project/setuptools>`_ is needed.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer true, as of #5837

@jameslamb
Copy link
Collaborator Author

Appveyor CI is failing across several PRs, like this:

  File "C:\Miniconda3-x64\lib\site-packages\conda\exceptions.py", line 1129, in __call__
    return func(*args, **kwargs)
...
  File "C:\Miniconda3-x64\lib\site-packages\urllib3\contrib\socks.py", line 75, in <module>
    class _TYPE_SOCKS_OPTIONS(typing.TypedDict):
AttributeError: module 'typing' has no attribute 'TypedDict'

(build link)

There WAS a new urllib3 release just 8 hours ago: https://pypi.org/project/urllib3/#history

BUT... the Appveyor jobs should be using only Python 3.8

configuration:
- '3.8'

so it's surprising to see Python 3.7 being pulled in:

    python-3.7.12              |h900ac77_100_cpython        18.0 MB  conda-forge
    python_abi-3.7             |          4_cp37m           7 KB  conda-forge

And Python 3.7 being pulled in is what's causing this error. typing.TypedDict was added in Python 3.8: https://peps.python.org/pep-0589/.

I suspect that what's happening here is:

  • the conda that ships with the Appveyor images by default defaults to Python 3.7
  • urllib3 is a dependency of conda itself
  • this is failing at the point of running one of these updates, before ever creating an environment:

conda install "brotlipy>=0.7"
conda update -q -y conda

  • the newest urllib3 version is not compatible with Python 3.7

We should probably update python in the base environment there at the same time we install other updates. I'll push some commits here trying that. Might as well just do it on this small docs PR.

@borchero borchero mentioned this pull request Jun 18, 2024
@jameslamb
Copy link
Collaborator Author

looks like setting updating the Python version at the same time that we update conda worked 🎉

I'll merge this to unblock CI.

@jameslamb jameslamb merged commit 5cd95a5 into master Jun 18, 2024
41 checks passed
@jameslamb jameslamb deleted the docs/remove-pmml branch June 18, 2024 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants