Skip to content

Commit

Permalink
Minor formatting fixes to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hcho3 committed Nov 22, 2024
1 parent a8a8c6a commit d0e209c
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions doc/contrib/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ You can reproduce the same testing environment as the CI pipelines by running Do
Prerequisites
=============
1. Install Docker: https://docs.docker.com/engine/install/ubuntu/
2. Install NVIDIA Docker runtime: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#installing-on-ubuntu-and-debian
2. Install NVIDIA Docker runtime:
https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html.
The runtime lets you access NVIDIA GPUs inside a Docker container.

.. _build_run_docker_locally:
Expand Down Expand Up @@ -73,11 +74,11 @@ the script will use the corresponding entry from ``ci_container.yml``:
.. code-block:: yaml
xgb-ci.gpu:
container_def: gpu
build_args:
CUDA_VERSION_ARG: "12.4.1"
NCCL_VERSION_ARG: "2.23.4-1"
RAPIDS_VERSION_ARG: "24.10"
container_def: gpu
build_args:
CUDA_VERSION_ARG: "12.4.1"
NCCL_VERSION_ARG: "2.23.4-1"
RAPIDS_VERSION_ARG: "24.10"
The ``container_def`` entry indicates where the Dockerfile is located. The container
definition will be fetched from ``ops/docker/dockerfile/Dockerfile.CONTAINER_DEF`` where
Expand Down Expand Up @@ -171,7 +172,7 @@ Optionally, you can specify ``--run-args`` to pass extra arguments to ``docker r
--run-args='--shm-size=4g --privileged' \
-- bash ops/pipeline/test-python-wheel-impl.sh gpu
which is translated to
which translates to

.. code-block:: bash
Expand All @@ -183,13 +184,17 @@ which is translated to
xgb-ci.gpu \
bash ops/pipeline/test-python-wheel-impl.sh gpu
********************************************************************
The Lay of the Land: how CI pipelines are organized in the code base
********************************************************************
*******************************************************************
The Lay of the Land: how CI pipelines are organized in the codebase
*******************************************************************
The XGBoost project stores the configuration for its CI pipelines as part of the codebase.
The git repository therefore stores not only the change history for its source code but also
the change history for the CI pipelines.

=================
File Organization
=================

The CI pipelines are organized into the following directories and files:

* ``.github/workflows/``: Definition of CI pipelines, using the GitHub Actions syntax
Expand All @@ -209,17 +214,17 @@ The CI pipelines are organized into the following directories and files:
* ``ops/docker_build.*``: Wrapper scripts to build and test CI containers. See
:ref:`build_run_docker_locally` for the detailed description.

To inspect a given CI pipeline, open files in the following order:
To inspect a given CI pipeline, inspect files in the following order:

.. plot::
:nofigs:

from graphviz import Source
source = r"""
digraph ci_graph {
graph [fontname = "helvetica"];
node [fontname = "helvetica"];
edge [fontname = "helvetica"];
graph [fontname = "monospace"];
node [fontname = "monospace"];
edge [fontname = "monospace"];
0 [label=<.github/workflows/*.yml>, shape=box];
1 [label=<ops/pipeline/*.sh>, shape=box];
2 [label=<ops/pipeline/*-impl.sh>, shape=box];
Expand Down Expand Up @@ -288,6 +293,6 @@ the S3 bucket whose path matches the pattern.
export COMMAND="download"
export KEY="build-cuda"
# Download all files whose path matches pattern
# python-package/dist/*.whl
# python-package/dist/*.whl
bash ops/pipeline/stash-artifacts.sh \
python-package/dist/*.whl

0 comments on commit d0e209c

Please sign in to comment.