Skip to content

Commit ad9dd5f

Browse files
committed
adding doc strings
1 parent e57fee2 commit ad9dd5f

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

src/bloqade/noise/native/_wrappers.py

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,28 @@
88

99

1010
@wraps(native.AtomLossChannel)
11-
def atom_loss_channel(
12-
qargs: ilist.IList[Qubit, Any] | list, *, prob: float
13-
) -> None: ...
11+
def atom_loss_channel(qargs: ilist.IList[Qubit, Any] | list, *, prob: float) -> None:
12+
"""Apply an atom loss channel to a list of qubits.
13+
14+
Args:
15+
qargs (ilist.IList[Qubit, Any] | list): List of qubits to apply the noise to.
16+
prob (float): The loss probability.
17+
"""
18+
...
1419

1520

1621
@wraps(native.PauliChannel)
1722
def pauli_channel(
1823
qargs: ilist.IList[Qubit, Any] | list, *, px: float, py: float, pz: float
19-
) -> None: ...
24+
) -> None:
25+
"""Apply a Pauli channel to a list of qubits.
26+
27+
Args:
28+
qargs (ilist.IList[Qubit, Any] | list): List of qubits to apply the noise to.
29+
px (float): Probability of X error.
30+
py (float): Probability of Y error.
31+
pz (float): Probability of Z error.
32+
"""
2033

2134

2235
@wraps(native.CZPauliChannel)
@@ -31,4 +44,20 @@ def cz_pauli_channel(
3144
py_qarg: float,
3245
pz_qarg: float,
3346
paired: bool,
34-
) -> None: ...
47+
) -> None:
48+
"""Insert noise for a CZ gate with a Pauli channel on qubits.
49+
50+
Args:
51+
ctrls: List of control qubits.
52+
qarg2: List of target qubits.
53+
px_ctrl: Probability of X error on control qubits.
54+
py_ctrl: Probability of Y error on control qubits.
55+
pz_ctrl: Probability of Z error on control qubits.
56+
px_qarg: Probability of X error on target qubits.
57+
py_qarg: Probability of Y error on target qubits.
58+
pz_qarg: Probability of Z error on target qubits.
59+
paired: If True, the noise is applied to both control and target qubits
60+
are not lost otherwise skip this error. If False Apply the noise on
61+
the whatever qubit is not lost.
62+
"""
63+
...

0 commit comments

Comments
 (0)