CLI Reference
mlsysim
The ML Systems Infrastructure Modeling Engine.
A first-principles analytical framework for predicting performance, cost, and carbon footprint of ML workloads.
Usage:
$ mlsysim [OPTIONS] COMMAND [ARGS]...Options:
-o, --output TEXT: Output format (text, json, markdown) [default: text]--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
zoo: Explore the built-in registries (The MLSys…schema: Export the JSON Schema for the mlsys.yaml…eval: [Tier 1] Evaluate the analytical physics…optimize: [Tier 3] Search the design space for…
mlsysim zoo
Explore the built-in registries (The MLSys Zoo).
Usage:
$ mlsysim zoo [OPTIONS] [CATEGORY]Arguments:
[CATEGORY]: Category to explore: ‘hardware’ or ‘models’
Options:
--help: Show this message and exit.
mlsysim schema
Export the JSON Schema for the mlsys.yaml configuration file (for AI agents & IDEs).
Usage:
$ mlsysim schema [OPTIONS]Options:
--help: Show this message and exit.
mlsysim eval
[Tier 1] Evaluate the analytical physics of an ML system (via YAML or CLI flags).
Usage:
$ mlsysim eval [OPTIONS] TARGET [HARDWARE]Arguments:
TARGET: Path tomlsys.yamlOR Model name (e.g.Llama3_8B) [required][HARDWARE]: Hardware name (e.g.H100) - Required if target is not a YAML file
Options:
-b, --batch-size INTEGER: Batch size (for single node evaluation) [default: 1]-p, --precision TEXT: Numerical precision (fp32,fp16,fp8,int8,int4) [default: fp16]-e, --efficiency FLOAT: Target Model FLOPs Utilization (0.0to1.0) [default: 0.5]--help: Show this message and exit.
mlsysim optimize
[Tier 3] Search the design space for optimal configurations.
Usage:
$ mlsysim optimize [OPTIONS] COMMAND [ARGS]...Options:
--help: Show this message and exit.
Commands:
parallelism: Find the optimal (TP, PP, DP) split to…batching: Find the maximum safe batch size for a…placement: Find the optimal datacenter region to…
mlsysim optimize parallelism
Find the optimal (TP, PP, DP) split to maximize MFU.
Usage:
$ mlsysim optimize parallelism [OPTIONS] CONFIG_FILEArguments:
CONFIG_FILE: Path to the mlsys.yaml configuration file [required]
Options:
--help: Show this message and exit.
mlsysim optimize batching
Find the maximum safe batch size for a given latency SLA.
Usage:
$ mlsysim optimize batching [OPTIONS] CONFIG_FILEArguments:
CONFIG_FILE: Path to the mlsys.yaml configuration file [required]
Options:
--sla-ms FLOAT: P99 Latency SLA in milliseconds [required]--qps FLOAT: Arrival rate in Queries Per Second [required]--help: Show this message and exit.
mlsysim optimize placement
Find the optimal datacenter region to minimize TCO and carbon footprint.
Usage:
$ mlsysim optimize placement [OPTIONS] CONFIG_FILEArguments:
CONFIG_FILE: Path to the mlsys.yaml configuration file [required]
Options:
--carbon-tax FLOAT: Carbon tax penalty in $/ton [default: 100.0]--help: Show this message and exit.