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

Add document for tests directory. [skip ci] #6760

Merged
merged 1 commit into from
Mar 18, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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.