Skip to content

Update run-jobs-batch.mdx to be more explicit about the wording #3031

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update run-jobs-batch.mdx to be more explicit about the wording #3031

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/guides/run-jobs-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ service = QiskitRuntimeService()

## Open a batch

You can open a runtime batch by using the context manager `with Batch(...)` or by initializing the `Batch`
class. When you start a batch, you must specify a QPU by passing a `backend` object. The batch starts when its first job begins execution.
You can open a runtime batch by using the context manager `with <Batch instance>` or by passing a `Batch` instance to the parameter `mode=` of the primitive.
When you start a batch, you must specify a QPU by passing a `backend` object. The batch starts when its first job begins execution.


**Batch class**
Expand Down Expand Up @@ -152,4 +152,4 @@ with Batch(backend=backend):
- Try an example in the [Combine error mitigation options with the estimator primitive](https://learning.quantum.ibm.com/tutorial/combine-error-mitigation-options-with-the-estimator-primitive) tutorial.
- Review the [Batch API](/docs/api/qiskit-ibm-runtime/batch#batch) reference.
- Understand the [Job limits](/docs/guides/job-limits) when sending a job to an IBM QPU.
</Admonition>
</Admonition>