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.

Sign up for GitHub

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] fix broken links #6161

Merged
merged 9 commits into from
Nov 6, 2023
Merged

[docs] fix broken links #6161

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ddbe313
[docs] fix broken links
jameslamb Oct 30, 2023
2d83188
fix MSLR link
jameslamb Oct 30, 2023
5a1df08
trailing slash
jameslamb Oct 30, 2023
3078d0c
fix table again
jameslamb Oct 30, 2023
f4ded17
https for SWIG
jameslamb Oct 30, 2023
249944f
accept http-redirect warnings
jameslamb Oct 30, 2023
8ff248f
Merge branch 'master' into docs/fix-links
jameslamb Nov 6, 2023
de37fb0
redirected not redirect
jameslamb Nov 6, 2023
f010cb6
Merge branch 'master' into docs/fix-links
jameslamb Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.linkcheckerrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ignore=
http.*amd.com/.*
https.*dl.acm.org/doi/.*
https.*tandfonline.com/.*
ignorewarnings=http-robots-denied,https-certificate-error
ignorewarnings=http-redirected,http-robots-denied,https-certificate-error
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It looks like as of the most recent release of linkchecker (v10.3.0), HTTP redirects now throw a warning.

From this PR: linkchecker/linkchecker#750

That's leading to this job failing even with 0 errors. (example build)

That's it. 1087 links in 1115 URLs checked. 28 warnings found. 0 errors found.
Error: Process completed with exit code 255.

In this PR, I'm proposing not considering the presence of such warnings to cause the job to fail. It'll take some time to go through the 28 warnings and fix them, and I'd prefer to get this job working again as soon as possible to catch truly broken links.

If reviewers agree, I'll put up a new issue documenting the desire to remove this filter and enforce no-redirects in this job again.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I triggered check-links on this branch before adding this change to the config: https://github.com/microsoft/LightGBM/actions/runs/6766475624/job/18387635055

And despite there being 0 errors in the result ...

That's it. 1088 links in 1116 URLs checked. 28 warnings found. 0 errors found.
Stopped checking at 2023-11-06 05:04:50+000 (6 minutes, 20 seconds)

... it's still failing

Error: Process completed with exit code 255.

I suspect that maybe linkchecker returns a non-0 exit code if any warnings are found. The last successful run in this project was https://github.com/microsoft/LightGBM/actions/runs/6219774651/job/16878494852, and that ended with:

That's it. 1089 links in 1125 URLs checked. 0 warnings found. 0 errors found.

checkextern=1

[output]
Expand Down
2 changes: 1 addition & 1 deletion docs/Experiments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ We used 5 datasets to conduct our comparison experiments. Details of data are li
+-----------+-----------------------+------------------------------------------------------------------------+-------------+----------+----------------------------------------------+
| Yahoo LTR | Learning to rank | `link <https://webscope.sandbox.yahoo.com/catalog.php?datatype=c>`__ | 473,134 | 700 | set1.train as train, set1.test as test |
+-----------+-----------------------+------------------------------------------------------------------------+-------------+----------+----------------------------------------------+
| MS LTR | Learning to rank | `link <http://research.microsoft.com/en-us/projects/mslr/>`__ | 2,270,296 | 137 | {S1,S2,S3} as train set, {S5} as test set |
| MS LTR | Learning to rank | `link <https://www.microsoft.com/en-us/research/project/mslr/>`__ | 2,270,296 | 137 | {S1,S2,S3} as train set, {S5} as test set |
+-----------+-----------------------+------------------------------------------------------------------------+-------------+----------+----------------------------------------------+
| Expo | Binary classification | `link <http://stat-computing.org/dataexpo/2009/>`__ | 11,000,000 | 700 | last 1,000,000 samples were used as test set |
+-----------+-----------------------+------------------------------------------------------------------------+-------------+----------+----------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Python-package
This error should be solved in latest version.
If you still meet this error, try to remove ``lightgbm.egg-info`` folder in your Python-package and reinstall,
or check `this thread on stackoverflow <http://stackoverflow.com/questions/18085571/pip-install-error-setup-script-specifies-an-absolute-path>`__.
or check `this thread on stackoverflow <https://stackoverflow.com/questions/18085571/pip-install-error-setup-script-specifies-an-absolute-path>`__.

2. Error messages: ``Cannot ... before construct dataset``.
-----------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/GPU-Performance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. `GPU Acceleration for Large-scale Tree Boos

.. _link1: https://archive.ics.uci.edu/ml/datasets/HIGGS

.. _link2: http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/binary.html
.. _link2: https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/binary.html

.. _link3: https://www.kaggle.com/c/bosch-production-line-performance/data

Expand Down
2 changes: 1 addition & 1 deletion docs/Installation-Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,7 @@ gcc

.. _Boost Binaries: https://sourceforge.net/projects/boost/files/boost-binaries/

.. _SWIG: http://www.swig.org/download.html
.. _SWIG: https://www.swig.org/download.html

.. _this detailed guide: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html

Expand Down
6 changes: 0 additions & 6 deletions docs/Parallel-Learning-Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,6 @@ From the point forward, you can use any of the following methods to save the Boo
Kubeflow
^^^^^^^^

`Kubeflow Fairing`_ supports LightGBM distributed training. `These examples`_ show how to get started with LightGBM and Kubeflow Fairing in a hybrid cloud environment.

Kubeflow users can also use the `Kubeflow XGBoost Operator`_ for machine learning workflows with LightGBM. You can see `this example`_ for more details.

Kubeflow integrations for LightGBM are not maintained by LightGBM's maintainers.
Expand Down Expand Up @@ -528,10 +526,6 @@ See `the mars documentation`_ for usage examples.

.. _these Dask examples: https://github.com/microsoft/lightgbm/tree/master/examples/python-guide/dask

.. _Kubeflow Fairing: https://www.kubeflow.org/docs/components/fairing/fairing-overview

.. _These examples: https://github.com/kubeflow/fairing/tree/master/examples/lightgbm

.. _Kubeflow XGBoost Operator: https://github.com/kubeflow/xgboost-operator

.. _this example: https://github.com/kubeflow/xgboost-operator/tree/master/config/samples/lightgbm-dist
Expand Down
2 changes: 0 additions & 2 deletions docs/gcc-Tips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ You can find more details on the experimentation below:

- `Laurae's Benchmark Master Data (Interactive) <https://public.tableau.com/views/gbt_benchmarks/Master-Data?:showVizHome=no>`__

- `Kaggle Paris Meetup #12 Slides <https://drive.google.com/file/d/0B6qJBmoIxFe0ZHNCOXdoRWMxUm8/view>`__

The image below compares the runtime for training with different compiler options to a baseline using LightGBM compiled with ``-O2 --mtune=core2``. All three options are faster than that baseline. The best performance was achieved with ``-O3 --mtune=native``.

.. image:: ./_static/images/gcc-comparison-2.png
Expand Down