ray/release/xgboost_tests/README.rst
Kai Fricke a0f73cf3f7
[xgboost] Update XGBoost release test configs (#13941)
* Update XGBoost release test configs

* Use GPU containers

* Fix elastic check

* Use spot instances for GPU

* Add debugging output

* Fix success check, failure checking, outputs, sync behavior

* Update release checklist, rename mounts
2021-02-17 23:00:49 +01:00

24 lines
832 B
ReStructuredText

XGBoost on Ray tests
====================
This directory contains various XGBoost on Ray release tests.
You should run these tests with the `releaser <https://github.com/ray-project/releaser>`_ tool.
Overview
--------
There are four kinds of tests:
1. ``distributed_api_test`` - checks general API functionality and should finish very quickly (< 1 minute)
2. ``train_*`` - checks single trial training on different setups.
3. ``tune_*`` - checks multi trial training via Ray Tune.
4. ``ft_*`` - checks fault tolerance.
Generally the releaser tool will run all tests in parallel, but if you do
it sequentially, be sure to do it in the order above. If ``train_*`` fails,
``tune_*`` will fail, too.
Acceptance criteria
-------------------
These tests are considered passing when they throw no error at the end of
the output log.