Mention `iree-run-module --dump_devices` in docs - Githubissues

iree-org / iree

A retargetable MLIR-based machine learning compiler and runtime toolkit.

http://iree.dev/

Apache License 2.0

2.56k stars 571 forks source link

Mention `iree-run-module --dump_devices` in docs #17977

Open ScottTodd opened 1 month ago

ScottTodd commented 1 month ago

We have this snippet in our Vulkan docs: https://iree.dev/guides/deployment-configurations/gpu-vulkan/#get-the-iree-runtime

Should add similar snippets to CUDA, ROCm, Metal, etc. pages as well as the common https://iree.dev/guides/deployment-configurations/#runtime-hal-driversdevices page.

Explain devices UUIDs and ordinals, as well as usage from CLI tools, C API bindings, and Python bindings.

Troubleshoot if the device(s) you expect to show up do not (e.g. missing from the build configuration, system GPU driver missing, GPU offline, etc.)

ScottTodd commented 1 month ago

Can probably batch these updates together with multi-device doc updates (see --iree-hal-target-device usage explained on https://github.com/iree-org/iree/pull/17987)