Merge -input_matrix flag

This allows passing a matrix filename as benchmark input directly, without JSON format. Related PR: #1387
ginkgo-project · Aug 17, 2023 · dc5a120 · dc5a120
2 parents 437e3ba + b37b233
commit dc5a120
Show file tree

Hide file tree

Showing 32 changed files with 624 additions and 36 deletions.
diff --git a/benchmark/conversions/conversions.cpp b/benchmark/conversions/conversions.cpp
@@ -44,7 +44,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/utils/formats.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/spmv_validation.hpp"
 #include "benchmark/utils/timer.hpp"
@@ -115,7 +115,7 @@ int main(int argc, char* argv[])
     std::string header =
         "A benchmark for measuring performance of Ginkgo's conversions.\n";
     std::string format_str = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format_str);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format_str);
 
     std::string extra_information =
         std::string() + "The formats are " + FLAGS_formats + "\n";

diff --git a/benchmark/matrix_statistics/matrix_statistics.cpp b/benchmark/matrix_statistics/matrix_statistics.cpp
@@ -38,7 +38,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <iostream>
 
 
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/spmv_validation.hpp"
 #include "benchmark/utils/types.hpp"
@@ -173,7 +173,7 @@ int main(int argc, char* argv[])
         "A utility that collects additional statistical properties of the "
         "matrix.\n";
     std::string format = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format);
 
     std::clog << gko::version_info::get() << std::endl;
 

diff --git a/benchmark/preconditioner/preconditioner.cpp b/benchmark/preconditioner/preconditioner.cpp
@@ -41,7 +41,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/utils/formats.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/loggers.hpp"
 #include "benchmark/utils/preconditioners.hpp"
@@ -262,7 +262,7 @@ int main(int argc, char* argv[])
     std::string header =
         "A benchmark for measuring preconditioner performance.\n";
     std::string format = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format);
 
     std::string extra_information =
         "Running with preconditioners: " + FLAGS_preconditioners + "\n";

diff --git a/benchmark/solver/distributed/solver.cpp b/benchmark/solver/distributed/solver.cpp
@@ -40,7 +40,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/solver/solver_common.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 
 
@@ -98,7 +98,9 @@ int main(int argc, char* argv[])
   "<local_format>-<non_local_format>", where both "local_format" and
   "non_local_format" can be any of the recognized spmv formats.
 )";
-    initialize_argument_parsing(&argc, &argv, header, format);
+    std::string additional_json = R"(,"optimal":{"spmv":"csr-csr"})";
+    initialize_argument_parsing_matrix(&argc, &argv, header, format,
+                                       additional_json);
 
     const auto comm = gko::experimental::mpi::communicator(MPI_COMM_WORLD);
     const auto rank = comm.rank();

diff --git a/benchmark/solver/solver.cpp b/benchmark/solver/solver.cpp
@@ -47,7 +47,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/solver/solver_common.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 
 
@@ -61,7 +61,9 @@ int main(int argc, char* argv[])
     std::string format = example_config + R"(
   "optimal":"spmv" can be one of the recognized spmv formats
 )";
-    initialize_argument_parsing(&argc, &argv, header, format);
+    std::string additional_json = R"(,"optimal":{"spmv":"csr"})";
+    initialize_argument_parsing_matrix(&argc, &argv, header, format,
+                                       additional_json);
 
     std::stringstream ss_rel_res_goal;
     ss_rel_res_goal << std::scientific << FLAGS_rel_res_goal;

diff --git a/benchmark/sparse_blas/sparse_blas.cpp b/benchmark/sparse_blas/sparse_blas.cpp
@@ -45,7 +45,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/sparse_blas/operations.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/spmv_validation.hpp"
 #include "benchmark/utils/types.hpp"
@@ -161,7 +161,7 @@ int main(int argc, char* argv[])
         "A benchmark for measuring performance of Ginkgo's sparse BLAS "
         "operations.\n";
     std::string format = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format);
 
     auto exec = executor_factory.at(FLAGS_executor)(FLAGS_gpu_timer);
 

diff --git a/benchmark/spmv/distributed/spmv.cpp b/benchmark/spmv/distributed/spmv.cpp
@@ -44,7 +44,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 #include "benchmark/spmv/spmv_common.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/timer.hpp"
 #include "benchmark/utils/types.hpp"
