Welcome to Compass DSL documentation!

Getting Started

• Introduction
  • What is DSL?
  • What is Compass DSL?
  • Workflow
  • A Simple Code of Compass DSL
• Installation
  • Dependencies
  • Pip Install
  • Verification
• Build and Run Workflow
  • General Build Workflow
  • BuildManager
  • Lower
  • Codegen
  • Builder
  • Executor
• Tutorials
  • Tutorial 0: Quick Start
  • Tutorial 1: Static Add
  • Tutorial 2: Dynamic Add
  • Tutorial 3: Reduce Operator
  • Tutorial 4: LUT Operator
  • Tutorial 5: Quantization Operator

Language Basics

• Functions
• Variables
• Types
• Mask
• Expression
• Statement
• Flexible/Multiple Width Vector

How-to Guides

• How to Write a Basic Kernel
• How to Use Subfunctions
• How to Use a Pointer
• How to Use DMA
• How to Use Mask
• How to Use RPC
• How to Use Profiler
• How to Debug with Python
• How to Write the Operator Plugin
• How to Use Macros
• How to Use Inline Assembly
• How to use AIFF

Explanation

• About This Documentation
• Zhouyi NPU Architecture
• Compass DSL
• Python Simulator (PySim)
• Static and Dynamic Kernel

Reference

• Builtin API
  • Arithmetic
  • Bitwise
  • Compare
  • Conversion
  • Math
  • Memory
  • Miscellaneous
  • Permuation
  • Synchronization
• Script API
  • prim_func()
  • macro()
  • Pointer
  • BuildManager
  • Executor
  • get_rpc_session()
  • hw_native_vdtype()
  • rand()
  • vectorized()
  • block()
  • grid()
  • spatial()
  • reduce()
  • remap()