..  SPDX-License-Identifier: Apache-2.0
    Copyright (c) 2023-2024 Arm Technology (China) Co. Ltd.

Welcome to Compass DSL documentation!
=====================================


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

   getting_started/introduction
   getting_started/installation
   getting_started/build_and_run_workflow
   getting_started/tutorials/index

.. toctree::
   :maxdepth: 1
   :caption: Language Basics

   language_basics/functions
   language_basics/variables
   language_basics/types
   language_basics/mask
   language_basics/expression
   language_basics/statement
   language_basics/flexible_width_and_multiple_width_vector

.. toctree::
   :maxdepth: 1
   :caption: How-to Guides

   how_to_guides/how_to_write_a_basic_kernel
   how_to_guides/how_to_use_subfunctions
   how_to_guides/how_to_use_pointer
   how_to_guides/how_to_use_dma
   how_to_guides/how_to_use_mask
   how_to_guides/how_to_use_rpc
   how_to_guides/how_to_use_profiler
   how_to_guides/how_to_debug_with_python
   how_to_guides/how_to_write_the_operator_plugin
   how_to_guides/how_to_use_macros
   how_to_guides/how_to_use_inline_assembly
   how_to_guides/how_to_use_aiff

.. toctree::
   :maxdepth: 1
   :caption: Explanation

   explanation/about_this_doc
   explanation/zhouyi_npu_arch
   explanation/compass_dsl
   explanation/pysim
   explanation/static_and_dynamic_kernel

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/ir/index
   reference/script_api