Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Sphinx-execution & other minor circuit updates #5269

Merged
merged 16 commits into from
Oct 26, 2020
Merged

Fix Sphinx-execution & other minor circuit updates #5269

Changes from 3 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e398b75
minor updates to the circuit
Cryoris Oct 21, 2020
352113e
fix jupyter example
Cryoris Oct 21, 2020
61f0e2e
Merge branch 'master' into minor-circuit-update
Cryoris Oct 21, 2020
3bef876
Update qiskit/circuit/quantumcircuit.py
Cryoris Oct 21, 2020
05ec100
add reno
Cryoris Oct 21, 2020
ecfc77c
Merge branch 'minor-circuit-update' of github.com:Cryoris/qiskit-terr…
Cryoris Oct 21, 2020
8864c06
fix link to qcstyle
Cryoris Oct 21, 2020
f507103
Merge branch 'master' into minor-circuit-update
Cryoris Oct 21, 2020
9509a0a
Update releasenotes/notes/remove-deprecated-circuit-methods-afc22d0ba…
Cryoris Oct 21, 2020
5eaa6c6
Merge branch 'minor-circuit-update' of github.com:Cryoris/qiskit-terr…
Cryoris Oct 21, 2020
af746a6
fix indent
Cryoris Oct 21, 2020
257c16b
Update releasenotes/notes/remove-deprecated-circuit-methods-afc22d0ba…
Cryoris Oct 21, 2020
bf06c39
revert changes on qcstyle doc
Cryoris Oct 22, 2020
acf56d1
Merge branch 'minor-circuit-update' of github.com:Cryoris/qiskit-terr…
Cryoris Oct 22, 2020
3500941
Merge branch 'master' into minor-circuit-update
Cryoris Oct 22, 2020
713b4d1
Merge branch 'master' into minor-circuit-update
Cryoris Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 46 additions & 118 deletions qiskit/circuit/quantumcircuit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,16 +284,6 @@ def has_register(self, register):
has_reg = True
return has_reg

def mirror(self):
"""DEPRECATED: use circuit.reverse_ops().

Returns:
QuantumCircuit: the reversed circuit.
"""
warnings.warn('circuit.mirror() is deprecated. Use circuit.reverse_ops() to '
'reverse the order of gates.', DeprecationWarning)
return self.reverse_ops()

def reverse_ops(self):
"""Reverse the circuit by reversing the order of instructions.

Expand Down Expand Up @@ -603,7 +593,7 @@ def compose(self, other, qubits=None, clbits=None, front=False, inplace=False):

Examples:
Cryoris marked this conversation as resolved.
Show resolved Hide resolved

>>> lhs.compose(rhs, qubits=[3, 2], inplace=True)
lhs.compose(rhs, qubits=[3, 2], inplace=True)

.. parsed-literal::

Expand Down Expand Up @@ -1057,10 +1047,11 @@ def qasm(self, formatted=False, filename=None):
ImportError: If pygments is not installed and ``formatted`` is
``True``.
"""
existing_gate_names = ['ch', 'cx', 'cy', 'cz', 'crx', 'cry', 'crz', 'ccx', 'cswap',
'cu1', 'cu3', 'dcx', 'h', 'i', 'id', 'iden', 'iswap', 'ms',
'r', 'rx', 'rxx', 'ry', 'ryy', 'rz', 'rzx', 'rzz', 's', 'sdg',
'swap', 'x', 'y', 'z', 't', 'tdg', 'u1', 'u2', 'u3']
existing_gate_names = ['ch', 'cp', 'cx', 'cy', 'cz', 'crx', 'cry', 'crz', 'ccx', 'cswap',
'csx', 'cu', 'cu1', 'cu3', 'dcx', 'h', 'i', 'id', 'iden', 'iswap',
'ms', 'p', 'r', 'rx', 'rxx', 'ry', 'ryy', 'rz', 'rzx', 'rzz', 's',
'sdg', 'swap', 'sx', 'x', 'y', 'z', 't', 'tdg', 'u', 'u1', 'u2',
'u3']

