:orphan:

User Tutorial
-------------

This tutorial provides an introduction to TVM, meant to address user who is new
to the TVM project. It begins with some basic information on how TVM works,
then works through installing TVM, compiling and optimizing models, then
digging in deeper to the Tensor Expression language and the tuning and
optimization tools that are built on top of it. After completing the tutorial,
a new user should be familiar enough with TVM to optimize models, and will be
prepared to dig into TVM more deeply.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Apache TVM is an open source machine learning compiler framework for CPUs, GPUs, and machine le...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_introduction_thumb.png
    :alt: Introduction

  :ref:`sphx_glr_tutorial_introduction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Introduction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Depending on your needs and your working environment, there are a few different methods for ins...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_install_thumb.png
    :alt: Installing TVM

  :ref:`sphx_glr_tutorial_install.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Installing TVM</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this section, we will work with TVMC, the TVM command line driver. TVMC is a tool that expos...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_tvmc_command_line_driver_thumb.png
    :alt: Compiling and Optimizing a Model with TVMC

  :ref:`sphx_glr_tutorial_tvmc_command_line_driver.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Compiling and Optimizing a Model with TVMC</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Hi! Here we explain the scripting tool designed for the complete TVM beginner. 🙂               ...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_tvmc_python_thumb.png
    :alt: Getting Starting using TVMC Python: a high-level API for TVM

  :ref:`sphx_glr_tutorial_tvmc_python.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Getting Starting using TVMC Python: a high-level API for TVM</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In the `TVMC Tutorial &lt;tvmc_command_line_driver&gt;`_, we covered how to compile, run, and tune a ...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_autotvm_relay_x86_thumb.png
    :alt: Compiling and Optimizing a Model with the Python Interface (AutoTVM)

  :ref:`sphx_glr_tutorial_autotvm_relay_x86.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Compiling and Optimizing a Model with the Python Interface (AutoTVM)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial we will turn our attention to how TVM works with Tensor Expression (TE) to def...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_tensor_expr_get_started_thumb.png
    :alt: Working with Operators Using Tensor Expression

  :ref:`sphx_glr_tutorial_tensor_expr_get_started.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working with Operators Using Tensor Expression</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we show how the TVM Tensor Expression (TE) language can be used to write sche...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_autotvm_matmul_x86_thumb.png
    :alt: Optimizing Operators with Schedule Templates and AutoTVM

  :ref:`sphx_glr_tutorial_autotvm_matmul_x86.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Optimizing Operators with Schedule Templates and AutoTVM</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we will show how TVM&#x27;s Auto Scheduling feature can find optimal schedules wit...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_auto_scheduler_matmul_x86_thumb.png
    :alt: Optimizing Operators with Auto-scheduling

  :ref:`sphx_glr_tutorial_auto_scheduler_matmul_x86.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Optimizing Operators with Auto-scheduling</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="TensorIR is a domain specific language for deep learning programs serving two broad purposes:">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_tensor_ir_blitz_course_thumb.png
    :alt: Blitz Course to TensorIR

  :ref:`sphx_glr_tutorial_tensor_ir_blitz_course.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Blitz Course to TensorIR</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial introduces cross compilation and remote device execution with RPC in TVM.">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_cross_compilation_and_rpc_thumb.png
    :alt: Cross Compilation and RPC

  :ref:`sphx_glr_tutorial_cross_compilation_and_rpc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cross Compilation and RPC</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to build a neural network with Relay python frontend and generates a run...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_relay_quick_start_thumb.png
    :alt: Quick Start Tutorial for Compiling Deep Learning Models

  :ref:`sphx_glr_tutorial_relay_quick_start.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quick Start Tutorial for Compiling Deep Learning Models</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Making your Hardware Accelerator TVM-ready with UMA">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_uma_thumb.png
    :alt: Making your Hardware Accelerator TVM-ready with UMA

  :ref:`sphx_glr_tutorial_uma.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Making your Hardware Accelerator TVM-ready with UMA</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an introductory tutorial to TVM Operator Inventory (TOPI). TOPI provides numpy-style ge...">

.. only:: html

  .. image:: /tutorial/images/thumb/sphx_glr_intro_topi_thumb.png
    :alt: Introduction to TOPI

  :ref:`sphx_glr_tutorial_intro_topi.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Introduction to TOPI</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorial/introduction
   /tutorial/install
   /tutorial/tvmc_command_line_driver
   /tutorial/tvmc_python
   /tutorial/autotvm_relay_x86
   /tutorial/tensor_expr_get_started
   /tutorial/autotvm_matmul_x86
   /tutorial/auto_scheduler_matmul_x86
   /tutorial/tensor_ir_blitz_course
   /tutorial/cross_compilation_and_rpc
   /tutorial/relay_quick_start
   /tutorial/uma
   /tutorial/intro_topi



.. only:: html

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

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