Skip to content

Commit

Permalink
Regenerate Qiskit 1.0 docs to use precise source code links (Qiskit#1145
Browse files Browse the repository at this point in the history
)

Part of Qiskit#517.
  • Loading branch information
Eric-Arellano authored Apr 9, 2024
1 parent ff55d58 commit 2eaf342
Show file tree
Hide file tree
Showing 627 changed files with 2,820 additions and 2,811 deletions.
6 changes: 3 additions & 3 deletions docs/api/qiskit/assembler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ python_api_name: qiskit.assembler

### assemble\_circuits

<Function id="qiskit.assembler.assemble_circuits" name="assemble_circuits" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py" signature="qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)">
<Function id="qiskit.assembler.assemble_circuits" name="assemble_circuits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py#L302-L408" signature="qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)">
Assembles a list of circuits into a qobj that can be run on the backend.

**Parameters**
Expand Down Expand Up @@ -65,7 +65,7 @@ python_api_name: qiskit.assembler

### assemble\_schedules

<Function id="qiskit.assembler.assemble_schedules" name="assemble_schedules" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py" signature="qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)">
<Function id="qiskit.assembler.assemble_schedules" name="assemble_schedules" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py#L27-L103" signature="qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)">
Assembles a list of schedules into a qobj that can be run on the backend.

**Parameters**
Expand Down Expand Up @@ -129,7 +129,7 @@ python_api_name: qiskit.assembler

### disassemble

<Function id="qiskit.assembler.disassemble" name="disassemble" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py" signature="qiskit.assembler.disassemble(qobj)">
<Function id="qiskit.assembler.disassemble" name="disassemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py#L40-L83" signature="qiskit.assembler.disassemble(qobj)">
Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header.

<Admonition title="Note" type="note">
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/circuit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ with qc.switch(cr) as case:

### random\_circuit

<Function id="qiskit.circuit.random.random_circuit" name="random_circuit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py" signature="qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)">
<Function id="qiskit.circuit.random.random_circuit" name="random_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py#L23-L209" signature="qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)">
Generate random circuit of arbitrary size and form.

This function will generate a random circuit by randomly selecting gates from the set of standard gates in `qiskit.circuit.library.standard_gates`. For example:
Expand Down Expand Up @@ -345,7 +345,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c

### CircuitError

<Class id="qiskit.circuit.CircuitError" name="CircuitError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py" signature="qiskit.circuit.CircuitError(*message)">
<Class id="qiskit.circuit.CircuitError" name="CircuitError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py#L18-L19" signature="qiskit.circuit.CircuitError(*message)">
Base class for errors raised while processing a circuit.

Set the error message.
Expand Down
86 changes: 43 additions & 43 deletions docs/api/qiskit/circuit_classical.mdx

Large diffs are not rendered by default.

198 changes: 99 additions & 99 deletions docs/api/qiskit/circuit_library.mdx

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/api/qiskit/circuit_singleton.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,21 @@ assert XGate() is XGate()

The public classes correspond to the standard classes [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") and [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), respectively, and are subclasses of these.

<Class id="qiskit.circuit.singleton.SingletonInstruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)">
<Class id="qiskit.circuit.singleton.SingletonInstruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L503-L522" signature="qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)">
A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances.

This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") which has an immutable definition and any instance of [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions.

The exception to be aware of with this class though are the [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") attributes [`label`](qiskit.circuit.Instruction#label "qiskit.circuit.Instruction.label"), [`condition`](qiskit.circuit.Instruction#condition "qiskit.circuit.Instruction.condition"), [`duration`](qiskit.circuit.Instruction#duration "qiskit.circuit.Instruction.duration"), and [`unit`](qiskit.circuit.Instruction#unit "qiskit.circuit.Instruction.unit") which can be set differently for specific instances of gates. For [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") usage to be sound setting these attributes is not available and they can only be set at creation time, or on an object that has been specifically made mutable using [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable"). If any of these attributes are used during creation, then instead of using a single shared global instance of the same gate a new separate instance will be created.
</Class>

<Class id="qiskit.circuit.singleton.SingletonGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)">
<Class id="qiskit.circuit.singleton.SingletonGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L534-L541" signature="qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)">
A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances.

This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well.
</Class>

<Class id="qiskit.circuit.singleton.SingletonControlledGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)">
<Class id="qiskit.circuit.singleton.SingletonControlledGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L554-L566" signature="qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)">
A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances

This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well.
Expand Down Expand Up @@ -120,7 +120,7 @@ Subclasses of [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstru

### \_singleton\_lookup\_key

<Function id="qiskit.circuit.singleton.SingletonInstruction._singleton_lookup_key" name="_singleton_lookup_key" signature="static SingletonInstruction._singleton_lookup_key(*_args, **_kwargs)">
<Function id="qiskit.circuit.singleton.SingletonInstruction._singleton_lookup_key" name="_singleton_lookup_key" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L411-L451" signature="static SingletonInstruction._singleton_lookup_key(*_args, **_kwargs)">
Given the arguments to the constructor, return a key tuple that identifies the singleton instance to retrieve, or `None` if the arguments imply that a mutable object must be created.

For performance, as a special case, this method will not be called if the class constructor was given zero arguments (e.g. the construction `XGate()` will not call this method, but `XGate(label=None)` will), and the default singleton will immediately be returned.
Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit/compiler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ python_api_name: qiskit.compiler

### assemble

<Function id="qiskit.compiler.assemble" name="assemble" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py" signature="qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)">
<Function id="qiskit.compiler.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py#L42-L220" signature="qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)">
Assemble a list of circuits or pulse schedules into a `Qobj`.

This function serializes the payloads, which could be either circuits or schedules, to create `Qobj` “experiments”. It further annotates the experiment payload with header and configurations.
Expand Down Expand Up @@ -103,7 +103,7 @@ python_api_name: qiskit.compiler

### schedule

<Function id="qiskit.compiler.schedule" name="schedule" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py" signature="qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)">
<Function id="qiskit.compiler.schedule" name="schedule" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py#L38-L107" signature="qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)">
Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`.

**Parameters**
Expand All @@ -130,7 +130,7 @@ python_api_name: qiskit.compiler

### transpile

<Function id="qiskit.compiler.transpile" name="transpile" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py" signature="qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)">
<Function id="qiskit.compiler.transpile" name="transpile" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py#L43-L434" signature="qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)">
Transpile one or more circuits, according to some desired transpilation targets.

Transpilation is potentially done in parallel using multiprocessing when `circuits` is a list with > 1 [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object depending on the local environment and configuration.
Expand Down Expand Up @@ -278,7 +278,7 @@ python_api_name: qiskit.compiler

### sequence

<Function id="qiskit.compiler.sequence" name="sequence" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py" signature="qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)">
<Function id="qiskit.compiler.sequence" name="sequence" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py#L26-L69" signature="qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)">
Schedule a scheduled circuit to a pulse `Schedule`, using the backend.

**Parameters**
Expand Down
Loading

0 comments on commit 2eaf342

Please sign in to comment.