[Code/Python] Python reg-tests:

- Minor fixes in tests structure
- Add test data generation and config
- Add test run step in CI
- Minor readme update

Author: EgorOrachyov

.github/workflows/ubuntu.yml

@@ -28,6 +28,9 @@ jobs:
       - uses: actions/checkout@v2
         with:
           submodules: true
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
 
       - name: Install CUDA
         env:
@@ -60,4 +63,13 @@ jobs:
       - name: Run unit-tests (sequential backend)
         working-directory: ${{ env.build_dir }}
         run: bash scripts/tests_run_fallback.sh
-        shell: bash
+        shell: bash
+
+      - name: Run regression-tests (sequential backend)
+        working-directory: ${{ env.build_dir }}
+        run: |
+          cd python
+          export PYTHONPATH="`pwd`:$PYTHONPATH"
+          cd tests
+          python3 -m unittest discover -v
+        shell: bash

README.md

@@ -40,13 +40,13 @@ prototyping algorithms on a local computer for later running on a powerful serve
 - [X] Matrix cached filling
 - [X] Sequential fallback backend for CPU
 - [X] Device capabilities query
-- [ ] IO matrix loading from mtx file
-- [ ] IO matrix saving into mtx file
+- [X] IO matrix loading from mtx file
+- [X] IO matrix saving into mtx file
 - [ ] IO matrix saving into gviz format
 - [X] IO user-defined file logging
 - [X] Wrapper for Python API
 - [X] Wrapper syntax sugar
-- [ ] Tests for Python wrapper
+- [X] Tests for Python wrapper
 - [X] Pip package
 - [ ] Code examples
 - [ ] User guide
@@ -162,12 +162,22 @@ By default, the following cmake options will be automatically enabled:
 
 ### Python Wrapper
 
-After the build process, the shared library object `libcubool.so` is placed
-inside the build directory. Export into the environment or add into bash
-profile the variable `CUBOOL_PATH=/path/to/the/libcubool.so` with appropriate
-path to your setup. Then you will be able to use `pycubool` python wrapper,
-which uses this variable in order to located library object.
+**Export** env variable `PYTHONPATH="/build_dir_path/python/:$PYTHONPATH"` if
+you want to use `pycubool` without installation into default python packages dir.
+This variable will help python find package if you import it as `import pycubool` in your python scripts.
 
+**To run regression tests** within your build directory, open folder `/build_dir_path/python` and
+run the following command:
+
+```shell script
+$ export PYTHONPATH="`pwd`:$PYTHONPATH"
+$ cd tests
+$ python3 -m unittest discover -v
+```
+
+**Note:** after the build process, the shared library object `libcubool.so` will be placed
+inside the build directory in the folder with python wrapper `python/pycubool/`. 
+So, the wrapper will be able to automatically locate required lib file.
 
 ## Usage 
 

cubool/tests/test_matrix_mxm.cpp

@@ -58,6 +58,39 @@ void testMatrixMultiplyAdd(cuBool_Index m, cuBool_Index t, cuBool_Index n, float
     ASSERT_EQ(cuBool_Matrix_Free(r), CUBOOL_STATUS_SUCCESS);
 }
 
