Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a usage function on RuntimeJob so metrics don't have to be parsed #1819

Closed
mriedem opened this issue Jul 26, 2024 · 2 comments · Fixed by #1827
Closed

Provide a usage function on RuntimeJob so metrics don't have to be parsed #1819

mriedem opened this issue Jul 26, 2024 · 2 comments · Fixed by #1827
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@mriedem
Copy link
Contributor

mriedem commented Jul 26, 2024

What is the expected feature or enhancement?

The RuntimeJob.metrics() method does not document what is in that metrics dictionary.

For the quantum channel the API docs are here. For the cloud channel the API docs are here.

There are 3 different fields in there that talk about usage:

image

It'd be nice if the client didn't have to know which of these to use to get the usage of a terminal-state job and instead a usage() method or something like that could abstract that information in the SDK.

This is sort of similar to how Session.details() has the usage_time field, but at least that's documented.

Acceptance criteria

Provide a method on RuntimeJob to get the usage time of a job.

@mriedem mriedem added the enhancement New feature or request label Jul 26, 2024
@kt474 kt474 self-assigned this Jul 29, 2024
@jyu00
Copy link
Collaborator

jyu00 commented Aug 13, 2024

We should do the same for Session + Batch. We'll need to update docs once that's done.

@kt474 kt474 added this to the 0.30.0 milestone Sep 16, 2024
@kt474
Copy link
Member

kt474 commented Sep 17, 2024

We should do the same for Session + Batch. We'll need to update docs once that's done.

Added an issue to update the docs once this is in the newest release Qiskit/documentation#1971

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants