Skip to content

Commit

Permalink
Relativize API links to docs.quantum.ibm.com (#870)
Browse files Browse the repository at this point in the history
Closes #493. This change
makes our link checker work better because it can quickly validate the
relative links and also validate anchors, whereas external links are
much slower.

---------

Co-authored-by: Arnau Casau <[email protected]>
  • Loading branch information
Eric-Arellano and arnaucasau authored Feb 23, 2024
1 parent 3ca6915 commit 5f6c04f
Show file tree
Hide file tree
Showing 66 changed files with 265 additions and 238 deletions.
1 change: 0 additions & 1 deletion docs/api/qiskit-ibm-provider/0.9/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -211,4 +211,3 @@
],
"collapsed": true
}

42 changes: 21 additions & 21 deletions docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
</Admonition>

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()
Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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

<span id="qiskit_ibm_provider.IBMBackend.dt" />

Expand Down Expand Up @@ -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.

<span id="qiskit_ibm_provider.IBMBackend.instruction_schedule_map" />

### 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.

<span id="qiskit_ibm_provider.IBMBackend.instructions" />

Expand All @@ -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`]]]

<span id="qiskit_ibm_provider.IBMBackend.max_circuits" />

Expand Down Expand Up @@ -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)")]

<span id="qiskit_ibm_provider.IBMBackend.options" />

Expand Down Expand Up @@ -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

<span id="qiskit_ibm_provider.IBMBackend.version" />

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand All @@ -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**

Expand All @@ -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.

Expand Down Expand Up @@ -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.

<Admonition title="Note" type="note">
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.
</Admonition>

**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**

Expand All @@ -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

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -395,7 +395,7 @@ Return the result of the job.
</Admonition>

<Admonition title="Note" type="note">
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:

Expand All @@ -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**

Expand Down Expand Up @@ -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**

Expand Down
Loading

0 comments on commit 5f6c04f

Please sign in to comment.