Skip to content

Commit

Permalink
DOC Update readme for new test executables
Browse files Browse the repository at this point in the history
  • Loading branch information
dantegd committed May 14, 2019
1 parent 25bbf9b commit 2dcb126
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
14 changes: 7 additions & 7 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,16 @@ $ make install
To run tests (optional):

```bash
$ ./ml_test # Single GPU algorithm tests
$ ./ml_mg_test # Multi GPU algorithm tests
$ ./prims_test # ML Primitive function tests
$ ./test/ml # Single GPU algorithm tests
$ ./test/ml_mg # Multi GPU algorithm tests
$ ./test/prims # ML Primitive function tests
```

If you want a list of the available tests:
```bash
$ ./ml_test --gtest_list_tests # Single GPU algorithm tests
$ ./ml_mg_test --gtest_list_tests # Multi GPU algorithm tests
$ ./prims_test --gtest_list_tests # ML Primitive function tests
$ ./test/ml --gtest_list_tests # Single GPU algorithm tests
$ ./test/ml_mg --gtest_list_tests # Multi GPU algorithm tests
$ ./test/prims --gtest_list_tests # ML Primitive function tests
```

4. Build the `cuml` python package:
Expand Down Expand Up @@ -116,7 +116,7 @@ cuML's cmake has the following configurable flags available:
| BUILD_CUML_CPP_LIBRARY | [ON, OFF] | ON | Enable/disable building libcuml++ shared library. Setting this variable to `OFF` sets the variables BUILD_CUML_TESTS, BUILD_CUML_MG_TESTS and BUILD_CUML_EXAMPLES to `OFF` |
| BUILD_CUML_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `ml_test`. |
| BUILD_CUML_MG_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `ml_mg_test`. |
| BUILD_PRIM_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `prims_test`. |
| BUILD_PRIMS_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `prims_test`. |
| BUILD_CUML_EXAMPLES | [ON, OFF] | ON | Enable/disable building cuML C++ API usage examples. |
| CMAKE_CXX11_ABI | [ON, OFF] | ON | Enable/disable the GLIBCXX11 ABI |
| DISABLE_OPENMP | [ON, OFF] | OFF | Set to `ON` to disable OpenMP |
Expand Down
8 changes: 4 additions & 4 deletions cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Current cmake offers the following configuration options:
| BUILD_CUML_CPP_LIBRARY | [ON, OFF] | ON | Enable/disable building libcuml++ shared library. Setting this variable to `OFF` sets the variables BUILD_CUML_TESTS, BUILD_CUML_MG_TESTS and BUILD_CUML_EXAMPLES to `OFF` |
| BUILD_CUML_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `ml_test`. |
| BUILD_CUML_MG_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `ml_mg_test`. |
| BUILD_PRIM_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `prims_test`. |
| BUILD_PRIMS_TESTS | [ON, OFF] | ON | Enable/disable building cuML algorithm test executable `prims_test`. |
| BUILD_CUML_EXAMPLES | [ON, OFF] | ON | Enable/disable building cuML C++ API usage examples. |
| CMAKE_CXX11_ABI | [ON, OFF] | ON | Enable/disable the GLIBCXX11 ABI |
| DISABLE_OPENMP | [ON, OFF] | OFF | Set to `ON` to disable OpenMP |
Expand All @@ -45,9 +45,9 @@ After running CMake in a `build` directory, if the `BUILD_*` options were not tu
```bash
$ make -j # Build libcuml++ and all tests
$ make -j cuml++ # Build libcuml++
$ make -j ml_test # Build ml_test algorithm tests binary
$ make -j ml_mg_test # Build ml_mg_test multi GPU algorithms tests binary
$ make -j prims_test # Build prims_test ML primitive unit tests binary
$ make -j ml # Build ml_test algorithm tests binary
$ make -j ml_mg # Build ml_mg_test multi GPU algorithms tests binary
$ make -j prims # Build prims_test ML primitive unit tests binary
```

### Third Party Modules
Expand Down

0 comments on commit 2dcb126

Please sign in to comment.