+void testMatrixMultiply(cuBool_Index m, cuBool_Index t, cuBool_Index n, float density, cuBool_Hints flags) {
+    cuBool_Matrix a, b, r;
+
+    // Generate test data with specified density
+    testing::Matrix ta = testing::Matrix::generateSparse(m, t, density);
+    testing::Matrix tb = testing::Matrix::generateSparse(t, n, density);
+    testing::Matrix tr = testing::Matrix::empty(m, n);
+
+    // Allocate input matrices and resize to fill with input data
+    ASSERT_EQ(cuBool_Matrix_New(&a, m, t), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_New(&b, t, n), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_New(&r, m, n), CUBOOL_STATUS_SUCCESS);
+
+    // Transfer input data into input matrices
+    ASSERT_EQ(cuBool_Matrix_Build(a, ta.rowsIndex.data(), ta.colsIndex.data(), ta.nvals, CUBOOL_HINT_VALUES_SORTED & CUBOOL_HINT_NO_DUPLICATES), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Build(b, tb.rowsIndex.data(), tb.colsIndex.data(), tb.nvals, CUBOOL_HINT_VALUES_SORTED & CUBOOL_HINT_NO_DUPLICATES), CUBOOL_STATUS_SUCCESS);
+
+    // Evaluate naive r += a x b on the cpu to compare results
+    testing::MatrixMultiplyFunctor functor;
+    tr = std::move(functor(ta, tb, tr, false));
+
+    // Evaluate r += a x b
+    ASSERT_EQ(cuBool_MxM(r, a, b, flags), CUBOOL_STATUS_SUCCESS);
+
+    // Compare results
+    ASSERT_EQ(tr.areEqual(r), true);
+
+    // Deallocate matrices
+    ASSERT_EQ(cuBool_Matrix_Free(a), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Free(b), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Free(r), CUBOOL_STATUS_SUCCESS);
+}
+
 void testRun(cuBool_Index m, cuBool_Index t, cuBool_Index n, cuBool_Hints setup) {
     // Setup library
     ASSERT_EQ(cuBool_Initialize(setup), CUBOOL_STATUS_SUCCESS);
@@ -66,37 +99,41 @@ void testRun(cuBool_Index m, cuBool_Index t, cuBool_Index n, cuBool_Hints setup)
         testMatrixMultiplyAdd(m, t, n, 0.1f + (0.05f) * ((float) i), CUBOOL_HINT_NO);
     }
 
+    for (size_t i = 0; i < 5; i++) {
+        testMatrixMultiply(m, t, n, 0.1f + (0.05f) * ((float) i), CUBOOL_HINT_NO);
+    }
+
     // Finalize library
     ASSERT_EQ(cuBool_Finalize(), CUBOOL_STATUS_SUCCESS);
 }
 
-TEST(cuBool_Matrix, MultiplyAddSmall) {
+TEST(cuBool_Matrix, MultiplySmall) {
     cuBool_Index m = 60, t = 100, n = 80;
     testRun(m, t, n, CUBOOL_HINT_NO);
 }
 
-TEST(cuBool_Matrix, MultiplyAddMedium) {
+TEST(cuBool_Matrix, MultiplyMedium) {
     cuBool_Index m = 500, t = 1000, n = 800;
     testRun(m, t, n, CUBOOL_HINT_NO);
 }
 
-TEST(cuBool_Matrix, MultiplyAddLarge) {
+TEST(cuBool_Matrix, MultiplyLarge) {
     cuBool_Index m = 1000, t = 2000, n = 500;
     testRun(m, t, n, CUBOOL_HINT_NO);
 }
 
-TEST(cuBool_Matrix, MultiplyAddSmallFallback) {
+TEST(cuBool_Matrix, MultiplySmallFallback) {
     cuBool_Index m = 60, t = 100, n = 80;
     testRun(m, t, n, CUBOOL_HINT_CPU_BACKEND);
 }
 
-TEST(cuBool_Matrix, MultiplyAddMediumFallback) {
+TEST(cuBool_Matrix, MultiplyMediumFallback) {
     cuBool_Index m = 500, t = 1000, n = 800;
     testRun(m, t, n, CUBOOL_HINT_CPU_BACKEND);
 
 }
 
-TEST(cuBool_Matrix, MultiplyAddLargeFallback) {
+TEST(cuBool_Matrix, MultiplyLargeFallback) {
     cuBool_Index m = 1000, t = 2000, n = 500;
     testRun(m, t, n, CUBOOL_HINT_CPU_BACKEND);
 }

cubool/utils/testing/matrix.hpp

@@ -218,6 +218,13 @@ namespace testing {
             return std::move(matrix);
         }
 
+        static Matrix empty(size_t nrows, size_t ncols) {
+            Matrix out;
+            out.nrows = nrows;
+            out.ncols = ncols;
+            return std::move(out);
+        }
+
     };
 
 }