.. SiMa.ai documentation master file, created by
   sphinx-quickstart on Tue Oct 31 10:32:30 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SiMa.ai Developer Guide!
###################################

SiMa’s software development offering centers around a `GStreamer <https://gstreamer.freedesktop.org/features/>`_ pipeline that can be defined, packaged, and deployed to the SiMa MLA for accelerated inferencing.

|var_ecosystem_diagram|

At the heart of this ecosystem is :ref:`Palette CLI`, a containerized development environment that serves as the backbone of the SDK. :ref:`Palette CLI` provides powerful tools like 
:ref:`ModelSDK` for model quantization, testing, and compilation, the MLA Compiler for optimization, :ref:`Graph Surgery tools <Model Graph Surgery>` for model adaptation and the 
:ref:`MPK tool` for packaging and deploying applications. Developers can use Palette independently to build and manage pipelines locally, making it the foundation of SiMa’s development ecosystem. 
For rapid development, :ref:`PePPi <peppi>` Python tool abstracts development complexities, allowing developers to focus on experimentation. 

To simplify the process further, :ref:`Edgematic <edgematic>` offers a low-code, web-based platform with a visual pipeline interface for cloud-based evaluation, benchmarking, and performance optimization. 
With Edgematic, customers can explore and evaluate SiMa's capabilities without the need to purchase or set up hardware, making it easier to get started. By providing an intuitive 
interface for faster iteration, :ref:`Edgematic <edgematic>` complements :ref:`Palette CLI`, offering a seamless development experience from evaluation to deployment.

Together, :ref:`Palette CLI` and :ref:`Edgematic <edgematic>` deliver a flexible and scalable development experience, enabling developers to choose between comprehensive workflows or faster 
iterations, regardless of the :ref:`target system architecture<Target architecture>`.


.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   pages/overview/target_architectures.rst
   pages/overview/devkit.rst
   pages/overview/hello_sima.rst

.. toctree::
   :maxdepth: 2
   :caption: Pipeline Development
   :hidden:

   pages/palette/main.rst
   pages/edgematic/main.rst
   pages/building_apps/developing_gstreamer_apps/main.rst   
   pages/peppi/main.rst
   pages/model-sdk/main.rst

.. toctree::
   :maxdepth: 2
   :caption: App Development
   :hidden:

   pages/app_dev/pcie-dev.rst
   pages/app_dev/standalone-dev.rst

.. toctree::
   :maxdepth: 2
   :caption: References
   :hidden:
   
   pages/api_reference/pcie_host_apis/main.rst
   pages/api_reference/model_sdk.rst
   pages/api_reference/peppi.rst

   pages/plugins/main.rst
   pages/cvu/main.rst
   pages/software/main.rst
   pages/extra-docs/main.rst 

.. toctree::
   :maxdepth: 2
   :caption: Release Notes
   :hidden:

   pages/release_notes/1.6.rst
   pages/release_notes/1.5.rst


.. |var_ecosystem_diagram| image:: pages/media/software-ecosystem.png
    :alt: Software Ecosystem Diagram
    :align: middle
    :width: 80%