Contribution Guide¶
This is a guide aimed towards contributors of ChainerX which is mostly implemented in C++. It describes how to build the project and how to run the test suite so that you can get started contributing.
Note
Please refer to the Chainer Contribution Guide for the more general contribution guideline that is not specific to ChainerX. E.g. how to download the source code, manage git branches, send pull requests or contribute to Chainer’s Python code base.
Running the test suite¶
The test suite can be built by passing -DCHAINERX_BUILD_TEST=ON
to cmake
.
It is not built by default.
Once built, run the suite with the following command from within the build
directory.
$ cd chainerx_cc/build
$ ctest -V
Coding standards¶
The ChainerX C++ coding standard is mostly based on the Google C++ Style Guide and principles.
Formatting¶
ChainerX is formatted using clang-format.
To fix the formatting in-place, run the following command from chainerx_cc
directory:
$ cd chainerx_cc
$ scripts/run-clang-format.sh --in-place
Lint checking¶
ChainerX uses the cpplint and clang-tidy for lint checking.
Note that clang-tidy requires that you’ve finished running cmake
.
To run cpplint, run scripts/run-cpplint.sh
from chainerx_cc
directory:
$ cd chainerx_cc
$ scripts/run-cpplint.sh
To run clang-tidy, run make clang-tidy
from the build directory:
$ cd chainerx_cc/build
$ make clang-tidy
Thread sanitizer¶
The thread sanitizer can be used to detect thread-related bugs, such as data races.
To enable the thread sanitizer, pass -DCHAINERX_ENABLE_THREAD_SANITIZER=ON
to cmake
.
You can run the test with ctest -V
as usual and you will get warnings if the thread sanitizer detects any issues.
CUDA runtime is known to cause a thread leak error as a false alarm.
In such case, disable the thread leak detection using environment variable TSAN_OPTIONS='report_thread_leaks=0'
.
Python contributions and unit tests¶
To test the Python binding, run the following command at the repository root:
$ pytest
The above command runs all the tests in the repository, including Chainer and ChainerMN. To run only ChainerX tests, specify the test directory:
$ pytest tests/chainerx_tests
Run tests with coverage:
$ pytest --cov --no-cov-on-fail --cov-fail-under=80 tests/chainerx_tests
Run tests without CUDA GPU:
$ pytest -m 'not cuda' tests/chainerx_tests
Test coverage¶
We use gcov to the measure C++ code coverage.
Build the Python package in Debug
mode, and build C++ test suite as:
$ python setup.py build --debug --build-temp ./build --build-lib ./build develop
$ mkdir -p build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Debug -DCHAINERX_BUILD_PYTHON=1 -DCHAINERX_ENABLE_COVERAGE ..
$ make
Run both the Python and the C++ test suite:
$ pytest
$ cd build
$ ctest -V
Then find the .gcda
files:
$ find build -name '*.gcda'
Use the gcov
command to get coverage:
$ gcov ./build/chainerx/CMakeFiles/chainerx.dir/chainerx.gcda
See generated .gcov
files.
You can also generate HTML coverage reports with lcov. After running tests:
$ lcov -c -b chainerx -d build/chainerx/ --no-external -o build/coverage.info
$ genhtml build/coverage.info -o build/coverage
Then open build/coverage/index.html
with any browsers.