Skip to content

Commit 6deb2be

Browse files
authored
[doc] Small cleanup and updates for documentation. (#11532)
- Update broken links. - Merge GPU demos into Python demos. We already use GPU in python demos, no need to have a separate category. - Fix GPU cover type demo.
1 parent 2e5225c commit 6deb2be

8 files changed

Lines changed: 5 additions & 15 deletions

File tree

demo/gpu_acceleration/README.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,6 @@
4545
# Repeat for CPU algorithm
4646
clf = xgb.XGBClassifier(device="cpu", n_estimators=num_round)
4747
start = time.time()
48+
clf.fit(X_train, y_train, eval_set=[(X_test, y_test)])
4849
cpu_res = clf.evals_result()
4950
print("CPU Training Time: %s seconds" % (str(time.time() - start)))

doc/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,15 +250,13 @@ def is_readthedocs_build():
250250
"../demo/guide-python",
251251
"../demo/dask",
252252
"../demo/aft_survival",
253-
"../demo/gpu_acceleration",
254253
"../demo/rmm_plugin",
255254
],
256255
# path to where to save gallery generated output
257256
"gallery_dirs": [
258257
"python/examples",
259258
"python/dask-examples",
260259
"python/survival-examples",
261-
"python/gpu-examples",
262260
"python/rmm-examples",
263261
],
264262
"matplotlib_animations": True,

doc/contrib/release.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ with a new release branch.
4242

4343
R CRAN Package
4444
--------------
45-
Before submitting a release, one should test the package on `R-hub <https://builder.r-hub.io/>`__ and `win-builder <https://win-builder.r-project.org/>`__ first. Please note that the R-hub Windows instance doesn't have the exact same environment as the one hosted on win-builder.
45+
Before submitting a release, one should test the package on `R-hub <https://r-hub.github.io/rhub/>`__ and `win-builder <https://win-builder.r-project.org/>`__ first. Please note that the R-hub Windows instance doesn't have the exact same environment as the one hosted on win-builder.
4646

4747
According to the `CRAN policy <https://cran.r-project.org/web/packages/policies.html>`__:
4848

doc/gpu/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ XGBoost makes use of `GPUTreeShap <https://github.com/rapidsai/gputreeshap>`_ as
4343
shap_values = booster.predict(dtrain, pred_contribs=True)
4444
shap_interaction_values = model.predict(dtrain, pred_interactions=True)
4545
46-
See :ref:`sphx_glr_python_gpu-examples_tree_shap.py` for a worked example.
46+
See :ref:`sphx_glr_python_examples_gpu_tree_shap.py` for a worked example.
4747

4848
Multi-node Multi-GPU Training
4949
=============================

doc/python/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@ Contents
1616
examples/index
1717
dask-examples/index
1818
survival-examples/index
19-
gpu-examples/index
2019
rmm-examples/index

doc/tutorials/ray.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ a few things you need to do:
250250
251251
252252
Ray Tune supports various
253-
`search algorithms and libraries (e.g. BayesOpt, Tree-Parzen estimators) <https://docs.ray.io/en/latest/tune/key-concepts.html#search-algorithms>`_,
254-
`smart schedulers like successive halving <https://docs.ray.io/en/latest/tune/key-concepts.html#trial-schedulers>`_,
253+
`search algorithms and libraries (e.g. BayesOpt, Tree-Parzen estimators) <https://docs.ray.io/en/latest/tune/key-concepts.html#tune-search-algorithms>`_,
254+
`smart schedulers like successive halving <https://docs.ray.io/en/latest/tune/key-concepts.html#tune-schedulers>`_,
255255
and other features. Please refer to the `Ray Tune documentation <http://tune.io>`_
256256
for more information.
257257

0 commit comments

Comments
 (0)