@@ -102,7 +102,7 @@ int main(int argc, char* argv[])
     std::string header =
         "A benchmark for measuring performance of Ginkgo's spmv.\n";
     std::string format = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format);
 
     if (rank == 0) {
         std::string extra_information = "The formats are [" +

diff --git a/benchmark/spmv/spmv.cpp b/benchmark/spmv/spmv.cpp
@@ -39,7 +39,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 #include "benchmark/spmv/spmv_common.hpp"
 #include "benchmark/utils/formats.hpp"
-#include "benchmark/utils/general.hpp"
+#include "benchmark/utils/general_matrix.hpp"
 #include "benchmark/utils/generator.hpp"
 #include "benchmark/utils/spmv_validation.hpp"
 
@@ -64,7 +64,7 @@ int main(int argc, char* argv[])
     std::string header =
         "A benchmark for measuring performance of Ginkgo's spmv.\n";
     std::string format = example_config;
-    initialize_argument_parsing(&argc, &argv, header, format);
+    initialize_argument_parsing_matrix(&argc, &argv, header, format);
 
     std::string extra_information = "The formats are " + FLAGS_formats +
                                     "\nThe number of right hand sides is " +

diff --git a/benchmark/test/conversion.py b/benchmark/test/conversion.py
@@ -29,6 +29,18 @@
     expected_stderr="conversion.simple.stderr",
 )
 
+# input matrixfile
+test_framework.compare_output(
+    [
+        "-input_matrix",
+        str(test_framework.matrixpath),
+        "-formats",
+        "coo,csr",
+    ],
+    expected_stdout="conversion.matrix.stdout",
+    expected_stderr="conversion.matrix.stderr",
+)
+
 # check that all conversions work
 test_framework.compare_output(
     [

diff --git a/benchmark/test/matrix_statistics.py b/benchmark/test/matrix_statistics.py
@@ -23,3 +23,10 @@
     expected_stdout="matrix_statistics.simple.stdout",
     expected_stderr="matrix_statistics.simple.stderr",
 )
+
+# input matrix file
+test_framework.compare_output(
+    ["-input_matrix", str(test_framework.matrixpath)],
+    expected_stdout="matrix_statistics.matrix.stdout",
+    expected_stderr="matrix_statistics.matrix.stderr",
+)
diff --git a/benchmark/test/preconditioner.py b/benchmark/test/preconditioner.py
@@ -24,6 +24,13 @@
     expected_stderr="preconditioner.simple.stderr",
 )
 
