Skip to content

Commit

Permalink
use sphinx-autodocs-typehints to infer types of arguemnets
Browse files Browse the repository at this point in the history
  • Loading branch information
CalMacCQ committed Dec 6, 2023
1 parent 966652c commit 7b58ecc
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 8 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

extensions = [
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
Expand Down
8 changes: 0 additions & 8 deletions pytket/extensions/qiskit/backends/crosstalk_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,28 +75,20 @@ class CrosstalkParams:
Stores various parameters for modelling crosstalk noise
:param zz_crosstalks: symmetric crosstalks between qubit pairs
:type zz_crosstalks: `Dict[Tuple[Qubit, Qubit], float]`
:param single_q_phase_errors: dict specify the single qubit phase error
on each qubit
:type single_q_phase_errors: `Dict[Qubit, float]`
:param two_q_induced_phase_errors: keys of dictionary specify the control
and target qubit index, while the values are tuples with the spectator
qubit index and the amount of phase error to be applied.
:type two_q_induced_phase_errors: `Dict[Tuple[Qubit, Qubit], Tuple[Qubit, float]]`
:param non_markovian_noise: List storing the non-Markovian noise parameters.
Each tuple in the list contains the qubit index and the zx, zz noise parameters.
:type non_markovian_noise: `List[Tuple[Qubit, float, float]]`
:param virtual_z: If True, then don't break any single qubit Z gate into
unitary fractions, instead add the full unitary.
:type: bool
:param N: hyperparameter specifies splices per second.
1/N must divide all gate times.
:type: float
:param gate_times: python dict to store the gate time information.
:type gate_times: `Dict[Tuple[OpType, Tuple[Qubit, ...]], float]`
:param phase_damping_error: dict specify amplitude phase damping error
on each qubit
:type phase_damping_error: `Dict[Qubit, float]`
:param amplitude_damping_error: dict pecify amplitude damping error
on each qubit
"""
Expand Down

0 comments on commit 7b58ecc

Please sign in to comment.