API Reference

SysSim’s public API has three layers. Most users only need the high-level functions.

High-level API

simulate, estimate_memory, sweep and the config dataclasses (ModelConfig, ParallelismConfig, TrainingConfig, HardwareConfig).

High-level API
Configuration & Hardware

Lower-level hardware modeling: HardwareInfo, NetworkParams, get_hardware_info.

Configuration & Hardware
Operator Graph

The traced IR: OperatorGraph, OperatorNode, OperatorType, TensorMeta.

Operator Graph

The command-line interface wraps the high-level functions.