index.rst

:orphan:



.. _sphx_glr_tutorials:

Tutorials
=========



.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Introduction ------------">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_pruning_speedup_thumb.png
     :alt: Speedup Model with Mask

     :ref:`sphx_glr_tutorials_pruning_speedup.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/pruning_speedup

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" Introduction ------------">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_quantization_speedup_thumb.png
     :alt: SpeedUp Model with Calibration Config

     :ref:`sphx_glr_tutorials_quantization_speedup.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/quantization_speedup

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here is a four-minute video to get you started with model quantization.">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_quantization_quick_start_mnist_thumb.png
     :alt: Quantization Quickstart

     :ref:`sphx_glr_tutorials_quantization_quick_start_mnist.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/quantization_quick_start_mnist

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here is a three-minute video to get you started with model pruning.">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_pruning_quick_start_mnist_thumb.png
     :alt: Pruning Quickstart

     :ref:`sphx_glr_tutorials_pruning_quick_start_mnist.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/pruning_quick_start_mnist

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To write a new quantization algorithm, you can write a class that inherits nni.compression.pyto...">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_quantization_customize_thumb.png
     :alt: Customize a new quantization algorithm

     :ref:`sphx_glr_tutorials_quantization_customize.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/quantization_customize

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we show how to use NAS Benchmarks as datasets. For research purposes we somet...">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_nasbench_as_dataset_thumb.png
     :alt: Use NAS Benchmarks as Datasets

     :ref:`sphx_glr_tutorials_nasbench_as_dataset.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/nasbench_as_dataset

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Users can easily customize a basic pruner in NNI. A large number of basic modules have been pro...">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_pruning_customize_thumb.png
     :alt: Customize Basic Pruner

     :ref:`sphx_glr_tutorials_pruning_customize.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/pruning_customize

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is the 101 tutorial of Neural Architecture Search (NAS) on NNI. In this tutorial, we will ...">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_hello_nas_thumb.png
     :alt: Hello, NAS!

     :ref:`sphx_glr_tutorials_hello_nas.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/hello_nas

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we demonstrate how to search in the famous model space proposed in `DARTS`_.">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_darts_thumb.png
     :alt: Searching in DARTS search space

     :ref:`sphx_glr_tutorials_darts.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/darts

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Workable Pruning Process ------------------------">

.. only:: html

 .. figure:: /tutorials/images/thumb/sphx_glr_pruning_bert_glue_thumb.png
     :alt: Pruning Bert on Task MNLI

     :ref:`sphx_glr_tutorials_pruning_bert_glue.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/pruning_bert_glue
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. _sphx_glr_tutorials_hpo_quickstart_pytorch:




.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The tutorial consists of 4 steps: ">

.. only:: html

 .. figure:: /tutorials/hpo_quickstart_pytorch/images/thumb/sphx_glr_main_thumb.png
     :alt: HPO Quickstart with PyTorch

     :ref:`sphx_glr_tutorials_hpo_quickstart_pytorch_main.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/hpo_quickstart_pytorch/main

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It can be run directly and will have the exact same result as original version.">

.. only:: html

 .. figure:: /tutorials/hpo_quickstart_pytorch/images/thumb/sphx_glr_model_thumb.png
     :alt: Port PyTorch Quickstart to NNI

     :ref:`sphx_glr_tutorials_hpo_quickstart_pytorch_model.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/hpo_quickstart_pytorch/model
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. _sphx_glr_tutorials_hpo_quickstart_tensorflow:




.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The tutorial consists of 4 steps: ">

.. only:: html

 .. figure:: /tutorials/hpo_quickstart_tensorflow/images/thumb/sphx_glr_main_thumb.png
     :alt: HPO Quickstart with TensorFlow

     :ref:`sphx_glr_tutorials_hpo_quickstart_tensorflow_main.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/hpo_quickstart_tensorflow/main

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It can be run directly and will have the exact same result as original version.">

.. only:: html

 .. figure:: /tutorials/hpo_quickstart_tensorflow/images/thumb/sphx_glr_model_thumb.png
     :alt: Port TensorFlow Quickstart to NNI

     :ref:`sphx_glr_tutorials_hpo_quickstart_tensorflow_model.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tutorials/hpo_quickstart_tensorflow/model
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only:: html

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

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