Skip to content

Commit

Permalink
Add document for tests directory. [skip ci] (#6760)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivialfis committed Mar 18, 2021
1 parent 4e00737 commit e2d8a99
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit e2d8a99

Please sign in to comment.