Skip to content

Commit

Permalink
docs tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
obliviateandsurrender committed Jul 16, 2024
1 parent b33cabc commit 025ad38
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pennylane_qiskit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
from .basic_aer import BasicAerDevice, BasicSimulatorDevice
from .ibmq import IBMQDevice
from .remote import RemoteDevice
from .converter import load, load_pauli_op, load_qasm, load_qasm_from_file
from .converter import load, load_pauli_op, load_qasm, load_qasm_from_file, load_noise_model
from .runtime_devices import IBMQCircuitRunnerDevice
from .runtime_devices import IBMQSamplerDevice
4 changes: 2 additions & 2 deletions pennylane_qiskit/converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,7 @@ def load_noise_model(noise_model, **kwargs) -> qml.NoiseModel:
Args:
noise_model (qiskit_aer.noise.NoiseModel): A Qiskit noise model object
kwargs: Optional keyword arguments for conversion of the noise model
kwargs: Optional keyword arguments for the conversion of the noise model
Keyword Arguments:
quantum_error (bool): include quantum errors in the converted noise model. Default is ``True``
Expand All @@ -1071,7 +1071,7 @@ def load_noise_model(noise_model, **kwargs) -> qml.NoiseModel:
.. note::
Currently, PennyLane noise models does not support readout errors, so those will be skipped during conversion.
Currently, PennyLane noise models do not support readout errors, so those will be skipped during conversion.
**Example**
Expand Down
5 changes: 3 additions & 2 deletions pennylane_qiskit/noise_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ def _build_qerror_op(error, **kwargs) -> qml.QubitChannel:


def _build_noise_model_map(noise_model, **kwargs) -> Tuple[dict, dict]:
"""Builds a noise model map from which a PennyLane noise model can be constructed efficiently.
"""Builds a noise model map from a Qiskit noise model. This noise model map can be used
to efficiently construct a PennyLane noise model.
Args:
noise_model (qiskit_aer.noise.NoiseModel): Qiskit's noise model
Expand All @@ -97,7 +98,7 @@ def _build_noise_model_map(noise_model, **kwargs) -> Tuple[dict, dict]:
decimals (int): number of decimal places to round the Kraus matrices. Default is ``10``
Returns:
(dict, dict): returns mappings for ecountered quantum errors and readout errors.
(dict, dict): returns mappings for the given quantum errors and readout errors in the ``noise_model``.
For plugin developers: noise model map tuple consists of following two (nested) mappings:
* qerror_dmap: noise_operation -> wires -> target_gate
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
'pennylane.io': [
'qiskit = pennylane_qiskit:load',
'qiskit_op = pennylane_qiskit:load_pauli_op',
'qiskit_noise = pennylane_qiskit:load_noise_model',
'qasm = pennylane_qiskit:load_qasm',
'qasm_file = pennylane_qiskit:load_qasm_from_file',
],
Expand Down

0 comments on commit 025ad38

Please sign in to comment.