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] reduce redirects in docs links #6181

Merged
merged 8 commits into from
Nov 14, 2023
Merged

[docs] reduce redirects in docs links #6181

merged 8 commits into from
Nov 14, 2023

Conversation

jameslamb
Copy link
Collaborator

@jameslamb jameslamb commented Nov 8, 2023

Follow-up to #6161.

Fixes some (but not all) of the warnings linkchecker raises about redirects in links from documentation. Most of these are harmless, just pages moving around within the same top-level domain.

But one is a site that used to host a dataset and now hosts ... something about video games!

warnings addressed by this PR (click me)
URL        `https://www.mcs.anl.gov/~thakur/papers/ijhpca-coll.pdf'
Name       `Optimization of collective communication operations in MPICH'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Features.html, line 327, col 63
Real URL   https://web.cels.anl.gov/~thakur/papers/ijhpca-coll.pdf
Check time 1.343 seconds
Size       1.05MB
Warning    [http-redirected] Redirected to
           `https://web.cels.anl.gov/~thakur/papers/ijhpca-coll.pdf'
           status: 301 Moved Permanently.

URL        `http://research.microsoft.com/en-us/projects/mslr/'
Name       `link5'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/GPU-Performance.html, line 193, col 8
Real URL   https://www.microsoft.com/en-us/research/project/mslr/?from=https://research.microsoft.com/en-us/projects/mslr/&type=exact
Check time 2.741 seconds
Size       29.67KB
Warning    [http-redirected] Redirected to
           `https://www.microsoft.com/en-us/research/redirect/?ref=https://research.microsoft.com/en-us/projects/mslr/'
           status: 301 Moved Permanently.
           [http-redirected] Redirected to
           `https://www.microsoft.com/en-us/research/project/mslr/?from=https://research.microsoft.com/en-us/projects/mslr/&type=exact'
           status: 301 Moved Permanently.

URL        `https://archive.ics.uci.edu/ml/datasets/HIGGS'
Name       `link'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Experiments.html, line 145, col 8
Real URL   https://archive.ics.uci.edu/dataset/280/higgs
Check time 1.101 seconds
Size       79.80KB
Warning    [http-redirected] Redirected to
           `https://archive.ics.uci.edu/dataset/280/higgs'
           status: 302 Found.

URL        `http://stat-computing.org/dataexpo/2009/'
Name       `link'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Experiments.html, line 166, col 8
Real URL   https://gamingcy.com
Check time 1.227 seconds
Warning    [http-redirected] Redirected to `https://gamingcy.com'
           status: 301 Moved Permanently.

URL        `https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi-release-notes'
Name       `MS MPI'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Installation-Guide.html, line 537, col 28
Real URL   https://learn.microsoft.com/en-us/message-passing-interface/microsoft-mpi-release-notes
Check time 0.165 seconds
Size       15.43KB
Warning    [http-redirected] Redirected to
           `https://learn.microsoft.com/en-us/message-passing-interface/microsoft-mpi-release-notes'
           status: 301 Moved Permanently.

URL        `https://github.com/microsoft/lightgbm/tree/master/examples/python-guide/dask/prediction.py'
Name       `the Dask prediction example'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parallel-Learning-Guide.html, line 355, col 8
Real URL   https://github.com/microsoft/LightGBM/blob/master/examples/python-guide/dask/prediction.py
Check time 0.270 seconds
Size       3KB
Warning    [http-redirected] Redirected to
           `https://github.com/microsoft/LightGBM/blob/master/examples/python-guide/dask/prediction.py'
           status: 301 Moved Permanently.

URL        `https://ray.io/'
Name       `Ray'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parallel-Learning-Guide.html, line 536, col 4
Real URL   https://www.ray.io/
Check time 0.269 seconds
Warning    [http-redirected] Redirected to `https://www.ray.io/'
           status: 302 Moved Temporarily.

