Skip to content

Commit fb4e6de

Browse files
Update README.md
1 parent 20b91e5 commit fb4e6de

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Build taco using CMake 2.8.3 or greater:
3636
cd build
3737
cmake -DCMAKE_BUILD_TYPE=Release ..
3838
make -j8
39-
39+
40+
## Building Python API
4041
To build taco with the Python API (pytaco), add `-DPYTHON=ON` to the cmake line above. For example:
4142

4243
cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON=ON ..
@@ -47,10 +48,12 @@ You will then need to add the pytaco module to PYTHONPATH:
4748

4849
pytaco requires NumPy and SciPy to be installed.
4950

51+
## Building for OpenMP
5052
To build taco with support for parallel execution (using OpenMP), add `-DOPENMP=ON` to the cmake line above. For example:
5153

5254
cmake -DCMAKE_BUILD_TYPE=Release -DOPENMP=ON ..
5355

56+
## Building for CUDA
5457
To build taco for NVIDIA CUDA, add `-DCUDA=ON` to the cmake line above. For example:
5558

5659
cmake -DCMAKE_BUILD_TYPE=Release -DCUDA=ON ..
@@ -63,18 +66,26 @@ Please also make sure that you have CUDA installed properly and that the followi
6366

6467
If you do not have CUDA installed, you can still use the taco cli to generate CUDA code with the -cuda flag.
6568

66-
To run the C++ test suite:
69+
## Running tests
70+
To run all tests:
71+
72+
cd <taco-directory>/build
73+
make test
74+
75+
Tests can be run in parallel by setting `CTEST_PARALLEL_LEVEL=<n>` in the environment (which runs `<n>` tests in parallel).
76+
77+
To run the C++ test suite individually:
6778

6879
cd <taco-directory>
6980
./build/bin/taco-test
7081

71-
To run the Python test suite:
82+
To run the Python test suite individually:
7283

7384
cd <taco-directory>
7485
python3 python_bindings/unit_tests.py
7586

7687

77-
# Library Example
88+
# Library example
7889

7990
The following sparse tensor-times-vector multiplication example in C++
8091
shows how to use the taco library.

0 commit comments

Comments
 (0)