|
| 1 | +<!-- |
| 2 | +SPDX-License-Identifier: Apache-2.0 |
| 3 | +Copyright (C) 2026 Advanced Micro Devices, Inc. All rights reserved. |
| 4 | +--> |
| 5 | + |
| 6 | +# xrt-smi |
| 7 | + |
| 8 | +`xrt-smi` is the XRT command-line tool for Ryzen client NPUs (among other targets). On Ryzen it provides **examine**, **validate**, and **configure** subcommands. The tables below summarize the usual options and choices for those subcommands. |
| 9 | + |
| 10 | +For every flag and report or test name supported on your system, run `xrt-smi <subcommand> --help`. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## examine |
| 15 | + |
| 16 | +Options for `xrt-smi examine` on Ryzen NPUs: |
| 17 | + |
| 18 | +| Option | Short | Description | |
| 19 | +|--------|-------|-------------| |
| 20 | +| `--device` | `-d` | PCI Bus:Device.Function of the device (for example `0000:d8:00.0`). | |
| 21 | +| `--format` | `-f` | Report format: `JSON` (default) or `JSON-2020.2`. | |
| 22 | +| `--output` | `-o` | Write report output to the given file. | |
| 23 | +| `--help` | `-h` | Show subcommand help. | |
| 24 | +| `--report` | `-r` | One or more reports (see the next table). | |
| 25 | + |
| 26 | +Values for `--report` / `-r`: |
| 27 | + |
| 28 | +| Report | Description | |
| 29 | +|--------|-------------| |
| 30 | +| `aie-partitions` | AIE partition information. | |
| 31 | +| `all` | Produce all reports supported for your device. | |
| 32 | +| `host` | Host information (default when no report is selected). | |
| 33 | +| `platform` | Platform / device summary. | |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## validate |
| 38 | + |
| 39 | +Options for `xrt-smi validate` on Ryzen NPUs: |
| 40 | + |
| 41 | +| Option | Short | Description | |
| 42 | +|--------|-------|-------------| |
| 43 | +| `--device` | `-d` | PCI Bus:Device.Function of the device. | |
| 44 | +| `--format` | `-f` | Results format: `JSON` (default) or `JSON-2020.2`. | |
| 45 | +| `--output` | `-o` | Write results to the given file. | |
| 46 | +| `--help` | `-h` | Show subcommand help. | |
| 47 | +| `--run` | `-r` | One or more tests (see the next table). | |
| 48 | + |
| 49 | +Values for `--run` / `-r`: |
| 50 | + |
| 51 | +| Test | Description | |
| 52 | +|------|-------------| |
| 53 | +| `all` | Run all applicable validate tests (default when none are selected). | |
| 54 | +| `latency` | End-to-end latency test. | |
| 55 | +| `throughput` | End-to-end throughput test. | |
| 56 | +| `gemm` | GEMM INT8 workload; reports throughput-oriented results. | |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## configure |
| 61 | + |
| 62 | +Options for `xrt-smi configure` on Ryzen NPUs: |
| 63 | + |
| 64 | +| Option | Short | Description | |
| 65 | +|--------|-------|-------------| |
| 66 | +| `--device` | `-d` | PCI Bus:Device.Function of the device. | |
| 67 | +| `--help` | `-h` | Show subcommand help. | |
| 68 | +| `--pmode` | *(none)* | Power mode: `default`, `powersaver`, `balanced`, `performance`, or `turbo`. | |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +For a broader FleXible RunTime (XRT) overview, see [README.rst](../../../../../README.rst) at the root of the `xrt` tree in this repository. |
0 commit comments