IPU Emulator Documentation¶

Welcome to the IPU Emulator documentation. This project provides a complete IPU (Intelligence Processing Unit) emulation environment with assembly language support, C-based emulator, and comprehensive tooling.

Overview¶

This repository contains:

IPU Emulator - C-based emulator for IPU behavior
IPU Assembly Language (ipu-as) - Python-based assembler with Jinja2 preprocessing
XMEM Support - External memory emulation
Sample Programs - Fully connected neural network examples
Build System - Bazel-based build and test infrastructure

Quick Links¶

Assembly Syntax Guide - Complete assembly language reference
Instruction Reference - Complete IPU instruction set
Repository on GitHub

Repository Structure¶

ipu-c-samples/
├── src/
│   ├── apps/               # Sample applications
│   ├── lib/                # Core libraries (ipu, xmem, emulator, fp, logging)
│   └── tools/              # IPU assembler and emulator tools
├── test/                   # Unit tests
├── docs/                   # Documentation (this site)
├── BUILD.bazel             # Root build configuration
├── MODULE.bazel            # Bazel module dependencies
└── README.md               # Project README

Getting Started¶

Assembly Language¶

The IPU supports a custom assembly language with powerful preprocessing capabilities. See the Assembly Syntax Guide for:

Basic instruction format and syntax
Instruction separators (; vs ;;)
Register types and immediate values
Labels and control flow
Jinja2 preprocessing (variables, loops, macros, conditionals)
Complete examples and usage guide

Building and Testing¶

Build everything:

bazel build //...

Run tests:

bazel test //...

Generate documentation:

bazel build //docs:build_docs