QRMI: design metrics API

[IceKhan13]

What problem are you trying to solve?

Design metrics API which will be exposed by vendors and used in accounting information

Describe the solution you’d like

Example of information might be exposed

struct ResourceMetadata {
  qubits: i32, # number of qubits allocated
  device_id: String, # name of the device
  health: bool, # health status
  powerDraw: f64, # energy consumption
  utilization: f32, # utilization metric
  ...
}

Describe any alternatives you’ve considered

No response

Documentation, Adoption, Migration Strategy

No response

[iamashwin99]

https://quantum.cloud.ibm.com/api/docs/ provides maybe some ideas that could be useful.

Espacially

• /v1/analytics/usage
• /v1/jobs/{id}/metrics

[utzb]

slurm community call discussion July 22:

There might be three categories of data

• information about quantum resources
  • including device state and calibration/quality information
  • while e.g. IBM provides a great level of detail on qubits and qubit connections (see visually in https://quantum.cloud.ibm.com/computers?system=ibm_kingston) for a given time through the API, JSC is more thinking about providing a basic metric that gives HPC users a quick clue on how well the backend is doing. (Maybe we want both.)
• consumption metrics (how much time, resources, ... was used by a job)
• profiling information, e.g. based on timestamps: how was my job performing and what could be done to improve overall performance

[utzb]

Discussion in slurm community call Sept 16 on how to expose, and where this would be consumed from.

Interface is QRMI.

Two use cases:

• users getting information on jobs, backends, or anything needed for debugging
  • exposed in qiskit objects (like today). Potentially
• admins doing statistical analysis, keeping track of utilization, watching trends etc
  • basic stats will be fed into slurm database. There maybe limitations what metrics that db is going to take, but it might be already good enough for admins
  • if not enough, seperate flows (file, potentially for further processing elsewhere) might be a way. (This is not an alternative, but an additional option if needed)