From 984b0de289f3d62efbaf777c316b0bea8608ece1 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:42:45 -0500 Subject: [PATCH 01/20] Refactor: make new prefix generic --- scripts/lib/api/updateLinks.ts | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/scripts/lib/api/updateLinks.ts b/scripts/lib/api/updateLinks.ts index 7a85a4fe533..705866891c4 100644 --- a/scripts/lib/api/updateLinks.ts +++ b/scripts/lib/api/updateLinks.ts @@ -100,23 +100,26 @@ export function normalizeUrl( } export function relativizeLink(link: Link): Link | undefined { - const prefixes = [ - "https://qiskit.org/documentation/apidoc/", - "https://qiskit.org/documentation/stubs/", - ]; - const prefix = prefixes.find((prefix) => link.url.startsWith(prefix)); - if (!prefix) { + const priorPrefixToNewPrefix = new Map([ + ["https://qiskit.org/documentation/apidoc/", "/api/qiskit"], + ["https://qiskit.org/documentation/stubs/", "/api/qiskit"], + ]); + const priorPrefix = Array.from(priorPrefixToNewPrefix.keys()).find((prefix) => + link.url.startsWith(prefix), + ); + if (!priorPrefix) { return; } let [url, anchor] = link.url.split("#"); - url = removePrefix(url, prefix); + url = removePrefix(url, priorPrefix); url = removeSuffix(url, ".html"); if (anchor && anchor !== url) { url = `${url}#${anchor}`; } const newText = link.url === link.text ? url : undefined; - return { url: `/api/qiskit/${url}`, text: newText }; + const newPrefix = priorPrefixToNewPrefix.get(priorPrefix)!; + return { url: `${newPrefix}/${url}`, text: newText }; } export async function updateLinks( From 762c4857161b438973d950d9de3aa948e7ed4d22 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:55:36 -0500 Subject: [PATCH 02/20] Relativize ibm.com links --- scripts/lib/api/updateLinks.test.ts | 10 +++++++++- scripts/lib/api/updateLinks.ts | 2 ++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/scripts/lib/api/updateLinks.test.ts b/scripts/lib/api/updateLinks.test.ts index a70bd47ad8f..26554d90038 100644 --- a/scripts/lib/api/updateLinks.test.ts +++ b/scripts/lib/api/updateLinks.test.ts @@ -212,7 +212,15 @@ describe("relativizeLink()", () => { "https://qiskit.org/documentation/apidoc/qiskit.circuit.BreakLoopOp.html#qiskit.circuit.BreakLoopOp", "/api/qiskit/qiskit.circuit.BreakLoopOp", ], - ])("transform qiskit.org Qiskit API links", (input, expected) => { + ])("relativize qiskit.org Qiskit API links", (input, expected) => { + expect(relativizeLink({ url: input })).toEqual({ url: expected }); + }); + + test.each([ + ["https://docs.quantum.ibm.com/run", "/run"], + ["https://docs.quantum.ibm.com/api/qiskit/utils", "/api/qiskit/utils"], + ["https://docs.quantum-computing.ibm.com/run", "/run"], + ])("relativize docs.quantum.ibm.com links", (input, expected) => { expect(relativizeLink({ url: input })).toEqual({ url: expected }); }); diff --git a/scripts/lib/api/updateLinks.ts b/scripts/lib/api/updateLinks.ts index 705866891c4..f543604b215 100644 --- a/scripts/lib/api/updateLinks.ts +++ b/scripts/lib/api/updateLinks.ts @@ -103,6 +103,8 @@ export function relativizeLink(link: Link): Link | undefined { const priorPrefixToNewPrefix = new Map([ ["https://qiskit.org/documentation/apidoc/", "/api/qiskit"], ["https://qiskit.org/documentation/stubs/", "/api/qiskit"], + ["https://docs.quantum.ibm.com/", ""], + ["https://docs.quantum-computing.ibm.com/", ""], ]); const priorPrefix = Array.from(priorPrefixToNewPrefix.keys()).find((prefix) => link.url.startsWith(prefix), From 5d9196018ec992556a89e4ff03b20b4b58bf0998 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:56:49 -0500 Subject: [PATCH 03/20] Regenerate qiskit-ibm-provider 0.9.0 --- docs/api/qiskit-ibm-provider/0.9/_toc.json | 1 - .../0.9/qiskit_ibm_provider.IBMBackend.md | 42 +++++++++---------- .../qiskit_ibm_provider.IBMBackendService.md | 2 +- .../qiskit_ibm_provider.job.IBMCircuitJob.md | 14 +++---- ...qiskit_ibm_provider.job.IBMCompositeJob.md | 14 +++---- .../0.9/qiskit_ibm_provider.least_busy.md | 4 +- ....passes.scheduling.ALAPScheduleAnalysis.md | 12 +++--- ....passes.scheduling.ASAPScheduleAnalysis.md | 14 +++---- ...piler.passes.scheduling.BlockBasePadder.md | 10 ++--- ...ling.DynamicCircuitInstructionDurations.md | 8 ++-- ...r.transpiler.passes.scheduling.PadDelay.md | 10 ++--- ...asses.scheduling.PadDynamicalDecoupling.md | 16 +++---- ...m_provider.transpiler.passes.scheduling.md | 8 ++-- 13 files changed, 77 insertions(+), 78 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/0.9/_toc.json b/docs/api/qiskit-ibm-provider/0.9/_toc.json index 8ed0a1b795c..1f157240e56 100644 --- a/docs/api/qiskit-ibm-provider/0.9/_toc.json +++ b/docs/api/qiskit-ibm-provider/0.9/_toc.json @@ -211,4 +211,3 @@ ], "collapsed": true } - diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md index 48b2131f757..e8fc8662310 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend Backend class interfacing with an IBM Quantum device. -You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: +You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: ```python from qiskit import transpile @@ -34,7 +34,7 @@ retrieved_job = provider.backend.retrieve_job(job.job_id()) * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") instance to retrieve and handle backends. -Other methods return information about the backend. For example, the [`status()`](#qiskit_ibm_provider.IBMBackend.status "qiskit_ibm_provider.IBMBackend.status") method returns a [`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: +Other methods return information about the backend. For example, the [`status()`](#qiskit_ibm_provider.IBMBackend.status "qiskit_ibm_provider.IBMBackend.status") method returns a [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: ```python status = backend.status() @@ -50,7 +50,7 @@ jobs_in_queue = status.pending_jobs * num\_qubits: number of qubits. -* target: A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. +* target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. * basis\_gates: list of basis gates names on the backend. @@ -144,7 +144,7 @@ IBMBackend constructor. **Parameters** -* **configuration** (`Union`\[[`QasmBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v0.46)"), [`PulseBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v0.46)")]) – Backend configuration. +* **configuration** (`Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v0.46)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v0.46)")]) – Backend configuration. * **provider** ([`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.ibm_provider.IBMProvider")) – IBM Quantum account provider. * **api\_client** (`AccountClient`) – IBM Quantum client used to communicate with the server. @@ -154,7 +154,7 @@ IBMBackend constructor. ### coupling\_map -Return the [`CouplingMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v0.46)") object +Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v0.46)") object @@ -188,13 +188,13 @@ Return the system time resolution of output signals :returns: The output signal ### instruction\_durations -Return the [`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)") object. +Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)") object. ### instruction\_schedule\_map -Return the [`InstructionScheduleMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v0.46)") for the instructions defined in this backend’s target. +Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v0.46)") for the instructions defined in this backend’s target. @@ -204,7 +204,7 @@ A list of Instruction tuples on the backend of the form `(instruction, (qubits)` **Return type** -`List`\[`Tuple`\[[`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)"), `Tuple`\[`int`]]] +`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)"), `Tuple`\[`int`]]] @@ -246,11 +246,11 @@ A list of instruction names that the backend supports. ### operations -A list of [`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)") instances that the backend supports. +A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)") instances that the backend supports. **Return type** -`List`\[[`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)")] +`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)")] @@ -288,7 +288,7 @@ Return session ### target -A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. :rtype: [`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") :returns: Target +A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") :returns: Target @@ -376,7 +376,7 @@ The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas **Return type** -`Union`\[[`QasmBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v0.46)"), [`PulseBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v0.46)")] +`Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v0.46)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v0.46)")] **Returns** @@ -420,7 +420,7 @@ The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-s **Return type** -`Optional`\[[`PulseDefaults`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseDefaults "(in Qiskit v0.46)")] +`Optional`\[[`PulseDefaults`](/api/qiskit/qiskit.providers.models.PulseDefaults "(in Qiskit v0.46)")] **Returns** @@ -497,11 +497,11 @@ The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas](h **Parameters** * **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. -* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)") whose timestamp is closest to, but older than, the specified datetime. +* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)") whose timestamp is closest to, but older than, the specified datetime. **Return type** -`Optional`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")] +`Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")] **Returns** @@ -527,7 +527,7 @@ If there are no defined or the backend doesn’t support querying these details **Return type** -`Union`\[[`QubitProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v0.46)"), `List`\[[`QubitProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v0.46)")]] +`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v0.46)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v0.46)")]] **Returns** @@ -547,13 +547,13 @@ Run on the backend. If a keyword specified here is also present in the `options` **Parameters** -* **circuits** (`Union`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)"), `str`]]]) – An individual or a list of `QuantumCircuit`. +* **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)"), `str`]]]) – An individual or a list of `QuantumCircuit`. * **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals) * **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. -* **init\_circuit** (`Optional`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. +* **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. * **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution. @@ -639,12 +639,12 @@ This method is used to update the options of a backend. If you need to change an Return the backend status. - If the returned [`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. + If the returned [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. **Return type** -[`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") +[`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v0.46)") **Returns** @@ -660,5 +660,5 @@ The status of the backend. `target_history(datetime=None)` -A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. :rtype: [`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") :returns: Target with properties found on datetime +A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)") :returns: Target with properties found on datetime diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md index 2d60c1a1111..ca99c6b0fc8 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md @@ -114,7 +114,7 @@ Retrieve jobs that match the given filters and paginate the results if desired. * **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. Note that the number of sub-jobs within a composite job count towards the limit. * **skip** (`int`) – Starting index for the job retrieval. * **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from. -* **status** (`Union`\[`Literal`\[‘pending’, ‘completed’], `List`\[`Union`\[[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)"), `str`]], [`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)"), `str`, `None`]) – Filter jobs with either “pending” or “completed” status. You can also specify by +* **status** (`Union`\[`Literal`\[‘pending’, ‘completed’], `List`\[`Union`\[[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)"), `str`]], [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)"), `str`, `None`]) – Filter jobs with either “pending” or “completed” status. You can also specify by * **example** (*exact status. For*) – or status=\[“RUNNING”, “ERROR”]. * **status="RUNNING"** (*status=JobStatus.RUNNING or*) – or status=\[“RUNNING”, “ERROR”]. * **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md index f6624d1536b..5b7818816ce 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -16,7 +16,7 @@ Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. -If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_provider.job.IBMCircuitJob.status "qiskit_ibm_provider.job.IBMCircuitJob.status"). Job status can be one of the [`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") members. For example: +If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_provider.job.IBMCircuitJob.status "qiskit_ibm_provider.job.IBMCircuitJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") members. For example: ```python from qiskit.providers.jobstatus import JobStatus @@ -119,7 +119,7 @@ Return the backend where this job was executed. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") ### backend\_options @@ -186,7 +186,7 @@ Return the circuits for this job. **Return type** -`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")] +`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")] **Returns** @@ -310,7 +310,7 @@ Return the backend properties for this job. **Return type** -`Optional`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")] +`Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")] **Returns** @@ -395,7 +395,7 @@ Return the result of the job. - When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") instance can be used to verify whether it contains partial results. + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") instance can be used to verify whether it contains partial results. For example, if one of the experiments in the job failed, trying to get the counts of the unsuccessful experiment would raise an exception since there are no counts to return: @@ -416,7 +416,7 @@ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMC **Return type** -[`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") +[`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") **Returns** @@ -474,7 +474,7 @@ Query the server for the latest job status. **Return type** -[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") +[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md index 8632ee836ce..7c521bf3b31 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -35,7 +35,7 @@ IBMCompositeJob constructor. * **job\_id** (`Optional`\[`str`]) – Job ID. * **creation\_date** (`Optional`\[`datetime`]) – Job creation date. * **jobs** (`Optional`\[`List`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]]) – A list of sub-jobs. -* **circuits\_list** (`Optional`\[`List`\[`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")]]]) – Circuits for this job. +* **circuits\_list** (`Optional`\[`List`\[`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")]]]) – Circuits for this job. * **run\_config** (`Optional`\[`Dict`]) – Runtime configuration for this job. * **name** (`Optional`\[`str`]) – Job name. * **tags** (`Optional`\[`List`\[`str`]]) – Job tags. @@ -81,7 +81,7 @@ Return the backend where this job was executed. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") ### backend\_options @@ -159,7 +159,7 @@ Return the circuits for this job. **Return type** -`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")] +`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v0.46)")] **Returns** @@ -313,7 +313,7 @@ Return the backend properties for this job. **Return type** -`Union`\[`List`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")], [`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)"), `None`] +`Union`\[`List`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)")], [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v0.46)"), `None`] **Returns** @@ -446,7 +446,7 @@ Return the result of the job. - When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") instance can be used to verify whether it contains partial results. + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") instance can be used to verify whether it contains partial results. For example, if one of the circuits in the job failed, trying to get the counts of the unsuccessful circuit would raise an exception since there are no counts to return: @@ -469,7 +469,7 @@ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMC **Return type** -[`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") +[`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v0.46)") **Returns** @@ -545,7 +545,7 @@ Query the server for the latest job status. **Return type** -[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") +[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md index 65377baeb08..5a44a82387c 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md @@ -20,11 +20,11 @@ Return the least busy available backend for those that have a `pending_jobs` in **Parameters** -**backends** (`List`\[[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)")]) – The backends to choose from. +**backends** (`List`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)")]) – The backends to choose from. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 72f612ad7ad..2aa349abcb2 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -32,7 +32,7 @@ Scheduler for dynamic circuit backends. **Parameters** -**durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. +**durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. ## Attributes @@ -86,12 +86,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] **Returns** @@ -115,7 +115,7 @@ Name of the pass. `run(dag)` -Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") :param dag: DAG to schedule. :type dag: DAGCircuit +Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** @@ -140,12 +140,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 56684c1214e..4f3780c1431 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -32,7 +32,7 @@ Scheduler for dynamic circuit backends. **Parameters** -**durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. +**durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. ## Attributes @@ -86,12 +86,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] **Returns** @@ -115,7 +115,7 @@ Name of the pass. `run(dag)` -Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") :param dag: DAG to schedule. :type dag: DAGCircuit +Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** @@ -124,7 +124,7 @@ Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum **Return type** -[`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") +[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)") **Returns** @@ -140,12 +140,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index c226ef6d19f..b4559faff87 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -77,12 +77,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] **Returns** @@ -110,7 +110,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. **Returns** @@ -134,12 +134,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 8361388a793..cd306c0fdf4 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -42,7 +42,7 @@ Construct a `DynamicInstructionDurations` object from the backend. **Parameters** -**backend** ([`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)")) – backend from which durations (gate lengths) and dt are extracted. +**backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v0.46)")) – backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -62,7 +62,7 @@ Construct a `DynamicInstructionDurations` object from the target. **Parameters** -**target** ([`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)")) – target from which durations (gate lengths) and dt are extracted. +**target** ([`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.46)")) – target from which durations (gate lengths) and dt are extracted. **Returns** @@ -84,7 +84,7 @@ Some instructions may have a parameter dependent duration. **Parameters** -* **inst** (*str |* [*qiskit.circuit.Instruction*](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)")) – An instruction or its name to be queried. +* **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.46)")) – An instruction or its name to be queried. * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. @@ -127,7 +127,7 @@ Update self with inst\_durations (inst\_durations overwrite self). Overrides the **Parameters** -* **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)"), `None`]) – Instruction durations to be merged into self (overwriting self). +* **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)"), `None`]) – Instruction durations to be merged into self (overwriting self). * **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend. **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index 8f9ce86c6f2..6cce524e135 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -89,12 +89,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] **Returns** @@ -122,7 +122,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. **Returns** @@ -146,12 +146,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 117c1d0327c..348e6362220 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -137,9 +137,9 @@ Dynamical decoupling initializer. **Parameters** -* **durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. +* **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v0.46)")) – Durations of instructions to be used in scheduling. -* **dd\_sequences** (`Union`\[`List`\[[`Gate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Gate "(in Qiskit v0.46)")], `List`\[`List`\[[`Gate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Gate "(in Qiskit v0.46)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. +* **dd\_sequences** (`Union`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v0.46)")], `List`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v0.46)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. * **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). @@ -160,7 +160,7 @@ Dynamical decoupling initializer. * **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay. -* **coupling\_map** (`Optional`\[[`CouplingMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v0.46)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. +* **coupling\_map** (`Optional`\[[`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v0.46)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. * **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0]. @@ -224,12 +224,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")] **Returns** @@ -257,7 +257,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.46)")) – DAG to be checked. **Returns** @@ -281,12 +281,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v0.46)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md index 8b2a3752d21..46db6e517bd 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md @@ -21,7 +21,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. - You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)") or [`generate_preset_pass_manager()`](https://docs.quantum.ibm.com/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v0.46)"). + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v0.46)"). Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model: @@ -106,7 +106,7 @@ dd_teleport.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling_2_0.png) -When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)") function internally builds its pass set by using [`generate_preset_pass_manager()`](https://docs.quantum.ibm.com/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v0.46)"). This returns instances of [`StagedPassManager`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v0.46)"), which can be extended. +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v0.46)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v0.46)"), which can be extended. @@ -122,7 +122,7 @@ qc_c_if.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling_3_0.png) -The [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. +The [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v0.46)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. ```python # Temporary workaround for mock backends. For real backends this is not required. @@ -142,7 +142,7 @@ qc_if_dd.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling_4_0.png) -If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v0.46)") prior to your scheduling pass. +If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v0.46)") prior to your scheduling pass. ```python from qiskit.transpiler.passes import ConvertConditionsToIfOps From ea9c2fc56c01b5295725c3c8d18bf429790d182a Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:56:52 -0500 Subject: [PATCH 04/20] Regenerate qiskit-ibm-provider 0.10.0 --- .../qiskit_ibm_provider.IBMBackend.md | 42 +++++++++---------- .../qiskit_ibm_provider.IBMBackendService.md | 4 +- .../qiskit_ibm_provider.IBMProvider.md | 2 +- .../qiskit_ibm_provider.Session.md | 2 +- .../qiskit_ibm_provider.job.IBMCircuitJob.md | 14 +++---- ...qiskit_ibm_provider.job.IBMCompositeJob.md | 14 +++---- .../qiskit_ibm_provider.least_busy.md | 4 +- ....passes.scheduling.ALAPScheduleAnalysis.md | 12 +++--- ....passes.scheduling.ASAPScheduleAnalysis.md | 14 +++---- ...piler.passes.scheduling.BlockBasePadder.md | 10 ++--- ...ling.DynamicCircuitInstructionDurations.md | 8 ++-- ...r.transpiler.passes.scheduling.PadDelay.md | 10 ++--- ...asses.scheduling.PadDynamicalDecoupling.md | 16 +++---- ...m_provider.transpiler.passes.scheduling.md | 8 ++-- docs/api/qiskit-ibm-provider/release-notes.md | 16 +++---- 15 files changed, 88 insertions(+), 88 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md index 89de154268f..3ebc950f9c6 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend Backend class interfacing with an IBM Quantum device. -You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: +You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: ```python from qiskit import transpile @@ -34,7 +34,7 @@ retrieved_job = provider.backend.retrieve_job(job.job_id()) * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") instance to retrieve and handle backends. -Other methods return information about the backend. For example, the [`status()`](#qiskit_ibm_provider.IBMBackend.status "qiskit_ibm_provider.IBMBackend.status") method returns a [`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: +Other methods return information about the backend. For example, the [`status()`](#qiskit_ibm_provider.IBMBackend.status "qiskit_ibm_provider.IBMBackend.status") method returns a [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: ```python status = backend.status() @@ -50,7 +50,7 @@ jobs_in_queue = status.pending_jobs * num\_qubits: number of qubits. -* target: A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. +* target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. * basis\_gates: list of basis gates names on the backend. @@ -144,7 +144,7 @@ IBMBackend constructor. **Parameters** -* **configuration** (`Union`\[[`QasmBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")]) – Backend configuration. +* **configuration** (`Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")]) – Backend configuration. * **provider** ([`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.ibm_provider.IBMProvider")) – IBM Quantum account provider. * **api\_client** (`AccountClient`) – IBM Quantum client used to communicate with the server. @@ -154,7 +154,7 @@ IBMBackend constructor. ### coupling\_map -Return the [`CouplingMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)") object +Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)") object @@ -188,13 +188,13 @@ Return the system time resolution of output signals :returns: The output signal ### instruction\_durations -Return the [`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)") object. +Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)") object. ### instruction\_schedule\_map -Return the [`InstructionScheduleMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.0)") for the instructions defined in this backend’s target. +Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.0)") for the instructions defined in this backend’s target. @@ -204,7 +204,7 @@ A list of Instruction tuples on the backend of the form `(instruction, (qubits)` **Return type** -`List`\[`Tuple`\[[`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)"), `Tuple`\[`int`]]] +`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)"), `Tuple`\[`int`]]] @@ -246,11 +246,11 @@ A list of instruction names that the backend supports. ### operations -A list of [`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)") instances that the backend supports. +A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)") instances that the backend supports. **Return type** -`List`\[[`Instruction`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")] +`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")] @@ -288,7 +288,7 @@ Return session ### target -A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target +A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target @@ -376,7 +376,7 @@ The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas **Return type** -`Union`\[[`QasmBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")] +`Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")] **Returns** @@ -420,7 +420,7 @@ The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-s **Return type** -`Optional`\[[`PulseDefaults`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.PulseDefaults "(in Qiskit v1.0)")] +`Optional`\[[`PulseDefaults`](/api/qiskit/qiskit.providers.models.PulseDefaults "(in Qiskit v1.0)")] **Returns** @@ -497,11 +497,11 @@ The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas](h **Parameters** * **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. -* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)") whose timestamp is closest to, but older than, the specified datetime. +* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)") whose timestamp is closest to, but older than, the specified datetime. **Return type** -`Optional`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")] +`Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")] **Returns** @@ -527,7 +527,7 @@ If there are no defined or the backend doesn’t support querying these details **Return type** -`Union`\[[`QubitProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)"), `List`\[[`QubitProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)")]] +`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)")]] **Returns** @@ -547,13 +547,13 @@ Run on the backend. If a keyword specified here is also present in the `options` **Parameters** -* **circuits** (`Union`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`]]]) – An individual or a list of `QuantumCircuit`. +* **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`]]]) – An individual or a list of `QuantumCircuit`. * **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals) * **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. -* **init\_circuit** (`Optional`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. +* **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. * **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution. @@ -639,12 +639,12 @@ This method is used to update the options of a backend. If you need to change an Return the backend status. - If the returned [`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. + If the returned [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. **Return type** -[`BackendStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") +[`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") **Returns** @@ -660,5 +660,5 @@ The status of the backend. `target_history(datetime=None)` -A [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target with properties found on datetime +A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target with properties found on datetime diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md index fcfc0c18a84..beb8d5b4c0d 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md @@ -84,7 +84,7 @@ Return all backends accessible via this account, subject to optional filtering. IBMProvider.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** @@ -114,7 +114,7 @@ Retrieve jobs that match the given filters and paginate the results if desired. * **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. Note that the number of sub-jobs within a composite job count towards the limit. * **skip** (`int`) – Starting index for the job retrieval. * **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from. -* **status** (`Union`\[`Literal`\[‘pending’, ‘completed’], `List`\[`Union`\[[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`]], [`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`, `None`]) – Filter jobs with either “pending” or “completed” status. You can also specify by +* **status** (`Union`\[`Literal`\[‘pending’, ‘completed’], `List`\[`Union`\[[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`]], [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`, `None`]) – Filter jobs with either “pending” or “completed” status. You can also specify by * **example** (*exact status. For*) – or status=\[“RUNNING”, “ERROR”]. * **status="RUNNING"** (*status=JobStatus.RUNNING or*) – or status=\[“RUNNING”, “ERROR”]. * **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md index c1a6144e582..35a71cc0945 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md @@ -187,7 +187,7 @@ Return all backends accessible via this account, subject to optional filtering. IBMProvider.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md index e811f828324..f65d69a573b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md @@ -40,7 +40,7 @@ Session constructor. **Parameters** -**max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be in between 300 seconds and the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +**max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be in between 300 seconds and the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md index 267c214df04..76e468acd0d 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -16,7 +16,7 @@ Representation of a job that executes on an IBM Quantum backend. The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend. -If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_provider.job.IBMCircuitJob.status "qiskit_ibm_provider.job.IBMCircuitJob.status"). Job status can be one of the [`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") members. For example: +If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_provider.job.IBMCircuitJob.status "qiskit_ibm_provider.job.IBMCircuitJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") members. For example: ```python from qiskit.providers.jobstatus import JobStatus @@ -119,7 +119,7 @@ Return the backend where this job was executed. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") ### backend\_options @@ -186,7 +186,7 @@ Return the circuits for this job. **Return type** -`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")] +`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")] **Returns** @@ -310,7 +310,7 @@ Return the backend properties for this job. **Return type** -`Optional`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")] +`Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")] **Returns** @@ -395,7 +395,7 @@ Return the result of the job. - When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results. + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results. For example, if one of the experiments in the job failed, trying to get the counts of the unsuccessful experiment would raise an exception since there are no counts to return: @@ -416,7 +416,7 @@ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMC **Return type** -[`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") +[`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") **Returns** @@ -474,7 +474,7 @@ Query the server for the latest job status. **Return type** -[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") +[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md index b5b689e3ccb..a1e2fa9c2ff 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -35,7 +35,7 @@ IBMCompositeJob constructor. * **job\_id** (`Optional`\[`str`]) – Job ID. * **creation\_date** (`Optional`\[`datetime`]) – Job creation date. * **jobs** (`Optional`\[`List`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]]) – A list of sub-jobs. -* **circuits\_list** (`Optional`\[`List`\[`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]]]) – Circuits for this job. +* **circuits\_list** (`Optional`\[`List`\[`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]]]) – Circuits for this job. * **run\_config** (`Optional`\[`Dict`]) – Runtime configuration for this job. * **name** (`Optional`\[`str`]) – Job name. * **tags** (`Optional`\[`List`\[`str`]]) – Job tags. @@ -81,7 +81,7 @@ Return the backend where this job was executed. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") ### backend\_options @@ -159,7 +159,7 @@ Return the circuits for this job. **Return type** -`List`\[[`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")] +`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")] **Returns** @@ -313,7 +313,7 @@ Return the backend properties for this job. **Return type** -`Union`\[`List`\[[`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")], [`BackendProperties`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)"), `None`] +`Union`\[`List`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")], [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)"), `None`] **Returns** @@ -446,7 +446,7 @@ Return the result of the job. - When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results. + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results. For example, if one of the circuits in the job failed, trying to get the counts of the unsuccessful circuit would raise an exception since there are no counts to return: @@ -469,7 +469,7 @@ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMC **Return type** -[`Result`](https://docs.quantum.ibm.com/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") +[`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") **Returns** @@ -545,7 +545,7 @@ Query the server for the latest job status. **Return type** -[`JobStatus`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") +[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md index 8c375041a8f..95d2f70ec7b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md @@ -20,11 +20,11 @@ Return the least busy available backend for those that have a `pending_jobs` in **Parameters** -**backends** (`List`\[[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")]) – The backends to choose from. +**backends** (`List`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")]) – The backends to choose from. **Return type** -[`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") +[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index cc81c6bd391..d310cf01352 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -32,7 +32,7 @@ Scheduler for dynamic circuit backends. **Parameters** -**durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. +**durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. ## Attributes @@ -86,12 +86,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] **Returns** @@ -115,7 +115,7 @@ Name of the pass. `run(dag)` -Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit +Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** @@ -140,12 +140,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 5bd868e9ea0..1823f6e88ef 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -32,7 +32,7 @@ Scheduler for dynamic circuit backends. **Parameters** -**durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. +**durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. ## Attributes @@ -86,12 +86,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] **Returns** @@ -115,7 +115,7 @@ Name of the pass. `run(dag)` -Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit +Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** @@ -124,7 +124,7 @@ Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](https://docs.quantum **Return type** -[`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") +[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") **Returns** @@ -140,12 +140,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index 172b219abfb..4d8bce7b64c 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -77,12 +77,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] **Returns** @@ -110,7 +110,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. **Returns** @@ -134,12 +134,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 06276ec3d70..1cf385e1c36 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -42,7 +42,7 @@ Construct a `DynamicInstructionDurations` object from the backend. **Parameters** -**backend** ([`Backend`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")) – backend from which durations (gate lengths) and dt are extracted. +**backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")) – backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -62,7 +62,7 @@ Construct a `DynamicInstructionDurations` object from the target. **Parameters** -**target** ([`Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)")) – target from which durations (gate lengths) and dt are extracted. +**target** ([`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)")) – target from which durations (gate lengths) and dt are extracted. **Returns** @@ -84,7 +84,7 @@ Some instructions may have a parameter dependent duration. **Parameters** -* **inst** (*str |* [*qiskit.circuit.Instruction*](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")) – An instruction or its name to be queried. +* **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")) – An instruction or its name to be queried. * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. @@ -127,7 +127,7 @@ Update self with inst\_durations (inst\_durations overwrite self). Overrides the **Parameters** -* **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)"), `None`]) – Instruction durations to be merged into self (overwriting self). +* **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)"), `None`]) – Instruction durations to be merged into self (overwriting self). * **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend. **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index 1ecb9823b73..8d6bde8e250 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -89,12 +89,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] **Returns** @@ -122,7 +122,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. **Returns** @@ -146,12 +146,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index b12b757aff1..e53ece63452 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -137,9 +137,9 @@ Dynamical decoupling initializer. **Parameters** -* **durations** ([`InstructionDurations`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. +* **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling. -* **dd\_sequences** (`Union`\[`List`\[[`Gate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")], `List`\[`List`\[[`Gate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. +* **dd\_sequences** (`Union`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")], `List`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. * **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). @@ -160,7 +160,7 @@ Dynamical decoupling initializer. * **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay. -* **coupling\_map** (`Optional`\[[`CouplingMap`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. +* **coupling\_map** (`Optional`\[[`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. * **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0]. @@ -224,12 +224,12 @@ Execute optimization task for input Qiskit IR. **Parameters** * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself. * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. **Return type** -`tuple`\[`Any`, [`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] +`tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")] **Returns** @@ -257,7 +257,7 @@ Run the padding pass on `dag`. **Parameters** -**dag** ([`DAGCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. +**dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked. **Returns** @@ -281,12 +281,12 @@ Update workflow status. **Parameters** -* **state** ([`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. +* **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update. * **run\_state** (`RunState`) – Completion status of current task. **Return type** -[`PassManagerState`](https://docs.quantum.ibm.com/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") +[`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)") **Returns** diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md index 723bee371be..fe9b37e3b68 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md @@ -21,7 +21,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. - You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") or [`generate_preset_pass_manager()`](https://docs.quantum.ibm.com/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)"). + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)"). Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model: @@ -106,7 +106,7 @@ dd_teleport.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling_2_0.png) -When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") function internally builds its pass set by using [`generate_preset_pass_manager()`](https://docs.quantum.ibm.com/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)"). This returns instances of [`StagedPassManager`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.0)"), which can be extended. +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.0)"), which can be extended. @@ -122,7 +122,7 @@ qc_c_if.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling_3_0.png) -The [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](https://docs.quantum.ibm.com/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. +The [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. ```python # Temporary workaround for mock backends. For real backends this is not required. @@ -142,7 +142,7 @@ qc_if_dd.draw(output="mpl", style="iqp") ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling_4_0.png) -If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.0)") prior to your scheduling pass. +If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.0)") prior to your scheduling pass. ```python from qiskit.transpiler.passes import ConvertConditionsToIfOps diff --git a/docs/api/qiskit-ibm-provider/release-notes.md b/docs/api/qiskit-ibm-provider/release-notes.md index 85305840ed7..0959cbb273a 100644 --- a/docs/api/qiskit-ibm-provider/release-notes.md +++ b/docs/api/qiskit-ibm-provider/release-notes.md @@ -80,7 +80,7 @@ in_page_toc_max_heading_level: 2 * Fixes a bug in the function `jobs()`. Refer to [#586](https://github.com/Qiskit/qiskit-ibm-provider/issues/586) for more details. -* A transpilation error will no longer occur when attempting to transpile a circuit containing a conditional [`IGate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.0)") with Qiskit 0.44. +* A transpilation error will no longer occur when attempting to transpile a circuit containing a conditional [`IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.0)") with Qiskit 0.44. * 2pi wrapping cannot be applied on a parameterized global phase. Use the DAGCircuit `global_phase` setter to wrap the phase for floats only. @@ -166,7 +166,7 @@ in_page_toc_max_heading_level: 2 ### Deprecation Notes -* Removed support for input circuit as Schedule to IBMBackend.run(). Use `pulse gates` instead. See [here](https://docs.quantum.ibm.com/build/pulse) for how to use pulse gates. +* Removed support for input circuit as Schedule to IBMBackend.run(). Use `pulse gates` instead. See [here](/build/pulse) for how to use pulse gates. @@ -194,7 +194,7 @@ in_page_toc_max_heading_level: 2 * If the `dynamic` parameter is set to `True` in [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") and the backend being used does not support dymamic circuits, a warning will be raised. -* When constructing a backend [`qiskit.transpiler.Target`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)"), faulty qubits and gates from the backend configuration will be filtered out. +* When constructing a backend [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)"), faulty qubits and gates from the backend configuration will be filtered out. @@ -343,7 +343,7 @@ in_page_toc_max_heading_level: 2 ### Upgrade Notes -* Scheduling support for `c_if` has been removed. Please run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.0)") on your circuit before scheduling to convert all old format `c_if` statements to new format `if_test` control-flow that may be scheduled. +* Scheduling support for `c_if` has been removed. Please run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.0)") on your circuit before scheduling to convert all old format `c_if` statements to new format `if_test` control-flow that may be scheduled. ```python from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister @@ -415,7 +415,7 @@ in_page_toc_max_heading_level: 2 * The meth:\~qiskit\_ibm\_provider.IBMProvider.instances was added to list all the available instances in a provider instance. -* A new transpiler pass ``qiskit_ibm_provider.transpiler.passes.basis.ConvertIdToDelay was added which converts an :class:`qiskit.circuit.library.IGate`` to [`qiskit.circuit.Delay`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Delay "(in Qiskit v1.0)"). This was added to the default transpiler plugin `qiskit_ibm_provider.transpiler.plugin.IBMTranslationPlugin`. +* A new transpiler pass ``qiskit_ibm_provider.transpiler.passes.basis.ConvertIdToDelay was added which converts an :class:`qiskit.circuit.library.IGate`` to [`qiskit.circuit.Delay`](/api/qiskit/qiskit.circuit.Delay "(in Qiskit v1.0)"). This was added to the default transpiler plugin `qiskit_ibm_provider.transpiler.plugin.IBMTranslationPlugin`. @@ -433,7 +433,7 @@ in_page_toc_max_heading_level: 2 * A bug was fixed in `qiskit.transpiler.passes.scheduling.LAPScheduleAnalysis` which was caused by an bad interaction between duration-less gates such as `rz` and `barrier`. -* A bug was fixed where conditional [`qiskit.circuit.library.IGate`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.0)") were being converted to unconditional [`qiskit.circuit.Delay`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.Delay "(in Qiskit v1.0)") operations rather than conditional operations. +* A bug was fixed where conditional [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.0)") were being converted to unconditional [`qiskit.circuit.Delay`](/api/qiskit/qiskit.circuit.Delay "(in Qiskit v1.0)") operations rather than conditional operations. * Fixed an issue where filtering by instance with [`jobs()`](qiskit_ibm_provider.IBMBackendService#jobs "qiskit_ibm_provider.IBMBackendService.jobs") was not working correctly. @@ -607,7 +607,7 @@ qiskit-ibm-provider is a new Python API client for accessing the quantum systems provider.active_account() # check active account ``` -* [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") class now implements the [`qiskit.providers.BackendV2`](https://docs.quantum.ibm.com/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.0)") interface and provides flatter access to the configuration of a backend, for example: +* [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") class now implements the [`qiskit.providers.BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.0)") interface and provides flatter access to the configuration of a backend, for example: ```python # BackendV1: @@ -672,7 +672,7 @@ qiskit-ibm-provider is a new Python API client for accessing the quantum systems * qiskit.providers.ibmq.IBMQBackend.retrieve\_job() and qiskit.providers.ibmq.IBMQBackend.jobs() have been removed. The IBMBackendService methods `job()` and [`jobs()`](qiskit_ibm_provider.IBMBackendService#jobs "qiskit_ibm_provider.IBMBackendService.jobs") can be used instead. -* Passing a [`QasmQobj`](https://docs.quantum.ibm.com/api/qiskit/qiskit.qobj.QasmQobj "(in Qiskit v1.0)") and [`PulseQobj`](https://docs.quantum.ibm.com/api/qiskit/qiskit.qobj.PulseQobj "(in Qiskit v1.0)") in the [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method has been removed. [`QuantumCircuit`](https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and [`Schedule`](https://docs.quantum.ibm.com/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.0)") should now be used instead. +* Passing a [`QasmQobj`](/api/qiskit/qiskit.qobj.QasmQobj "(in Qiskit v1.0)") and [`PulseQobj`](/api/qiskit/qiskit.qobj.PulseQobj "(in Qiskit v1.0)") in the [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method has been removed. [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.0)") should now be used instead. * The db\_filter parameter has been removed from [`jobs()`](qiskit_ibm_provider.IBMBackendService#jobs "qiskit_ibm_provider.IBMBackendService.jobs") due to low adoption. From 7054449e71456e486cc75f3fb7d749b464eeda46 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:25 -0500 Subject: [PATCH 05/20] Regenerate qiskit-ibm-runtime 0.14.0 --- .../0.14/qiskit_ibm_runtime.options.Options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md index b14ff805c58..9b5b24163d6 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md @@ -40,7 +40,7 @@ Options for the primitives. Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum-computing.ibm.com/run/max-execution-time#maximum-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time#maximum-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From 7f292c8c7ef5636d0a14da2effedec1bfdf2e34c Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:27 -0500 Subject: [PATCH 06/20] Regenerate qiskit-ibm-runtime 0.15.0 --- .../0.15/qiskit_ibm_runtime.options.Options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md index 84c686aa63a..6c4a9a207b3 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md @@ -40,7 +40,7 @@ Options for the primitives. Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum-computing.ibm.com/run/max-execution-time#maximum-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time#maximum-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From 8adf97c9b5758c8e472d2dbe94d5f0b57540eb14 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:30 -0500 Subject: [PATCH 07/20] Regenerate qiskit-ibm-runtime 0.16.1 --- .../0.16/qiskit_ibm_runtime.options.Options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md index dd399acff6f..70ed08479db 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md @@ -40,7 +40,7 @@ Options for the primitives. Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum-computing.ibm.com/run/max-execution-time#maximum-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time#maximum-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From a23fe4aa2b4b8852505eb18f247ca3d09c4320c1 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:32 -0500 Subject: [PATCH 08/20] Regenerate qiskit-ibm-runtime 0.17.0 --- .../0.17/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md | 2 +- .../0.17/qiskit_ibm_runtime.options.Options.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md index 85baabeeef1..b435c7fda99 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -213,7 +213,7 @@ Return all backends accessible via this account, subject to optional filtering. QiskitRuntimeService.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md index 95a763498c3..6b601d49289 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md @@ -39,7 +39,7 @@ Session constructor. * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). -* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md index ac6b5fe6fd8..265fcea8d35 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md @@ -34,13 +34,13 @@ Options for the primitives. * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. Only applies to estimator. * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. - Refer to the [Qiskit Runtime documentation](https://docs.quantum.ibm.com/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. * **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum.ibm.com/run/max-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From 75ff9fc8737b43f5e888331a2229d1c60a9f5c45 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:39 -0500 Subject: [PATCH 09/20] Regenerate qiskit-ibm-runtime 0.18.0 --- .../0.18/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md | 2 +- .../0.18/qiskit_ibm_runtime.options.Options.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md index 1f538545ede..bc416469370 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -215,7 +215,7 @@ Return all backends accessible via this account, subject to optional filtering. QiskitRuntimeService.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md index 58abbfd5954..a9557b85c9c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md @@ -39,7 +39,7 @@ Session constructor. * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). -* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md index 1b210194c3b..813eddcfb2c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md @@ -34,13 +34,13 @@ Options for the primitives. * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. Only applies to estimator. * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. - Refer to the [Qiskit Runtime documentation](https://docs.quantum.ibm.com/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. * **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum.ibm.com/run/max-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From e3110a65a9438accb54d915c08b9ffe14ee4a3c8 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:45 -0500 Subject: [PATCH 10/20] Regenerate qiskit-ibm-runtime 0.19.1 --- docs/api/qiskit-ibm-runtime/0.19/_toc.json | 1 - .../0.19/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md | 2 +- .../0.19/qiskit_ibm_runtime.options.Options.md | 4 ++-- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.19/_toc.json b/docs/api/qiskit-ibm-runtime/0.19/_toc.json index 07703157fb4..d9f9d58979a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/_toc.json +++ b/docs/api/qiskit-ibm-runtime/0.19/_toc.json @@ -514,4 +514,3 @@ ], "collapsed": true } - diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md index ab507c51efd..a1539ded35f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -222,7 +222,7 @@ Return all backends accessible via this account, subject to optional filtering. QiskitRuntimeService.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md index 73aacfe3e8c..b06fc8d5749 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md @@ -47,7 +47,7 @@ Session constructor. * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). -* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md index b1070dcd3c8..88ac5fc1d3d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md @@ -34,13 +34,13 @@ Options for the primitives. * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. Only applies to estimator. * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. - Refer to the [Qiskit Runtime documentation](https://docs.quantum.ibm.com/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. * **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum.ibm.com/run/max-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From b58664ec8ec11c46c5306459beb4063f7a1b38fa Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:52 -0500 Subject: [PATCH 11/20] Regenerate qiskit-ibm-runtime 0.20.0 --- .../qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md | 2 +- .../qiskit_ibm_runtime.options.Options.md | 4 ++-- docs/api/qiskit-ibm-runtime/release-notes.md | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md index 16b31184c5c..bd16922bece 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -222,7 +222,7 @@ Return all backends accessible via this account, subject to optional filtering. QiskitRuntimeService.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md index e644850b7de..fd22414709d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md @@ -47,7 +47,7 @@ Session constructor. * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). -* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md index b2271d8d8b8..19d43ed4eaa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md @@ -34,13 +34,13 @@ Options for the primitives. * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. Only applies to estimator. * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. - Refer to the [Qiskit Runtime documentation](https://docs.quantum.ibm.com/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. * **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum.ibm.com/run/max-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. diff --git a/docs/api/qiskit-ibm-runtime/release-notes.md b/docs/api/qiskit-ibm-runtime/release-notes.md index f8a040ea00d..008a3ef3128 100644 --- a/docs/api/qiskit-ibm-runtime/release-notes.md +++ b/docs/api/qiskit-ibm-runtime/release-notes.md @@ -22,7 +22,7 @@ in_page_toc_max_heading_level: 2 * Python 3.12 is now supported. -* Sessions will now be started with a new `/sessions` endpoint that allows for different execution modes. Batch mode is now supported through `Batch`, and [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") will work the same as way as before. Please see [https://docs.quantum.ibm.com/run/sessions](https://docs.quantum.ibm.com/run/sessions) for more information. +* Sessions will now be started with a new `/sessions` endpoint that allows for different execution modes. Batch mode is now supported through `Batch`, and [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") will work the same as way as before. Please see [run/sessions](/run/sessions) for more information. Note that `Session` and `Batch` created from `qiskit-ibm-runtime` prior to this release will no longer be supported after March 31, 2024. Please update your `qiskit-ibm-runtime` version as soon as possible before this date. @@ -34,7 +34,7 @@ in_page_toc_max_heading_level: 2 ### Deprecation Notes -* Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024. See the transpilation documentation ([https://docs.quantum.ibm.com/transpile](https://docs.quantum.ibm.com/transpile)) for instructions to transform circuits and the primitive examples ([https://docs.quantum.ibm.com/run/primitives-examples](https://docs.quantum.ibm.com/run/primitives-examples)) to see this coupled with operator transformations. +* Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024. See the transpilation documentation ([transpile](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. @@ -369,7 +369,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ### Upgrade Notes -* Job error messages now include the error code. Error codes can be found in [https://docs.quantum-computing.ibm.com/errors](https://docs.quantum-computing.ibm.com/errors). +* Job error messages now include the error code. Error codes can be found in [errors](/errors). From bb09d2b00e11215daa3cd021a76be47d747f8f20 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:57:58 -0500 Subject: [PATCH 12/20] Regenerate qiskit-ibm-runtime 0.20.1-dev --- .../dev/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md | 2 +- .../dev/qiskit_ibm_runtime.options.Options.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md index 5b91c88dde2..f5079be8e2f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -222,7 +222,7 @@ Return all backends accessible via this account, subject to optional filtering. QiskitRuntimeService.backends(open_pulse=True) ``` - For the full list of backend attributes, see the IBMBackend class documentation \<[https://docs.quantum.ibm.com/api/qiskit/providers\_models](https://docs.quantum.ibm.com/api/qiskit/providers_models)> + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md index 84a0ff6aa77..68e8a4b2ede 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md @@ -47,7 +47,7 @@ Session constructor. * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). -* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](https://docs.quantum.ibm.com/run/max-execution-time). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md index 7ccab53395d..e213d5e461f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md @@ -34,13 +34,13 @@ Options for the primitives. * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. Only applies to estimator. * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. - Refer to the [Qiskit Runtime documentation](https://docs.quantum.ibm.com/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. * **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - Refer to the [Max execution time documentation](https://docs.quantum.ibm.com/run/max-execution-time). for more information. + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. From f72e8fcd5a19000a56afefef21ab1afbabc39231 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:06:27 -0500 Subject: [PATCH 13/20] Regen 0.45 --- docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md | 2 +- .../qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md | 2 +- docs/api/qiskit/0.45/qpy.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md index c43f2a6ad74..0b72afe2353 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md @@ -3479,7 +3479,7 @@ A handle to the instructions created. Tensor `self` with `other`. -Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](https://docs.quantum-computing.ibm.com/build/circuit-construction) for more information. +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](/build/circuit-construction) for more information. ```python ┌────────┐ ┌─────┐ ┌─────┐ diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md index 8f239a146a9..1e4e1c789a5 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md @@ -20,7 +20,7 @@ This is a control electronics aware analysis pass. Quantum gates (instructions) are often implemented with shaped analog stimulus signals. These signals may be digitally stored in the waveform memory of the control electronics and converted into analog voltage signals by electronic components known as digital to analog converters (DAC). -In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://docs.quantum-computing.ibm.com/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. +In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises `TranspilerError` to kill the transpilation process if any invalid calibration entry is found. This pass saves users from waiting until job execution time to get an invalid pulse error from the backend control electronics. diff --git a/docs/api/qiskit/0.45/qpy.md b/docs/api/qiskit/0.45/qpy.md index 1d6392af0e8..c06e485872d 100644 --- a/docs/api/qiskit/0.45/qpy.md +++ b/docs/api/qiskit/0.45/qpy.md @@ -445,7 +445,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. -With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://docs.quantum-computing.ibm.com/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. +With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. In QPY version 5 and above, From bc07ef0869d99732678b03bd19e94e53f12b3efd Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:07:55 -0500 Subject: [PATCH 14/20] Regen 0.46 --- docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md | 2 +- .../qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md | 2 +- docs/api/qiskit/0.46/qpy.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md index 405af621f63..bef28c4d5c6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md @@ -3483,7 +3483,7 @@ A handle to the instructions created. Tensor `self` with `other`. -Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](https://docs.quantum-computing.ibm.com/build/circuit-construction) for more information. +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](/build/circuit-construction) for more information. ```python ┌────────┐ ┌─────┐ ┌─────┐ diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md index 2c392b26f2c..833e8066158 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md @@ -20,7 +20,7 @@ This is a control electronics aware analysis pass. Quantum gates (instructions) are often implemented with shaped analog stimulus signals. These signals may be digitally stored in the waveform memory of the control electronics and converted into analog voltage signals by electronic components known as digital to analog converters (DAC). -In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://docs.quantum-computing.ibm.com/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. +In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises `TranspilerError` to kill the transpilation process if any invalid calibration entry is found. This pass saves users from waiting until job execution time to get an invalid pulse error from the backend control electronics. diff --git a/docs/api/qiskit/0.46/qpy.md b/docs/api/qiskit/0.46/qpy.md index 066b775c41c..5dd53f5952e 100644 --- a/docs/api/qiskit/0.46/qpy.md +++ b/docs/api/qiskit/0.46/qpy.md @@ -445,7 +445,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. -With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://docs.quantum-computing.ibm.com/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. +With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. In QPY version 5 and above, From 256a7c0d8e662eb26ac8eabacb9d992a83122672 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:08:07 -0500 Subject: [PATCH 15/20] Regen 1.0 and release notes --- docs/api/qiskit/qiskit.circuit.QuantumCircuit.md | 2 +- .../qiskit/qiskit.transpiler.passes.ValidatePulseGates.md | 2 +- docs/api/qiskit/qpy.md | 2 +- docs/api/qiskit/release-notes/0.46.md | 4 ++-- docs/api/qiskit/release-notes/1.0.md | 8 ++++---- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md index 1236409cd28..9f37cc25710 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md @@ -3177,7 +3177,7 @@ A handle to the instructions created. Tensor `self` with `other`. -Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](https://docs.quantum-computing.ibm.com/build/circuit-construction) for more information. +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](/build/circuit-construction) for more information. ```python ┌────────┐ ┌─────┐ ┌─────┐ diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md index 20f77ea9da8..18e030fcf83 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md @@ -20,7 +20,7 @@ This is a control electronics aware analysis pass. Quantum gates (instructions) are often implemented with shaped analog stimulus signals. These signals may be digitally stored in the waveform memory of the control electronics and converted into analog voltage signals by electronic components known as digital to analog converters (DAC). -In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://docs.quantum-computing.ibm.com/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. +In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises `TranspilerError` to kill the transpilation process if any invalid calibration entry is found. This pass saves users from waiting until job execution time to get an invalid pulse error from the backend control electronics. diff --git a/docs/api/qiskit/qpy.md b/docs/api/qiskit/qpy.md index 10e2ebd2e27..7530d2a1215 100644 --- a/docs/api/qiskit/qpy.md +++ b/docs/api/qiskit/qpy.md @@ -510,7 +510,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. -With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://docs.quantum-computing.ibm.com/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. +With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. In QPY version 5 and above, diff --git a/docs/api/qiskit/release-notes/0.46.md b/docs/api/qiskit/release-notes/0.46.md index 1dc22679072..44d2d24c0f2 100644 --- a/docs/api/qiskit/release-notes/0.46.md +++ b/docs/api/qiskit/release-notes/0.46.md @@ -14,7 +14,7 @@ description: New features and bug fixes The 0.46.0 release is the final minor version release for the 0.x series. This release primarily adds new deprecation warnings for API changes coming in the future major version release 1.0.0. It is fully compatible with the Qiskit 0.45.x releases. It is strongly recommended that you upgrade from 0.45.x to 0.46.0 so that you’re able to see the warnings about which interfaces will change with Qiskit 1.0.0. -The 0.46.x release series will continue to be supported and recieve bugfix and security fixes via patch releases for 6 months after this release. For more details on the release schedule and support cycle see: [https://docs.quantum.ibm.com/start/install#qiskit-versioning](https://docs.quantum.ibm.com/start/install#qiskit-versioning) which documents the release schedule in more detail. +The 0.46.x release series will continue to be supported and recieve bugfix and security fixes via patch releases for 6 months after this release. For more details on the release schedule and support cycle see: [start/install#qiskit-versioning](/start/install#qiskit-versioning) which documents the release schedule in more detail. If your project depends on Qiskit, it may rely on functionality that will no longer be supported in Qiskit 1.0.0. For this reason, we recommend that you proactively cap your supported version to `<1.0`. Qiskit 1.0.0 is scheduled to release approximately two weeks after Qiskit 0.46.0, on 2024-02-15, and might not yet be available when you read this message. @@ -125,7 +125,7 @@ If you develop a library based on Qiskit and you still have a dependency on `qis * The `qiskit.tools.jupyter` module has been deprecated and will be removed in Qiskit 1.0.0. This module is deprecated because the functionality in this module is tied to the legacy `qiskit-ibmq-provider` package which is no longer supported and also only supported [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "qiskit.providers.BackendV1"). If you’re using this functionality currently, similar jupyter tools exist in the [qiskit-ibm-provider](https://github.com/Qiskit/qiskit-ibm-provider) package which can be used instead. The documentation for this module can be found here: - [https://docs.quantum.ibm.com/api/qiskit-ibm-provider/ibm\_jupyter](https://docs.quantum.ibm.com/api/qiskit-ibm-provider/ibm_jupyter) + [api/qiskit-ibm-provider/ibm\_jupyter](/api/qiskit-ibm-provider/ibm_jupyter) * The `qiskit.tools.monitor` module has been deprecated and will be removed in Qiskit 1.0.0. This module is deprecated because the functionality in this module is tied to the legacy `qiskit-ibmq-provider` package which is no longer supported and also only supported [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "qiskit.providers.BackendV1"). diff --git a/docs/api/qiskit/release-notes/1.0.md b/docs/api/qiskit/release-notes/1.0.md index a102406ee5c..7f31e32f91f 100644 --- a/docs/api/qiskit/release-notes/1.0.md +++ b/docs/api/qiskit/release-notes/1.0.md @@ -12,9 +12,9 @@ description: New features and bug fixes We are very pleased to release Qiskit 1.0.0. This release is the culmination of 7 years of development to mature Qiskit into a stable, high- performance SDK for quantum computing, and is the start of a new era for the Qiskit project and community. Besides general performance and stability improvements, the most significant changes with the 1.0.0 release relate to the stability policy, release cycles, and versioning. Qiskit is now formally using [semantic versioning](https://semver.org/), and this means that, for the entire lifecycle of the 1.x release series, the project is committed to maintaining backwards compatibility in its public documented APIs. We’re also now starting to offer bugfix support for major versions, so that you continue to have a supported branch for 6 months after the release of the next major version. This starts now with the 1.x and 0.x major series: the 0.46.x release will continue to be supported, with periodic patch releases that contain bug fixes, for 6 months after the release of 1.0. That is, 0.46.x will be supported until 2024-08. You can see the full details of the new policy here: -[https://docs.quantum.ibm.com/start/install#qiskit-versioning](https://docs.quantum.ibm.com/start/install#qiskit-versioning) +[start/install#qiskit-versioning](/start/install#qiskit-versioning) -Also of key importance in this release is the change in packaging. Since the Qiskit 0.7 release in 2018-12, when Qiskit introduced its [elements](https://medium.com/qiskit/qiskit-and-its-fundamental-elements-bcd7ead80492) model, the `qiskit` package you would install has been a meta-package (or package of packages) that installs the combined elements comprising Qiskit. As announced in previous releases (for more details see the [0.44.0](https://docs.quantum.ibm.com/api/qiskit/release-notes/0.44#0440), [0.45.3](https://docs.quantum.ibm.com/api/qiskit/release-notes/0.45#prelude), and [0.46.0](https://docs.quantum.ibm.com/api/qiskit/release-notes/0.46#prelude) release notes, along with this [blog post](https://research.ibm.com/blog/qiskit-application-modules)) with the 1.0 release we’re completing a transition to have a single `qiskit` package exposing only the core SDK (what was previously `qiskit-terra`). This means that for releases >= 1.0.0, we have stopped using the `qiskit-terra` package and will only be publishing `qiskit`. As this change in packaging structure is not fully supported by the Python package installer `pip`, it is not possible to just use `pip install -U qiskit` to upgrade from qiskit 0.46.0 to 1.0.0. It is strongly recommended that to upgrade to Qiskit 1.0.0 you create a separate virtual environment to isolate the installation. There is a detailed migration guide that explains the packaging changes and how to install Qiskit 1.0.0 in different scenarios which can be found here: +Also of key importance in this release is the change in packaging. Since the Qiskit 0.7 release in 2018-12, when Qiskit introduced its [elements](https://medium.com/qiskit/qiskit-and-its-fundamental-elements-bcd7ead80492) model, the `qiskit` package you would install has been a meta-package (or package of packages) that installs the combined elements comprising Qiskit. As announced in previous releases (for more details see the [0.44.0](/api/qiskit/release-notes/0.44#0440), [0.45.3](/api/qiskit/release-notes/0.45#prelude), and [0.46.0](/api/qiskit/release-notes/0.46#prelude) release notes, along with this [blog post](https://research.ibm.com/blog/qiskit-application-modules)) with the 1.0 release we’re completing a transition to have a single `qiskit` package exposing only the core SDK (what was previously `qiskit-terra`). This means that for releases >= 1.0.0, we have stopped using the `qiskit-terra` package and will only be publishing `qiskit`. As this change in packaging structure is not fully supported by the Python package installer `pip`, it is not possible to just use `pip install -U qiskit` to upgrade from qiskit 0.46.0 to 1.0.0. It is strongly recommended that to upgrade to Qiskit 1.0.0 you create a separate virtual environment to isolate the installation. There is a detailed migration guide that explains the packaging changes and how to install Qiskit 1.0.0 in different scenarios which can be found here: [https://qisk.it/1-0-packaging-migration](https://qisk.it/1-0-packaging-migration) @@ -26,7 +26,7 @@ As with all of our major releases, Qiskit 1.0.0 also has a plethora of new featu Finally, the Qiskit 1.0.0 release was an opportunity to clean up some technical debt accumulated over the past 7 years of development. You’ll notice that the Qiskit 1.0.0 release is virtually free of `DeprecationWarning`s being emitted, and, at the same time, the upgrade section of the 1.0.0 release notes is longer than usual. These are direct consequences of the technical debt cleanup. To help with the migration from 0.46.x to 1.0.0, besides the release notes, we have also published a dedicated migration guide which can be found here: -[https://docs.quantum.ibm.com/api/migration-guides/qiskit-1.0-features](https://docs.quantum.ibm.com/api/migration-guides/qiskit-1.0-features) +[api/migration-guides/qiskit-1.0-features](/api/migration-guides/qiskit-1.0-features) This guide is meant to complement the release notes and have a targeted advice for how to migrate the API changes after the removal of the deprecated functionality from the 0.46.0 release. @@ -534,7 +534,7 @@ This guide is meant to complement the release notes and have a targeted advice f * The minimum supported Rust version for building Qiskit from source is now 1.70. This has been raised from the previous minimum supported Rust version of 1.64 in the Qiskit 0.45.x and 0.46.0 release series. -* The dependency on [psutil](https://pypi.org/project/psutil/) has been removed. The psutil library was previously only used for detecting the number of physical CPUs and total system memory, however this information provided does not add sufficient value to justify the additional dependencies and overhead so it has been removed. This does mean that the default number of processes used by [`parallel_map()`](/api/qiskit/utils#qiskit.utils.parallel_map "qiskit.utils.parallel_map") and functions that internally can use [`parallel_map()`](/api/qiskit/utils#qiskit.utils.parallel_map "qiskit.utils.parallel_map") such as [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`PassManager.run()`](/api/qiskit/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") may use more or less parallel processes than in previous releases. If you’d like to adjust the number of processes used you can use the new `num_processes` argument to those functions, or the `QISKIT_NUM_PROCS` environment variable or `num_processes` field in a user configuration file (see the [local configuration guide](https://docs.quantum.ibm.com/start/configure-qiskit-local) for more details) if you need to adjust the number of processes that Qiskit potentially uses. +* The dependency on [psutil](https://pypi.org/project/psutil/) has been removed. The psutil library was previously only used for detecting the number of physical CPUs and total system memory, however this information provided does not add sufficient value to justify the additional dependencies and overhead so it has been removed. This does mean that the default number of processes used by [`parallel_map()`](/api/qiskit/utils#qiskit.utils.parallel_map "qiskit.utils.parallel_map") and functions that internally can use [`parallel_map()`](/api/qiskit/utils#qiskit.utils.parallel_map "qiskit.utils.parallel_map") such as [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`PassManager.run()`](/api/qiskit/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") may use more or less parallel processes than in previous releases. If you’d like to adjust the number of processes used you can use the new `num_processes` argument to those functions, or the `QISKIT_NUM_PROCS` environment variable or `num_processes` field in a user configuration file (see the [local configuration guide](/start/configure-qiskit-local) for more details) if you need to adjust the number of processes that Qiskit potentially uses. * The `scoped_parameters` and `search_parameters` methods have been removed from the [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") class. These methods returned [`Parameter`](/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects that partially linked to the parameters in the [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") instance but assigning values using these objects did not work correctly. Users should use [`ScheduleBlock.parameters`](/api/qiskit/qiskit.pulse.ScheduleBlock#parameters "qiskit.pulse.ScheduleBlock.parameters") instead and iterate through [`ScheduleBlock.references`](/api/qiskit/qiskit.pulse.ScheduleBlock#references "qiskit.pulse.ScheduleBlock.references") and compare to the [`Schedule.parameters`](/api/qiskit/qiskit.pulse.Schedule#parameters "qiskit.pulse.Schedule.parameters") attributes of the subreferences when needing to distinguish which subroutine a parameter is used in. See [#11654](https://github.com/Qiskit/qiskit/issues/11654) for more information. From 7f6887d71777768f8d03cef6bc96a9fd4997016e Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:09:03 -0500 Subject: [PATCH 16/20] Regen qiskit dev --- docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md | 2 +- .../qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md | 2 +- docs/api/qiskit/dev/qpy.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md index 5a6e4880254..ed219bbfd5d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md @@ -3177,7 +3177,7 @@ A handle to the instructions created. Tensor `self` with `other`. -Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](https://docs.quantum-computing.ibm.com/build/circuit-construction) for more information. +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](/build/circuit-construction) for more information. ```python ┌────────┐ ┌─────┐ ┌─────┐ diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md index c0027e692d4..47471e0b8f2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md @@ -20,7 +20,7 @@ This is a control electronics aware analysis pass. Quantum gates (instructions) are often implemented with shaped analog stimulus signals. These signals may be digitally stored in the waveform memory of the control electronics and converted into analog voltage signals by electronic components known as digital to analog converters (DAC). -In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://docs.quantum-computing.ibm.com/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. +In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises `TranspilerError` to kill the transpilation process if any invalid calibration entry is found. This pass saves users from waiting until job execution time to get an invalid pulse error from the backend control electronics. diff --git a/docs/api/qiskit/dev/qpy.md b/docs/api/qiskit/dev/qpy.md index 976110a226c..8a19f11425a 100644 --- a/docs/api/qiskit/dev/qpy.md +++ b/docs/api/qiskit/dev/qpy.md @@ -510,7 +510,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. -With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://docs.quantum-computing.ibm.com/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. +With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. In QPY version 5 and above, From 5ffd62ae72d7dc1cad160c657acbaac101b9e1e4 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:29:37 -0500 Subject: [PATCH 17/20] Add edge case to tests --- scripts/lib/api/updateLinks.test.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/lib/api/updateLinks.test.ts b/scripts/lib/api/updateLinks.test.ts index 26554d90038..ff1a40b137a 100644 --- a/scripts/lib/api/updateLinks.test.ts +++ b/scripts/lib/api/updateLinks.test.ts @@ -191,6 +191,7 @@ describe("relativizeLink()", () => { "https://ibm.com", "https://qiskit.org/ecosystem/nature", "https://qiskit.org/documentation/index.html", + "https://docs.quantum.ibm.com", // Note there is no `/` at the end. ])("ignore irrelevant links", (input) => { expect(relativizeLink({ url: input })).toBeUndefined(); }); From 9ec2203f5aa0e82cf8124509a2b2c23b56fadd7d Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 22 Feb 2024 16:54:12 -0500 Subject: [PATCH 18/20] Fix link checker --- scripts/commands/checkLinks.ts | 46 ++++++++++++++++++----------- scripts/lib/api/updateLinks.test.ts | 2 +- scripts/lib/links/ignores.ts | 2 ++ 3 files changed, 31 insertions(+), 19 deletions(-) diff --git a/scripts/commands/checkLinks.ts b/scripts/commands/checkLinks.ts index e4adc78fc09..7d35c507893 100644 --- a/scripts/commands/checkLinks.ts +++ b/scripts/commands/checkLinks.ts @@ -103,6 +103,19 @@ async function main() { console.log("\nNo links appear broken ✅\n"); } +const PROVIDER_GLOBS_TO_LOAD = ["docs/api/qiskit/*.md"]; +const RUNTIME_GLOBS_TO_LOAD = [ + "docs/api/qiskit/providers_models.md", + "docs/run/max-execution-time.mdx", + "docs/run/configure-error-mitigation.mdx", +]; +const QISKIT_GLOBS_TO_LOAD = [ + "docs/build/circuit-construction.ipynb", + "docs/build/pulse.ipynb", + "docs/api/qiskit/release-notes/0.44.md", + "docs/api/qiskit-ibm-provider/index.md", +]; + async function determineFileBatches(args: Arguments): Promise { const currentBatch = await determineCurrentDocsFileBatch(args); const result = [currentBatch]; @@ -114,21 +127,18 @@ async function determineFileBatches(args: Arguments): Promise { const provider = await determineHistoricalFileBatches( "qiskit-ibm-provider", - ["docs/api/qiskit/*.md"], + PROVIDER_GLOBS_TO_LOAD, args.historicalApis, ); const runtime = await determineHistoricalFileBatches( "qiskit-ibm-runtime", - ["docs/api/qiskit/providers_models.md"], + RUNTIME_GLOBS_TO_LOAD, args.historicalApis, ); const qiskit = await determineHistoricalFileBatches( "qiskit", - [ - "docs/api/qiskit/release-notes/0.44.md", - "docs/api/qiskit-ibm-provider/index.md", - ], + QISKIT_GLOBS_TO_LOAD, args.historicalApis && !args.skipBrokenHistorical, args.qiskitReleaseNotes, ); @@ -179,6 +189,7 @@ async function determineCurrentDocsFileBatch( .join("."); toCheck.push(`docs/api/qiskit/release-notes/${currentVersion}.md`); + toLoad.push("docs/api/qiskit/release-notes/0.{45,46}.md"); } let description: string; @@ -196,22 +207,21 @@ async function determineCurrentDocsFileBatch( } async function determineDevFileBatches(): Promise { - const devProjects = []; - for (const project of [ - "qiskit", - "qiskit-ibm-provider", - "qiskit-ibm-runtime", - ]) { - if (await pathExists(`docs/api/${project}/dev`)) { - devProjects.push(project); - } - } + const projects: [string, string[]][] = [ + ["qiskit", QISKIT_GLOBS_TO_LOAD], + ["qiskit-ibm-provider", PROVIDER_GLOBS_TO_LOAD], + ["qiskit-ibm-runtime", RUNTIME_GLOBS_TO_LOAD], + ]; const result = []; - for (const project of devProjects) { + for (const [project, toLoad] of projects) { + if (!(await pathExists(`docs/api/${project}/dev`))) { + continue; + } + const fileBatch = await FileBatch.fromGlobs( [`docs/api/${project}/dev/*`, `public/api/${project}/dev/objects.inv`], - [], + toLoad, `${project} dev docs`, ); result.push(fileBatch); diff --git a/scripts/lib/api/updateLinks.test.ts b/scripts/lib/api/updateLinks.test.ts index ff1a40b137a..888ad3dbf23 100644 --- a/scripts/lib/api/updateLinks.test.ts +++ b/scripts/lib/api/updateLinks.test.ts @@ -191,7 +191,7 @@ describe("relativizeLink()", () => { "https://ibm.com", "https://qiskit.org/ecosystem/nature", "https://qiskit.org/documentation/index.html", - "https://docs.quantum.ibm.com", // Note there is no `/` at the end. + "https://docs.quantum.ibm.com", // Note there is no `/` at the end. ])("ignore irrelevant links", (input) => { expect(relativizeLink({ url: input })).toBeUndefined(); }); diff --git a/scripts/lib/links/ignores.ts b/scripts/lib/links/ignores.ts index d23866c66ca..8a94335830b 100644 --- a/scripts/lib/links/ignores.ts +++ b/scripts/lib/links/ignores.ts @@ -44,6 +44,8 @@ const ALWAYS_IGNORED_URLS__EXPECTED = [ const ALWAYS_IGNORED_URLS__SHOULD_FIX = [ "circuit#qiskit.circuit.CASE_DEFAULT", + // Bad anchor in qiskit_ibm_runtime.options.Options.md for 0.14 - 0.16. + "/run/max-execution-time#maximum-execution-time", ..._QISKIT_UTILS, ]; From 097a52bf589866489a27d70b1a7c7df7b5e011b6 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 23 Feb 2024 07:50:16 -0500 Subject: [PATCH 19/20] Fix 1.0 release note Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> --- scripts/commands/checkLinks.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/commands/checkLinks.ts b/scripts/commands/checkLinks.ts index 7d35c507893..cf278b7af1b 100644 --- a/scripts/commands/checkLinks.ts +++ b/scripts/commands/checkLinks.ts @@ -189,7 +189,8 @@ async function determineCurrentDocsFileBatch( .join("."); toCheck.push(`docs/api/qiskit/release-notes/${currentVersion}.md`); - toLoad.push("docs/api/qiskit/release-notes/0.{45,46}.md"); + // Necessary files for docs/api/qiskit/release-notes/1.0.md + toLoad.push("docs/api/qiskit/release-notes/0.{44,45,46}.md"); } let description: string; From f125e150e480f4dfb8fca8ecbcab6c58f99c2ad3 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 23 Feb 2024 08:18:55 -0500 Subject: [PATCH 20/20] Two more missing files --- scripts/commands/checkLinks.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/commands/checkLinks.ts b/scripts/commands/checkLinks.ts index cf278b7af1b..64ea011853a 100644 --- a/scripts/commands/checkLinks.ts +++ b/scripts/commands/checkLinks.ts @@ -112,8 +112,10 @@ const RUNTIME_GLOBS_TO_LOAD = [ const QISKIT_GLOBS_TO_LOAD = [ "docs/build/circuit-construction.ipynb", "docs/build/pulse.ipynb", + "docs/start/install.mdx", "docs/api/qiskit/release-notes/0.44.md", "docs/api/qiskit-ibm-provider/index.md", + "docs/api/qiskit-ibm-provider/ibm_jupyter.md", ]; async function determineFileBatches(args: Arguments): Promise {