oneAPI-spec
oneAPI-spec copied to clipboard
Bogus zesMemoryGetBandwidth() documentation
See zesMemoryGetBandwidth() documentation: https://spec.oneapi.io/level-zero/latest/sysman/api.html#zesmemorygetbandwidth
It claims following:
Parameters
- hMemory: [in] Handle for the component.
- pBandwidth: [in,out] Will contain the current health, free memory, total memory size.
Although zes_mem_bandwidth_t
struct includes none of listed items: https://spec.oneapi.io/level-zero/latest/sysman/api.html#_CPPv419zes_mem_bandwidth_t
Thanks for pointing this out - we'll fix the documentation. I feel that the function name is misleading. Although the call does give you the design bandwidth, it's returning much more in the form of the counters that let you compute the actual bandwidth. So perhaps it should have been named zesMemoryGetBandwidthCounters ?
I'd care more about consistency rather than exact name. Similar function for fabric is called zesFabricPortGetThroughput()...