From e2d8a994134d25be8318f3e6316a144230c41e5e Mon Sep 17 00:00:00 2001 From: Jiaming Yuan Date: Thu, 18 Mar 2021 15:15:50 +0800 Subject: [PATCH] Add document for tests directory. [skip ci] (#6760) --- tests/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index ee7c8fcc6..2dca93048 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1 +1,20 @@ -This folder contains testcases for xgboost. +This folder contains testcases for XGBoost c++ core, Python package and some other CI +facilities. + +# Directories + * ci_build: Test facilities for Jenkins CI and GitHub action. + * cli: Basic test for command line executable `xgboost`. Most of the other command line + specific tests are in Python test `test_cli.py` + * cpp: Tests for C++ core, using Google test framework. + * python: Tests for Python package, demonstrations and CLI. For how to setup the + dependencies for tests, see conda files in `ci_build`. + * python-gpu: Similar to python tests, but for GPU. + * travis: CI facilities for travis. + * distributed: Legacy tests for distributed system. Most of the distributed tests are + in Python tests using `dask` and jvm package using `spark`. + * benchmark: Legacy benchmark code. There are a number of benchmark projects for + XGBoost with much better configurations. + +# Others + * pytest.ini: Describes the `pytest` marker for python tests, some markers are generated + by `conftest.py` file. \ No newline at end of file