.. note::
    :class: sphx-glr-download-link-note

    Click :ref:`here <sphx_glr_download_samples_gemm_gemm_main.py>` to download the full example code
.. rst-class:: sphx-glr-example-title

.. _sphx_glr_samples_gemm_gemm_main.py:


HeteroCL Tutorial : General Matrix Multiplication
=================================================

**Author**: Yi-Hsiang Lai (seanlatias@github), Jie Wang

.. code-block:: default

    import heterocl as hcl
    import numpy as np
    import time

    def gemm(m=1024, n=1024, k=1024, dtype=hcl.Int(), target=None):
        matrix_1 = hcl.placeholder((m, k), dtype=dtype)
        matrix_2 = hcl.placeholder((k, n), dtype=dtype)

        def kernel(matrix_1, matrix_2):
            r = hcl.reduce_axis(0, k, 'k')
            return hcl.compute((m, n),
                    lambda x, y: hcl.sum(matrix_1[x, r] * matrix_2[r, y],
                                         axis=r, dtype=dtype),
                    dtype=dtype,
                    name="out_matrix")

        s = hcl.create_schedule([matrix_1, matrix_2], kernel)
        out_matrix = kernel.out_matrix
        block_size = 8
        y0, y1 = s[out_matrix].split(out_matrix.axis[0], factor=block_size)
        x0, x1 = s[out_matrix].split(out_matrix.axis[1], factor=block_size)
        s[out_matrix].reorder(y0, x0, y1, x1)

        f = hcl.build(s, target=target)
        return f

    def time_gemm(dtype, m=1024, n=1024, k=1024, target=None):
        hcl.init(dtype)
        f = gemm(m, n, k, dtype, target)
        np_1 = np.random.randint(10, size=(m, k))
        np_2 = np.random.randint(10, size=(k, n))
        np_3 = np.matmul(np_1, np_2)

        hcl_m1 = hcl.asarray(np_1, dtype=dtype)
        hcl_m2 = hcl.asarray(np_2, dtype=dtype)
        hcl_m3 = hcl.asarray(np.zeros((m, n)), dtype=dtype)
        f(hcl_m1, hcl_m2, hcl_m3)
        begin = time.time()
        for i in range(10):
            f(hcl_m1, hcl_m2, hcl_m3)
        end = time.time()
        print("dtype is: ", dtype)
        print("average of 10 runs takes: {} sec".format((end - begin) / 10))
        np.testing.assert_allclose(hcl_m3.asnumpy(), np_3, rtol=1e-03)







Test the algorithm with different data types


.. code-block:: default

    dtypes = [hcl.Int(32), hcl.Float(), hcl.Fixed(32, 16)]

    # for dtype in dtypes:
    # time_gemm(hcl.Float(), 10, 10, 10, 'sdaccel')







.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.031 seconds)


.. _sphx_glr_download_samples_gemm_gemm_main.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download

     :download:`Download Python source code: gemm_main.py <gemm_main.py>`



  .. container:: sphx-glr-download

     :download:`Download Jupyter notebook: gemm_main.ipynb <gemm_main.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.readthedocs.io>`_