Skip to content

Commit

Permalink
Add GitHub links to Qiskit v0.44 API docs (#653)
Browse files Browse the repository at this point in the history
Part of #454. Note that
Qiskit 0.45 refers to Qiskit Terra 0.25.
  • Loading branch information
arnaucasau authored Jan 19, 2024
1 parent 8f1e6c3 commit 665f201
Show file tree
Hide file tree
Showing 761 changed files with 1,070 additions and 1,104 deletions.
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.44/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states.

<span id="qiskit.algorithms.AlgorithmError" />

`qiskit.algorithms.AlgorithmError(*message)`
`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/exceptions.py "view source code")

For Algorithm specific errors.

Expand All @@ -215,7 +215,7 @@ Utility functions used by algorithms.

<span id="qiskit.algorithms.eval_observables" />

`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`
`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/aux_ops_evaluator.py "view source code")

Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold.

Expand Down Expand Up @@ -247,7 +247,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P

<span id="qiskit.algorithms.estimate_observables" />

`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`
`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/observables_evaluator.py "view source code")

Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold.

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.44/assembler.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ python_api_name: qiskit.assembler

<span id="qiskit.assembler.assemble_circuits" />

`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`
`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_circuits.py "view source code")

Assembles a list of circuits into a qobj that can be run on the backend.

Expand Down Expand Up @@ -65,7 +65,7 @@ qobj = assemble_circuits(circuits=[qc],

<span id="qiskit.assembler.assemble_schedules" />

`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`
`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_schedules.py "view source code")

Assembles a list of schedules into a qobj that can be run on the backend.

Expand Down Expand Up @@ -129,7 +129,7 @@ pulseQobj = assemble_schedules(schedules=[schedule],

<span id="qiskit.assembler.disassemble" />

`qiskit.assembler.disassemble(qobj)`
`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/disassemble.py "view source code")

Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.44/circuit.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ with qc.switch(cr) as case:

<span id="qiskit.circuit.random.random_circuit" />

`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`
`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/random/utils.py "view source code")

Generate random circuit of arbitrary size and form.

Expand Down Expand Up @@ -329,7 +329,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c

<span id="qiskit.circuit.CircuitError" />

`qiskit.circuit.CircuitError(*message)`
`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/exceptions.py "view source code")

Base class for errors raised while processing a circuit.

Expand Down
66 changes: 33 additions & 33 deletions docs/api/qiskit/0.44/circuit_classical.md

Large diffs are not rendered by default.

Loading

0 comments on commit 665f201

Please sign in to comment.