.. _Palette CLI:

Palette
#######

.. grid:: 1
   :gutter: 1

   .. grid-item-card::

      |var_palette_sw_diagram|


    .. admonition:: Installation Options

        To install the SDK, follow the instructions below for **Ubuntu 22.04 Linux desktop**,  
        or download the `SDK package <https://docs.sima.ai/pkg_downloads/SDK1.7.0/sdk/1.7.0_Palette_SDK_master_B219.zip>`_  
        and follow the :ref:`step-by-step installation guide <Palette installation>`.

        .. code-block:: console
            
            sima-user@sima-user-machine:~$ python3 -m venv .venv && source .venv/bin/activate
            sima-user@sima-user-machine:~$ pip3 install sima-cli
            sima-user@sima-user-machine:~$ sima-cli install -v 1.7.0 sdk

.. grid:: 2
    :gutter: 1

    .. grid-item::

        .. grid:: 1 1 1 1
            :gutter: 1

            .. grid-item-card:: :ref:`Palette Software Overview`

                Brief description of the Palette software and how to use it.
                
            .. grid-item-card:: :ref:`Palette Installation`

                Step-by-step installation of the Palette software.

            .. grid-item-card:: :ref:`Get FPS`

                How to get frames-per-second throughput numbers for your models.

            .. grid-item-card:: :ref:`MPK Tool`

                How to use the MPK tool using commands available in the Palette software.

    .. grid-item::

        .. grid:: 1 1 1 1
            :gutter: 1

            .. grid-item-card:: :ref:`Palette Requirements`

                Requirements for a successful installation and use of the software.
        
            .. grid-item-card:: :ref:`ModelSDK`

                How to calibrate, quantize, and compile your model.

            .. grid-item-card:: :ref:`Get Accuracy`

                How to get metrics for your model using your board as an accelerator.

            .. grid-item-card:: :ref:`MLPerf Benchmark`

                How to reproduce the MLPerf benchmark numbers.

.. toctree::
   :maxdepth: 2
   :hidden:

   sw_overview.rst
   installation_requirements.rst
   installation.rst
   get_fps.rst
   get_accuracy.rst
   mpk_tools.rst
   mlperf_benchmark.rst

.. |var_palette_sw_diagram| image:: media/palette_sw_overview.png
    :alt: Palette SW components
    :align: middle