Update pages around usage by abbycross · Pull Request #4787 · Qiskit/documentation

abbycross · 2026-03-10T19:02:34Z

review-notebook-app · 2026-03-10T19:02:40Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

kevin-stevens-ibm · 2026-03-10T21:13:56Z

docs/guides/estimate-job-run-time.ipynb

   "source": [
    "<span id=\"usage\"></span>\n",
-    "Usage is a measurement of the amount of time the QPU is locked for your workload, and it is calculated differently, depending on which execution mode you're using.\n",
+    "Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type.\n",


Suggested change

"Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type.\n",

"Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type and resources selected.\n",

Suggest we add this as within the next year we will have QPUs >200 qubits that cost more than our <200 qubit systems per contract.

Small detail. Later we say “... quantum usage (quantum resource consumption)", but here we say “amount of resource consumption”, instead of "amount of quantum resource consumption". I’m not sure how precise we want to be or whether we want to spell this out every time.

Hm, the link isn't taking me to exactly where you see this @raulotaolea, but what I thought I understood from @jyu00 is that there is a difference between usage and quantum usage. If so, is it correct how we're using it?

QPU usage = quantum usage?

docs/guides/estimate-job-run-time.ipynb

docs/guides/max-execution-time.ipynb

docs/guides/specify-runtime-options.ipynb

kevin-stevens-ibm · 2026-03-10T21:27:27Z

docs/guides/manage-cost.mdx

 These are the fields relevant to cost:

- **Billing cycle usage**: The amount of _quantum time_ used by this instance during the current billing cycle. Quantum time is the duration a QPU is committed to fulfilling a user request.
+- **Billing cycle usage**: The instance's _quantum usage_ during the current billing cycle. Quantum usage is the duration a QPU is committed to fulfilling a user request.


I was actually looking at this doc earlier today. I don't actually see these fields in the instance details panel. It just links you to the Analytics page it seems.

Correct. We had them in the IBM Cloud UI plugin for PayGo instances but they don't make sense in IQP. You can remove:

Billing cycle usage

Billing cycle cost

Total cost
A user can always see them on the IBM Cloud billing page.

@raulotaolea can you check my updates in cb8d866 and make sure it accurately reflects the changes?

docs/guides/manage-cost.mdx

docs/guides/plans-overview.mdx

raulotaolea · 2026-03-11T11:04:30Z

docs/guides/estimate-job-run-time.ipynb

   "source": [
    "<span id=\"usage\"></span>\n",
-    "Usage is a measurement of the amount of time the QPU is locked for your workload, and it is calculated differently, depending on which execution mode you're using.\n",
+    "Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type.\n",


Small detail. Later we say “... quantum usage (quantum resource consumption)", but here we say “amount of resource consumption”, instead of "amount of quantum resource consumption". I’m not sure how precise we want to be or whether we want to spell this out every time.

raulotaolea · 2026-03-11T11:15:28Z

docs/guides/manage-cost.mdx

 These are the fields relevant to cost:

- **Billing cycle usage**: The amount of _quantum time_ used by this instance during the current billing cycle. Quantum time is the duration a QPU is committed to fulfilling a user request.
+- **Billing cycle usage**: The instance's _quantum usage_ during the current billing cycle. Quantum usage is the duration a QPU is committed to fulfilling a user request.


Correct. We had them in the IBM Cloud UI plugin for PayGo instances but they don't make sense in IQP. You can remove:

Billing cycle usage

Billing cycle cost

Total cost
A user can always see them on the IBM Cloud billing page.

docs/guides/manage-cost.mdx

docs/guides/execution-modes-faq.mdx

Co-authored-by: Fran Cabrera <francabrera@users.noreply.github.com> Co-authored-by: Kevin Stevens <kevin.stevens2@ibm.com>

Co-Authored-By: Kevin Stevens <178142897+kevin-stevens-ibm@users.noreply.github.com>

Co-authored-by: Kevin Stevens <kevin.stevens2@ibm.com>

…into ajc/pricing

abbycross · 2026-03-11T16:26:28Z

@jyu00 the IBM Circuit function doc has a max_execution_time option that mentions QPU ~~time~~ usage - can I safely assume that's another place to update to ...quantum usage (not wall clock time), which is based on the amount of time that the QPU is dedicated to processing your job?

abbycross · 2026-03-11T16:27:28Z

Also @jyu00 -
looks like quantum_seconds is being deprecated - does that mean we need a new code block (from this page):

# Find quantum time used by the job
print(f"Quantum time used by job {job.job_id()} was {job.metrics()['usage']['quantum_seconds']} seconds")

jyu00 · 2026-03-12T14:09:02Z

@jyu00 the IBM Circuit function doc has a max_execution_time option that mentions QPU ~~time~~ usage - can I safely assume that's another place to update to ...quantum usage (not wall clock time), which is based on the amount of time that the QPU is dedicated to processing your job?

Yeah, and instead of the amount of time that the QPU is dedicated to processing your job, it should be changed to the amount of quantum resource consumption in seconds.

abbycross · 2026-03-12T17:47:42Z

@jyu00 I saw a message from you about doing a followup PR for API changes, but now that is missing - are we ok as-is then? I had changed max_execution_time with max_usage per the box document - lmk if I should change back.

abbycross · 2026-03-12T17:49:24Z

Ignore me - I just realized it was in an internal discussion. I'm assuming that yes I should change back to max_execution_time.

@jyu00 I saw a message from you about doing a followup PR for API changes, but now that is missing - are we ok as-is then? I had changed max_execution_time with max_usage per the box document - lmk if I should change back.

qiskit-bot · 2026-03-13T13:39:48Z

One or more of the following people are relevant to this code:

@ElePT
@HuangJunye
@garrison
@jenglick
@jyu00
@kaelynj
@pandasa123
@raulotaolea
@abbycross
@beckykd
@jakelishman
@lerongil
abbycross

abbycross · 2026-03-19T15:55:02Z

I think this is ready for another round of reviews - @raulotaolea can you make sure your concerns were addressed?

jyu00 · 2026-03-20T13:14:57Z

docs/guides/estimate-job-run-time.ipynb

   "source": [
    "<span id=\"usage\"></span>\n",
-    "Usage is a measurement of the amount of time the QPU is locked for your workload, and it is calculated differently, depending on which execution mode you're using.\n",
+    "Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type and resources selected.\n",


Can we link to the IQP plan page for plan type to make it obvious what plan means here? Also, does resources here mean compute resources?

jyu00 · 2026-03-20T13:16:45Z

docs/guides/estimate-job-run-time.ipynb

    "\n",
    "Note that failed or canceled jobs count toward your usage in certain circumstances - see the [Failed and canceled jobs](#failed-job) section for details.\n",
    "\n",
    "For paid plan users, usage determines how much the workload costs. See [Manage cost](/docs/guides/manage-cost) for details.\n",


Here it says "paid plan", which to me implies all but open plan. But that link is only about Pay-go plan (at least according to its title)?

jyu00 · 2026-03-20T13:20:24Z

docs/guides/execution-modes-faq.mdx

- Because batch mode doesn't give you exclusive access to a backend, jobs inside a batch might run with other users' jobs or calibration jobs.
- If some jobs fail, you still get results from the completed jobs.
- You can take action in the middle of a batch workload based on the results of completed jobs. For example, you can cancel the rest of the jobs if the initial results look incorrect.


why are these 3 bullets removed?

jyu00 · 2026-03-20T13:25:27Z

docs/guides/max-execution-time.ipynb

    " <Admonition>\n",
    "   The session or batch is immediately terminated when the cost limit is reached.\n",
    "</Admonition>\n",


Not strictly related to this PR, but session/batch is only closed when its maximum TTL is reach. Any jobs that are running will still finish.

abbycross added 4 commits March 10, 2026 10:43

Update execution-modes-faq.mdx

43ced89

update definition, remove estimation section

ed76dde

update bullet points

4e96549

update failed/canceled jobs section

872f177

github-project-automation bot added this to Docs Planning Mar 10, 2026

github-actions bot had a problem deploying to pr_preview March 10, 2026 19:02 Failure

abbycross added 2 commits March 10, 2026 16:04

Merge branch 'main' into ajc/pricing

14f15cb

define quantum usage

e8c7743

github-actions bot deployed to pr_preview March 10, 2026 20:10 View deployment

replace quantum time

db3e264

github-actions bot deployed to pr_preview March 10, 2026 20:22 View deployment

abbycross added 3 commits March 10, 2026 16:25

typo

949119a

need to verify - replace with max_usage?

af564fb

more replacing with max_usage

eff98ac

github-actions bot deployed to pr_preview March 10, 2026 20:31 View deployment

abbycross requested a review from jyu00 March 10, 2026 20:31

kevin-stevens-ibm reviewed Mar 10, 2026

View reviewed changes

raulotaolea reviewed Mar 11, 2026

View reviewed changes

francabrera reviewed Mar 11, 2026

View reviewed changes

docs/guides/execution-modes-faq.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

4c8b002

Co-authored-by: Fran Cabrera <francabrera@users.noreply.github.com> Co-authored-by: Kevin Stevens <kevin.stevens2@ibm.com>

github-actions bot deployed to pr_preview March 11, 2026 15:50 View deployment

abbycross added 3 commits March 11, 2026 11:55

Merge branch 'main' into ajc/pricing

77e718a

Restore estimate usage section

9d2576b

typo

c9db906

github-actions bot deployed to pr_preview March 11, 2026 15:59 View deployment

abbycross and others added 2 commits March 11, 2026 12:00

code review

e986626

Co-Authored-By: Kevin Stevens <178142897+kevin-stevens-ibm@users.noreply.github.com>

Update manage-cost.mdx

cb8d866

github-actions bot temporarily deployed to pr_preview March 11, 2026 16:15 Destroyed

Apply suggestions from code review

02eb0db

Co-authored-by: Kevin Stevens <kevin.stevens2@ibm.com>

github-actions bot deployed to pr_preview March 11, 2026 16:17 View deployment

abbycross added 3 commits March 11, 2026 12:20

add "based on"

ac9ed40

Merge branch 'ajc/pricing' of https://github.com/Qiskit/documentation …

000e74b

…into ajc/pricing

add another "based on"

7308ae2

abbycross added 2 commits March 12, 2026 13:39

Merge branch 'main' into ajc/pricing

3c240f6

updates per Jessie

8b22e8f

restore max_execution_time

2f0189e

github-actions bot deployed to pr_preview March 12, 2026 17:52 View deployment

abbycross added 2 commits March 13, 2026 09:38

Merge branch 'main' into ajc/pricing

72b8103

Update qiskit-runtime-circuit-timing.ipynb

09b36a2

github-actions bot deployed to pr_preview March 13, 2026 13:39 View deployment

abbycross marked this pull request as ready for review March 13, 2026 13:39

abbycross requested a review from a team March 13, 2026 13:39

abbycross mentioned this pull request Mar 13, 2026

Clarify usage #2129

Open

5 tasks

Merge branch 'main' into ajc/pricing

a2862c8

github-actions bot deployed to pr_preview March 19, 2026 15:48 View deployment

abbycross moved this to In Review in Docs Planning Mar 19, 2026

jyu00 reviewed Mar 20, 2026

View reviewed changes

	"Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type.\n",
	"Usage is a measurement of the amount of resource consumption. This resource consumption maps to different cost based on the plan type and resources selected.\n",

Conversation

abbycross commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

review-notebook-app bot commented Mar 10, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abbycross commented Mar 11, 2026

Uh oh!

abbycross commented Mar 11, 2026

Uh oh!

jyu00 commented Mar 12, 2026

Uh oh!

abbycross commented Mar 12, 2026

Uh oh!

abbycross commented Mar 12, 2026

Uh oh!

qiskit-bot commented Mar 13, 2026

Uh oh!

abbycross commented Mar 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

abbycross commented Mar 10, 2026 •

edited

Loading