Add conversions benchmarking support to Ginkgo

[tcojean]

• The user specifies the format(s) he wants to benchmark.
• The benchmarker tries to benchmark this against all other formats.
• If no conversion exist between these formats, completed: false is reported in the results.

Sample output when running BENCHMARK=conversions

[
    {
        "filename": "/home/benchmarks/.config/ssget/MM/HB/1138_bus/1138_bus.mtx",
        "problem": {
            "id": 1,
            "group": "HB",
            "name": "1138_bus",
            "rows": 1138,
            "cols": 1138,
            "nonzeros": 4054,
            "real": true,
            "binary": false,
            "2d3d": false,
            "posdef": true,
            "psym": 1,
            "nsym": 1,
            "kind": "power network problem",
            "row_distribution": {
                "min": 2,
                "q1": 2.0,
                "median": 3.0,
                "q3": 4.0,
                "max": 18,
                "mean": 3.562390158172232,
                "variance": 3.247864937407531,
                "skewness": 2.228146865738476,
                "kurtosis": 11.27766449882735,
                "hyperskewness": 62.4708567384242,
                "hyperflatness": 401.1203913461838
            },
            "col_distribution": {
                "min": 2,
                "q1": 2.0,
                "median": 3.0,
                "q3": 4.0,
                "max": 18,
                "mean": 3.562390158172232,
                "variance": 3.247864937407531,
                "skewness": 2.228146865738476,
                "kurtosis": 11.27766449882735,
                "hyperskewness": 62.4708567384242,
                "hyperflatness": 401.1203913461838
            }
        },
        "spmv": {
            "csr": {
                "storage": 53712,
                "time": 24744.5,
                "completed": true
            },
            "coo": {
                "storage": 64864,
                "time": 25874.4,
                "completed": true
            },
            "hybrid": {
                "storage": 60312,
                "time": 28899.0,
                "completed": true
            },
            "sellp": {
                "storage": 146216,
                "time": 24955.4,
                "completed": true
            },
            "ell": {
                "storage": 245808,
                "time": 23365.8,
                "completed": true
            }
        },
        "optimal": {
            "spmv": "ell"
        },
        "conversions": {
            "csr-coo": {
                "time": 82400.7,
                "completed": true
            },
            "csr-ell": {
                "time": 155313.0,
                "completed": true
            },
            "csr-hybrid": {
                "completed": false
            },
            "csr-sellp": {
                "time": 252322.3,
                "completed": true
            },
            "coo-csr": {
                "time": 87257.2,
                "completed": true
            },
            "coo-ell": {
                "completed": false
            },
            "coo-hybrid": {
                "completed": false
            },
            "coo-sellp": {
                "completed": false
            },
            "hybrid-coo": {
                "completed": false
            },
            "hybrid-csr": {
                "completed": false
            },
            "hybrid-ell": {
                "completed": false
            },
            "hybrid-sellp": {
                "completed": false
            },
            "sellp-coo": {
                "completed": false
            },
            "sellp-csr": {
                "time": 207013.4,
                "completed": true
            },
            "sellp-ell": {
                "completed": false
            },
            "sellp-hybrid": {
                "completed": false
            },
            "ell-coo": {
                "completed": false
            },
            "ell-csr": {
                "time": 205345.8,
                "completed": true
            },
            "ell-hybrid": {
                "completed": false
            },
            "ell-sellp": {
                "completed": false
            }
        }
    }
]

[codecov]

Codecov Report

Merging #312 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #312   +/-   ##
========================================
  Coverage    98.17%   98.17%           
========================================
  Files          215      215           
  Lines        16529    16529           
========================================
  Hits         16227    16227           
  Misses         302      302

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 82e6da6...7a1e531. Read the comment docs.

[tcojean]

This is ready for review. I added a sample output of the current conversion timings for matrix 1138_bus (suitesparse matrix n°1).

[hartwiganzt]

I understand correctly, the conversion is always format 1 -> format 2 ? Or both ways?

[tcojean]

When it is said that the user wants to benchmark conversions for a format (say csr), conversions are automatically tried against all other formats in Ginkgo (i.e. coo, ell, hybrid, sellp).

In other words, the users only give "format1" as argument to the benchmarker. Then, all possible format2 are tested. If both format1 and format2 are given as argument then both ways will be benchmarked. I thought if the users specify both format1 and format2 as arguments it is too tiresome as there is a lot of possible combinations.

[hartwiganzt]

Makes sense. But we should be explicit in the description, then...

[thoasm]

LGTM!
Only very minor comments from my side, nothing critical.

[tcojean]

This now got quite an update. I removed as part of this PR a lot of the code duplication we had within our benchmarks. I also improve a little the overall code quality (remove unused parameters and templates, etc).

[thoasm]

Minor comments.
I really like the improvements you made!

[tcojean]

Documentation was added, and documentation generation is also fixed as can be seen here:
https://gitlab.com/ginkgo-project/ginkgo-public-ci/-/jobs/225795553

[thoasm]

LGTM!
Thanks for also taking care of the documentation errors!