existing_composite_circuits = []

Expand Down Expand Up @@ -1162,7 +1153,6 @@ def draw(self, output=None, scale=None, filename=None, style=None,
a dictionary of style, then that will be opened, parsed, and used
as the input dict. See: :ref:`Style Dict Doc <style-dict-circ-doc>` for more
information on the contents.

interactive (bool): when set true show the circuit in a new window
(for `mpl` this depends on the matplotlib backend being used
supporting this). Note when used with either the `text` or the
Expand Down Expand Up @@ -1256,77 +1246,13 @@ def draw(self, output=None, scale=None, filename=None, style=None,
fontsize (int): The font size to use for text. Defaults to 13.
subfontsize (int): The font size to use for subtext. Defaults to 8.
displaytext (dict): A dictionary of the text to use for each
element type in the output visualization. The default values
are::

{
'id': 'id',
'u0': 'U_0',
'u1': 'U_1',
'u2': 'U_2',
'u3': 'U_3',
'x': 'X',
'y': 'Y',
'z': 'Z',
'h': 'H',
's': 'S',
'sdg': 'S^\\dagger',
't': 'T',
'tdg': 'T^\\dagger',
'rx': 'R_x',
'ry': 'R_y',
'rz': 'R_z',
'reset': '\\left|0\\right\\rangle'
}

element type in the output visualization.
See :class:`~qiskit.visualization.qcstyle.DefaultStyle` for the defaults.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't actually think this is a valid docs link right now. I'm not able to find this path in the documentation https://qiskit.org/documentation/apidoc/visualization.html it probably means we need to add this to the docs first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That just means adding it in the __init__ docstring or do I also need to create a new apidocs file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I referenced the module for now, and added the module to the __init__

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, you just need it in the qiskit.visualization __init__ module. There's no need to add a new apidocs.rst unless you want to create a new top page in the docs tree. (which for qcstyle I don't think makes sense, at least not yet until we improve the interface around it).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we might need to add some additional setup or docstrings to make this work. Looking at the rendered output from sphinx of this it doesn't contain any real details:

Screenshot_2020-10-21_10-42-21

You must specify all the necessary values if using this. There
is no provision for passing an incomplete dict in.
displaycolor (dict): The color codes to use for each circuit
element in the form (gate_color, text_color).
The default values are::

{
'u1': ('#FA74A6', '#000000'),
'u2': ('#FA74A6', '#000000'),
'u3': ('#FA74A6', '#000000'),
'id': ('#05BAB6', '#000000'),
'x': ('#05BAB6', '#000000'),
'y': ('#05BAB6', '#000000'),
'z': ('#05BAB6', '#000000'),
'h': ('#6FA4FF', '#000000'),
'cx': ('#6FA4FF', '#000000'),
'cy': ('#6FA4FF', '#000000'),
'cz': ('#6FA4FF', '#000000'),
'swap': ('#6FA4FF', '#000000'),
's': ('#6FA4FF', '#000000'),
'sdg': ('#6FA4FF', '#000000'),
'dcx': ('#6FA4FF', '#000000'),
'iswap': ('#6FA4FF', '#000000'),
't': ('#BB8BFF', '#000000'),
'tdg': ('#BB8BFF', '#000000'),
'r': ('#BB8BFF', '#000000'),
'rx': ('#BB8BFF', '#000000'),
'ry': ('#BB8BFF', '#000000'),
'rz': ('#BB8BFF', '#000000'),
'rxx': ('#BB8BFF', '#000000'),
'ryy': ('#BB8BFF', '#000000'),
'rzx': ('#BB8BFF', '#000000'),
'reset': ('#000000', #FFFFFF'),
'target': ('#FFFFFF, '#FFFFFF'),
'measure': ('#000000', '#FFFFFF'),
'ccx': ('#BB8BFF', '#000000'),
'cdcx': ('#BB8BFF', '#000000'),
'ccdcx': ('#BB8BFF', '#000000'),
'cswap': ('#BB8BFF', '#000000'),
'ccswap': ('#BB8BFF', '#000000'),
'mcx': ('#BB8BFF', '#000000'),
'mcx_gray': ('#BB8BFF', '#000000),
'u': ('#BB8BFF', '#000000'),
'p': ('#BB8BFF', '#000000'),
'sx': ('#BB8BFF', '#000000'),
'sxdg': ('#BB8BFF', '#000000')
}

See :class:`~qiskit.visualization.qcstyle.DefaultStyle` for the defaults.
Colors can also be entered without the text color, such as
'u1': '#FA74A6', in which case the text color will always
be 'gatetextcolor'. The 'displaycolor' dict can contain any
Expand All @@ -1351,12 +1277,6 @@ def draw(self, output=None, scale=None, filename=None, style=None,

# pylint: disable=cyclic-import
from qiskit.visualization import circuit_drawer
if isinstance(output, (int, float, np.number)):
warnings.warn("Setting 'scale' as the first argument is deprecated. "
"Use scale=%s instead." % output,
DeprecationWarning)
scale = output
output = None

return circuit_drawer(self, scale=scale,
filename=filename, style=style,
Expand Down Expand Up @@ -1849,35 +1769,43 @@ def assign_parameters(self, param_dict, inplace=False):

Examples:

>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> circuit = QuantumCircuit(2)
>>> params = [Parameter('A'), Parameter('B'), Parameter('C')]
>>> circuit.ry(params[0], 0)
>>> circuit.crx(params[1], 0, 1)
>>> circuit.draw()
┌───────┐
q_0: |0>┤ Ry(A) ├────■────
└───────┘┌───┴───┐
q_1: |0>─────────┤ Rx(B) ├
└───────┘
>>> circuit.assign_parameters({params[0]: params[2]}, inplace=True)
>>> circuit.draw()
┌───────┐
q_0: |0>┤ Ry(C) ├────■────
└───────┘┌───┴───┐
q_1: |0>─────────┤ Rx(B) ├
└───────┘
>>> bound_circuit = circuit.assign_parameters({params[1]: 1, params[2]: 2})
>>> bound_circuit.draw()
┌───────┐
q_0: |0>┤ Ry(2) ├────■────
└───────┘┌───┴───┐
q_1: |0>─────────┤ Rx(1) ├
└───────┘
>>> bound_circuit.parameters # this one has no free parameters anymore
set()
>>> circuit.parameters # the original one is still parameterized
{Parameter(A), Parameter(C)}
Create a parameterized circuit and assign the parameters in-place.

.. jupyter-execute::

from qiskit.circuit import QuantumCircuit, Parameter

circuit = QuantumCircuit(2)
params = [Parameter('A'), Parameter('B'), Parameter('C')]
circuit.ry(params[0], 0)
circuit.crx(params[1], 0, 1)

print('Original circuit:')
print(circuit.draw())

circuit.assign_parameters({params[0]: params[2]}, inplace=True)

print('Assigned in-place:')
print(circuit.draw())

Bind the values out-of-place and get a copy of the original circuit.

.. jupyter-execute::

from qiskit.circuit import QuantumCircuit, ParameterVector

circuit = QuantumCircuit(2)
params = ParameterVector('P', 2)
circuit.ry(params[0], 0)
circuit.crx(params[1], 0, 1)

bound_circuit = circuit.assign_parameters({params[0]: 1, params[1]: 2})
print('Bound circuit:')
print(bound_circuit.draw())

print('The original circuit is unchanged:')
print(circuit.draw())

"""
# replace in self or in a copy depending on the value of in_place
bound_circuit = self if inplace else self.copy()
Expand Down