URL        `https://papers.nips.cc/paper/2971-learning-to-rank-with-nonsmooth-cost-functions.pdf'
Name       `lambdarank'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 205, col 95
Real URL   https://proceedings.neurips.cc/paper_files/paper/2006/file/af44c4c56f385c43f2529f9b1b018f6a-Paper.pdf
Check time 0.814 seconds
Size       142.18KB
Warning    [http-redirected] Redirected to
           `https://proceedings.neurips.cc/paper_files/paper/2006/file/af44c4c56f385c43f2529f9b1b018f6a-Paper.pdf'
           status: 302 Found.


URL        `https://hal.archives-ouvertes.fr/hal-02862802/document'
Name       `more advanced method'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 585, col 99
Real URL   https://hal.science/hal-02862802/document
Check time 2.390 seconds
Size       6.70MB
Warning    [http-redirected] Redirected to
           `https://hal.science/hal-02862802/document' status:
           301 Moved Permanently.

URL        `https://github.com/microsoft/LightGBM/tree/master/examples/binary_classification/forced_splits.json'
Name       `this file'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 610, col 12
Real URL   https://github.com/microsoft/LightGBM/blob/master/examples/binary_classification/forced_splits.json
Check time 0.665 seconds
Size       2KB
Warning    [http-redirected] Redirected to
           `https://github.com/microsoft/LightGBM/blob/master/examples/binary_classification/forced_splits.json'
           status: 301 Moved Permanently.

URL        `https://papers.nips.cc/paper/6907-lightgbm-a-highly-efficient-gradient-boosting-decision-tree'
Name       `LightGBM: A Highly Efficient Gradient Boosting Decision Tree'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 798, col 168
Real URL   https://papers.nips.cc/paper_files/paper/2017/hash/6449f44a102fde848669bdd9eb6b76fa-Abstract.html
Check time 0.498 seconds
Warning    [http-redirected] Redirected to
           `https://papers.nips.cc/paper_files/paper/2017/hash/6449f44a102fde848669bdd9eb6b76fa-Abstract.html'
           status: 302 Found.

URL        `https://github.com/microsoft/LightGBM/tree/master/examples/regression/forced_bins.json'
Name       `this file'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 896, col 12
Real URL   https://github.com/microsoft/LightGBM/blob/master/examples/regression/forced_bins.json
Check time 0.220 seconds
Size       2KB
Warning    [http-redirected] Redirected to
           `https://github.com/microsoft/LightGBM/blob/master/examples/regression/forced_bins.json'
           status: 301 Moved Permanently.

URL        `https://github.com/slundberg/shap'
Name       `shap package'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parameters.html, line 957, col 160
Real URL   https://github.com/shap/shap
Check time 2.324 seconds
Warning    [http-redirected] Redirected to
           `https://github.com/shap/shap' status: 301 Moved
           Permanently.

How I tested this

Triggered check-links on this branch, with [http-redirected] warnings from linkchecker allowed, and saw the number of warnings go down from 32 to 14: https://github.com/microsoft/LightGBM/actions/runs/6793814320/job/18469251065

@@ -27,7 +27,7 @@ We used 5 datasets to conduct our comparison experiments. Details of data are li
+-----------+-----------------------+------------------------------------------------------------------------+-------------+----------+----------------------------------------------+
| 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 |
| Expo | Binary classification | `link <https://community.amstat.org/jointscsg-section/dataexpo/dataexpo2009>`__ | 11,000,000 | 700 | last 1,000,000 samples were used as test set |
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That stat-computing.org link now redirects to....

image

@jameslamb jameslamb changed the title WIP: [docs] reduce redirects in docs links [docs] reduce redirects in docs links Nov 8, 2023
@jameslamb jameslamb marked this pull request as ready for review November 8, 2023 04:58
@jameslamb
Copy link
Collaborator Author

The check-docs task here was failing (build link) at this step:

LightGBM/.ci/test.sh

Lines 116 to 118 in 694e41e

python $BUILD_DIRECTORY/helpers/parameter_generator.py || exit -1
diff $BUILD_DIRECTORY/docs/Parameters-backup.rst $BUILD_DIRECTORY/docs/Parameters.rst || exit -1
diff $BUILD_DIRECTORY/src/io/config_auto-backup.cpp $BUILD_DIRECTORY/src/io/config_auto.cpp || exit -1

I just pushed a commit that fixed that: 7403cd1

Generated by making changes in include/config.h then running

python helpers/parameter_generator.py

@jameslamb jameslamb merged commit e63e54a into master Nov 14, 2023
39 checks passed
@jameslamb jameslamb deleted the docs/more-links branch November 14, 2023 02:26
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants