Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
renatomello committed Feb 27, 2024
1 parent fefa70e commit a6bf79b
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/qibo/noise.py
Original file line number Diff line number Diff line change
Expand Up @@ -434,37 +434,38 @@ def from_dict(self, parameters: dict):
and :class:`qibo.noise.ReadoutError`.
The keys and values of the dictionary parameters are defined below:
- ``depolarizing_one_qubit`` (*int* or *float* or *dict*): If ``int`` or
- ``"depolarizing_one_qubit"`` (*int* or *float* or *dict*): If ``int`` or
``float``, all qubits share the same single-qubit depolarizing parameter.
If ``dict``, expects qubit indexes as keys and their respective
depolarizing parameter as values.
See :class:`qibo.gates.channels.DepolarizingChannel`
for a detailed definition of depolarizing parameter.
- ``depolarizing_two_qubit`` (*int* or *float* or *dict*): If ``int`` or
- ``"depolarizing_two_qubit"`` (*int* or *float* or *dict*): If ``int`` or
``float``, all two-qubit gates share the same two-qubit depolarizing
parameter regardless in which pair of qubits the two-qubit gate is acting on.
If ``dict``, expects pair qubit indexes as keys separated by a hiphen
(e.g. "0-1" for gate that has "0" as control and "1" as target)
and their respective depolarizing parameter as values.
See :class:`qibo.gates.channels.DepolarizingChannel`
for a detailed definition of depolarizing parameter.
- ``t1`` (*int* or *float* or *dict*): If ``int`` or ``float``, all qubits
- ``"t1"`` (*int* or *float* or *dict*): If ``int`` or ``float``, all qubits
share the same ``t1``. If ``dict``, expects qubit indexes as keys and its
respective ``t1`` as values.
See :class:`qibo.gates.channels.ThermalRelaxationChannel`
for a detailed definition of ``t1``.
Note that ``t1`` and ``t2`` must be passed with the same type.
- ``t1`` (*int* or *float* or *dict*): If ``int`` or ``float``, all qubits share
- ``"t2"`` (*int* or *float* or *dict*): If ``int`` or ``float``, all qubits share
the same ``t2``. If ``dict``, expects qubit indexes as keys and its
respective ``t2`` as values.
See :class:`qibo.gates.channels.ThermalRelaxationChannel`
for a detailed definition of ``t2``.
Note that ``t2`` and ``t1`` must be passed with the same type.
- ``gate_times`` (*tuple* or *list*): pair of gate times representing
- ``"gate_times"`` (*tuple* or *list*): pair of gate times representing
gate times for :class:`ThermalRelaxationError` following, respectively,
one- and two-qubit gates.
- ``excited_population`` (*int* or *float*): See :class:`ThermalRelaxationChannel`.
- ``readout_one_qubit`` (*int* or *float* or *dict*): If ``int`` or ``float``,
- ``"excited_population"`` (*int* or *float*): See :class:`ThermalRelaxationChannel`.
- ``"readout_one_qubit"`` (*int* or *float* or *dict*): If ``int`` or ``float``,
:math:`p(0|1) = p(1|0)`, and all qubits share the same readout error
probabilities. If ``dict``, expects qubit indexes as keys and
values as ``tuple`` (or ``list``) in the format :math:`(p(0|1),\\,p(1|0))`.
Expand Down

0 comments on commit a6bf79b

Please sign in to comment.