+# input matrix file
+test_framework.compare_output(
+    ["-input_matrix", str(test_framework.matrixpath)],
+    expected_stdout="preconditioner.matrix.stdout",
+    expected_stderr="preconditioner.matrix.stderr",
+)
+
 # profiler annotations
 test_framework.compare_output(
     [

diff --git a/benchmark/test/reference/conversion.matrix.stderr b/benchmark/test/reference/conversion.matrix.stderr
@@ -0,0 +1,46 @@
+This is Ginkgo 1.7.0 (develop)
+    running with core module 1.7.0 (develop)
+Running on reference(0)
+Running with 2 warm iterations and 10 running iterations
+The random seed for right hand sides is 42
+The formats are coo,csr
+Benchmarking conversions. 
+Running test case
+{
+    "filename": "",
+    "conversions": {}
+}
+Matrix is of size (36, 36)
+Current state:
+[
+    {
+        "filename": "",
+        "conversions": {
+            "coo-csr": {
+                "time": 1.0,
+                "repetitions": 10,
+                "completed": true
+            }
+        },
+        "size": 36
+    }
+]
+Current state:
+[
+    {
+        "filename": "",
+        "conversions": {
+            "coo-csr": {
+                "time": 1.0,
+                "repetitions": 10,
+                "completed": true
+            },
+            "csr-coo": {
+                "time": 1.0,
+                "repetitions": 10,
+                "completed": true
+            }
+        },
+        "size": 36
+    }
+]
diff --git a/benchmark/test/reference/conversion.matrix.stdout b/benchmark/test/reference/conversion.matrix.stdout
@@ -0,0 +1,19 @@
+
+[
+    {
+        "filename": "",
+        "conversions": {
+            "coo-csr": {
+                "time": 1.0,
+                "repetitions": 10,
+                "completed": true
+            },
+            "csr-coo": {
+                "time": 1.0,
+                "repetitions": 10,
+                "completed": true
+            }
+        },
+        "size": 36
+    }
+]
diff --git a/benchmark/test/reference/distributed_solver.matrix.stderr b/benchmark/test/reference/distributed_solver.matrix.stderr
@@ -0,0 +1,17 @@
+This is Ginkgo 1.7.0 (develop)
+    running with core module 1.7.0 (develop)
+Running on reference(0)
+Running with 2 warm iterations and 1 running iterations
+The random seed for right hand sides is 42
+Running cg with 1000 iterations and residual goal of 1.000000e-06
+The number of right hand sides is 1
+Running test case
+{
+    "filename": "",
+    "optimal": {
+        "spmv": "csr-csr"
+    },
+    "solver": {}
+}
+Matrix is of size (36, 36)
+	Running solver: cg
diff --git a/benchmark/test/reference/distributed_solver.matrix.stdout b/benchmark/test/reference/distributed_solver.matrix.stdout
@@ -0,0 +1,57 @@
+
+[
+    {
+        "filename": "",
+        "optimal": {
+            "spmv": "csr-csr"
+        },
+        "solver": {
+            "cg": {
+                "recurrent_residuals": [],
+                "true_residuals": [],
+                "implicit_residuals": [],
+                "iteration_timestamps": [],
+                "rhs_norm": 1.0,
+                "generate": {
+                    "components": {
+                        "generate(<typename>)": 1.0,
+                        "free": 1.0,
+                        "overhead": 1.0
+                    },
+                    "time": 1.0
+                },
+                "apply": {
+                    "components": {
+                        "apply(<typename>)": 1.0,
+                        "iteration": 1.0,
+                        "allocate": 1.0,
+                        "dense::fill": 1.0,
+                        "cg::initialize": 1.0,
+                        "advanced_apply(<typename>)": 1.0,
+                        "dense::row_gather": 1.0,
+                        "csr::advanced_spmv": 1.0,
+                        "dense::compute_squared_norm2": 1.0,
+                        "dense::compute_sqrt": 1.0,
+                        "copy(<typename>)": 1.0,
+                        "dense::copy": 1.0,
+                        "dense::compute_conj_dot_dispatch": 1.0,
+                        "check(<typename>)": 1.0,
+                        "residual_norm::residual_norm": 1.0,
+                        "cg::step_1": 1.0,
+                        "csr::spmv": 1.0,
+                        "cg::step_2": 1.0,
+                        "free": 1.0,
+                        "overhead": 1.0
+                    },
+                    "iterations": 27,
+                    "time": 1.0
+                },
+                "preconditioner": {},
+                "residual_norm": 1.0,
+                "repetitions": 1,
+                "completed": true
+            }
+        },
+        "size": 36
+    }
+]
diff --git a/benchmark/test/reference/matrix_statistics.matrix.stderr b/benchmark/test/reference/matrix_statistics.matrix.stderr
@@ -0,0 +1,8 @@
+This is Ginkgo 1.7.0 (develop)
+    running with core module 1.7.0 (develop)
+Running test case
+{
+    "filename": "",
+    "problem": {}
+}
+Matrix is of size (36, 36)
diff --git a/benchmark/test/reference/matrix_statistics.matrix.stdout b/benchmark/test/reference/matrix_statistics.matrix.stdout
@@ -0,0 +1,38 @@
+
+[
+    {
+        "filename": "",
+        "problem": {
+            "rows": 36,
+            "columns": 36,
+            "nonzeros": 208,
+            "row_distribution": {
+                "min": 4,
+                "q1": 4.5,
+                "median": 6.0,
+                "q3": 7.0,
+                "max": 9,
+                "mean": 5.777777777777778,
+                "variance": 2.061728395061728,
+                "skewness": 0.3366362745126052,
+                "kurtosis": 2.0507009932231366,
+                "hyperskewness": 1.9165991338199193,
+                "hyperflatness": 6.0545648993883665
+            },
+            "col_distribution": {
+                "min": 4,
+                "q1": 4.5,
+                "median": 6.0,
+                "q3": 7.0,
+                "max": 9,
+                "mean": 5.777777777777778,
+                "variance": 2.061728395061728,
+                "skewness": 0.3366362745126052,
+                "kurtosis": 2.0507009932231366,
+                "hyperskewness": 1.9165991338199193,
+                "hyperflatness": 6.0545648993883665
+            }
+        },
+        "size": 36
+    }
+]