Add `GHZ` circuit function #1499

mho291 · 2024-10-22T12:19:15Z

Checklist:

Reviewers confirm new code works as expected.
Tests are passing.
Coverage does not decrease.
Documentation is updated.

codecov · 2024-10-22T13:09:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.93%. Comparing base (45eae7f) to head (bbb6da4).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1499   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          81       81           
  Lines       11907    11914    +7     
=======================================
+ Hits        11899    11906    +7     
  Misses          8        8

Flag	Coverage Δ
unittests	`99.93% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/qibo/models/encodings.py

tests/test_models_encodings.py

renatomello · 2024-10-23T05:31:57Z

@mho291 addition to api reference is missing

doc/source/api-reference/qibo.rst

src/qibo/models/encodings.py

tests/test_models_encodings.py

doc/source/api-reference/qibo.rst

src/qibo/models/encodings.py

renatomello · 2024-10-24T05:36:08Z

src/qibo/models/encodings.py

+
+
+def ghz_state(nqubits: int, **kwargs):
+    """Generates an :math:`n`-qubits Greenberger-Horne-Zeilinger (GHZ) state that takes the form


Suggested change

"""Generates an :math:`n`-qubits Greenberger-Horne-Zeilinger (GHZ) state that takes the form

"""Generate a circuit that encodes a :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state.

This state that takes the form

@mho291 a tip: you can click the "Commit suggestion" button here to directly commit a suggestion to the code instead of changing things locally and then pushing it. It also helps to track which changes were already implemented.

Thanks @renatomello ! I wanted to do extra checks for the documentation, so I did it locally and generated the html file. :)

src/qibo/models/encodings.py

renatomello

@mho291 After you address my latest docstring comments, this is ready to go on my end.

mho291 · 2024-10-24T05:56:41Z

@mho291 After you address my latest docstring comments, this is ready to go on my end.

Thanks a lot @renatomello , I have modified the docstring accordingly.

scarrazza · 2024-10-25T09:28:19Z

@MatteoRobbiati could you please have another look?

MatteoRobbiati

Thanks! LGTM.
A few (minor) suggestions follow.

MatteoRobbiati · 2024-10-25T14:30:40Z

src/qibo/models/encodings.py

+    """Generates an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form
+


Suggested change

"""Generates an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form

"""Generate an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form

src/qibo/models/encodings.py

Co-authored-by: Matteo Robbiati <[email protected]>

HuberyMing · 2024-10-29T10:33:13Z

@mho291 Thank you for the addition of the GHZ circuit in models.encodings. I am going to use the added feature but found the following error:
ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py)

when I am importing it in my file head as

from qibo.models.encodings import (
comp_basis_encoder,
entangling_layer,
ghz_state,
phase_encoder,
unary_encoder,
unary_encoder_random_gaussian,
)

and it will cause no problem of importing if I am using

from qibo.models.encodings import (
comp_basis_encoder,
entangling_layer,
#ghz_state,
phase_encoder,
unary_encoder,
unary_encoder_random_gaussian,
)

How should I solve this problem? Thanks.

renatomello · 2024-10-29T10:49:09Z

Are you using the newest version of qibo?

…

On Tue, 29 Oct 2024 at 14:33, HuberyMing ***@***.***> wrote: @mho291 <https://github.com/mho291> Thank you for the addition of the GHZ circuit in models.encodings. I am going to use the added feature but found the following error: ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py) when I am importing it in my file head as from qibo.models.encodings import ( comp_basis_encoder, entangling_layer, ghz_state, phase_encoder, unary_encoder, unary_encoder_random_gaussian, ) and it will cause no problem of importing if I am using from qibo.models.encodings import ( comp_basis_encoder, entangling_layer, #ghz_state, phase_encoder, unary_encoder, unary_encoder_random_gaussian, ) How should I solve this problem? Thanks. — Reply to this email directly, view it on GitHub <#1499 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABH5QVUY4FHT5GWOHK22Q4TZ55P77AVCNFSM6AAAAABQMLS32SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINBTHA2DAMBZGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

HuberyMing · 2024-10-29T10:52:13Z

Are you using the newest version of qibo?
I have pulled the newest master branch and merge it into my_new_test_branch. Is that correct?

HuberyMing · 2024-10-29T10:59:25Z

Are you using the newest version of qibo?
I have pulled the newest master branch and merge it into my_new_test_branch. Is that correct?

Actually, even if I am in the newest master branch, it still does not work.

$ git pull origin master
From https://github.com/HuberyMing/qibo

branch master -> FETCH_HEAD
Already up to date.

$ python test_noise.py
$ python test_models_encodings.py
Traceback (most recent call last):
File "/Users/mervyn/Library/CloudStorage/OneDrive-個人/Gsuite_NSYSU/4.QC_research/0.HH_work/B1.code/HHQC2024/qibo/tests/test_models_encodings.py", line 11, in
from qibo.models.encodings import (
ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py)

renatomello · 2024-10-29T11:06:36Z

Are you using the newest version of qibo?
I have pulled the newest master branch and merge it into my_new_test_branch. Is that correct?

Actually, even if I am in the newest master branch, it still does not work.

$ git pull origin master From https://github.com/HuberyMing/qibo
* branch                master     -> FETCH_HEAD
  Already up to date.
$ python test_noise.py $ python test_models_encodings.py Traceback (most recent call last): File "/Users/mervyn/Library/CloudStorage/OneDrive-個人/Gsuite_NSYSU/4.QC_research/0.HH_work/B1.code/HHQC2024/qibo/tests/test_models_encodings.py", line 11, in from qibo.models.encodings import ( ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py)

I have the master installed locally and it works for me.

HuberyMing · 2024-10-29T11:13:58Z

Are you using the newest version of qibo?
I have pulled the newest master branch and merge it into my_new_test_branch. Is that correct?

Actually, even if I am in the newest master branch, it still does not work.
$ git pull origin master From https://github.com/HuberyMing/qibo
* branch                master     -> FETCH_HEAD
  Already up to date.
$ python test_noise.py $ python test_models_encodings.py Traceback (most recent call last): File "/Users/mervyn/Library/CloudStorage/OneDrive-個人/Gsuite_NSYSU/4.QC_research/0.HH_work/B1.code/HHQC2024/qibo/tests/test_models_encodings.py", line 11, in from qibo.models.encodings import ( ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py)
I have the master installed locally and it works for me.

Okay. Currently I am using qibo 0.2.12. I will create a new environment and see if it works later. Thanks.

Python 3.11.9 (main, Apr 19 2024, 11:43:47) [Clang 14.0.6 ] on darwin
Type "help", "copyright", "credits" or "license" for more information.

import qibo
qibo.version
'0.2.12'

HuberyMing · 2024-10-29T11:29:33Z

Are you using the newest version of qibo?
I have pulled the newest master branch and merge it into my_new_test_branch. Is that correct?

Actually, even if I am in the newest master branch, it still does not work.
$ git pull origin master From https://github.com/HuberyMing/qibo
* branch                master     -> FETCH_HEAD
  Already up to date.
$ python test_noise.py $ python test_models_encodings.py Traceback (most recent call last): File "/Users/mervyn/Library/CloudStorage/OneDrive-個人/Gsuite_NSYSU/4.QC_research/0.HH_work/B1.code/HHQC2024/qibo/tests/test_models_encodings.py", line 11, in from qibo.models.encodings import ( ImportError: cannot import name 'ghz_state' from 'qibo.models.encodings' (/opt/anaconda3/envs/qiskit10/lib/python3.11/site-packages/qibo/models/encodings.py)
I have the master installed locally and it works for me.
Okay. Currently I am using qibo 0.2.12. I will create a new environment and see if it works later. Thanks.

Python 3.11.9 (main, Apr 19 2024, 11:43:47) [Clang 14.0.6 ] on darwin Type "help", "copyright", "credits" or "license" for more information.

import qibo
qibo.version
'0.2.12'

It works when I created a whole new environment. Probably that is because of the qibo version as you said. The qibo 0.2.13 works for it now.

renatomello · 2024-10-29T11:32:19Z

It works when I created a whole new environment. Probably that is because of the qibo version as you said. The qibo 0.2.13 works for it now.

Release 0.2.12 was released prior to the GHZ PR. So now the ghz function is in release 0.2.13 as well as the master branch.

HuberyMing · 2024-10-29T12:31:12Z

It works when I created a whole new environment. Probably that is because of the qibo version as you said. The qibo 0.2.13 works for it now.

Release 0.2.12 was released prior to the GHZ PR. So now the ghz function is in release 0.2.13 as well as the master branch.

I see. Thank you for the explanation.

mho291 added 2 commits October 22, 2024 20:17

Add GHZ circuit function

a708c3f

Add pytest for GHZ circuit

5e3f082

mho291 added 3 commits October 22, 2024 21:28

Added error if nqubits < 2

6ed3b7c

Added test for nqubits < 2

a5d4cbb

Update tests

7fc5277

mho291 marked this pull request as ready for review October 23, 2024 00:35

renatomello assigned mho291 Oct 23, 2024

renatomello self-requested a review October 23, 2024 05:14

renatomello reviewed Oct 23, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 23, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 23, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 23, 2024

View reviewed changes

tests/test_models_encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 23, 2024

View reviewed changes

tests/test_models_encodings.py Outdated Show resolved Hide resolved

renatomello self-requested a review October 23, 2024 06:41

renatomello added this to the Qibo 0.2.14 milestone Oct 23, 2024

MatteoRobbiati self-requested a review October 23, 2024 09:20

mho291 added 2 commits October 23, 2024 17:26

Add documentation for ghz state

d18f30c

Update ghz_state and tests

15db36c

renatomello reviewed Oct 23, 2024

View reviewed changes

doc/source/api-reference/qibo.rst Outdated Show resolved Hide resolved

mho291 added 2 commits October 23, 2024 18:16

Corrected a typo

c7cc871

Corrected documentation

72717d9

renatomello reviewed Oct 23, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello self-requested a review October 23, 2024 10:32

Edited docstring

77a73ad

renatomello reviewed Oct 23, 2024

View reviewed changes

tests/test_models_encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 23, 2024

View reviewed changes

doc/source/api-reference/qibo.rst Outdated Show resolved Hide resolved

mho291 added 2 commits October 23, 2024 21:45

Added **kwargs in Circuit

fddf08d

Shifted documentation to Encoders

5135646

Merge branch 'master' into ghz

ea8db3b

renatomello reviewed Oct 24, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello reviewed Oct 24, 2024

View reviewed changes

src/qibo/models/encodings.py Outdated Show resolved Hide resolved

renatomello modified the milestones: Qibo 0.2.14, Qibo 0.2.13 Oct 24, 2024

renatomello self-requested a review October 24, 2024 05:40

renatomello changed the title ~~Add GHZ circuit function~~ Add GHZ circuit function Oct 24, 2024

renatomello added 2 commits October 24, 2024 09:41

remove unnecessary else

3d49da7

move function to before helper functions

be3d11f

renatomello approved these changes Oct 24, 2024

View reviewed changes

Edited docstring

bbb6da4

renatomello linked an issue Oct 25, 2024 that may be closed by this pull request

Add GHZ state to models.encodings #1496

Closed

MatteoRobbiati approved these changes Oct 25, 2024

View reviewed changes

Update src/qibo/models/encodings.py

ca60373

Co-authored-by: Matteo Robbiati <[email protected]>

scarrazza added this pull request to the merge queue Oct 26, 2024

Merged via the queue into master with commit 473bcf7 Oct 26, 2024
25 checks passed

renatomello deleted the ghz branch October 28, 2024 05:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `GHZ` circuit function #1499

Add `GHZ` circuit function #1499

mho291 commented Oct 22, 2024 •

edited by renatomello

Loading

codecov bot commented Oct 22, 2024 •

edited

Loading

renatomello commented Oct 23, 2024

renatomello Oct 24, 2024 •

edited

Loading

renatomello Oct 24, 2024

mho291 Oct 25, 2024

renatomello left a comment

mho291 commented Oct 24, 2024

scarrazza commented Oct 25, 2024

MatteoRobbiati left a comment

MatteoRobbiati Oct 25, 2024

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024 via email

HuberyMing commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024

HuberyMing commented Oct 29, 2024



		def ghz_state(nqubits: int, **kwargs):
		"""Generates an :math:`n`-qubits Greenberger-Horne-Zeilinger (GHZ) state that takes the form

-    """Generates an :math:`n`-qubits Greenberger-Horne-Zeilinger (GHZ) state that takes the form
+    """Generate a circuit that encodes a :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state.
+    This state that takes the form

		"""Generates an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form

	"""Generates an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form
	"""Generate an :math:`n`-qubit Greenberger-Horne-Zeilinger (GHZ) state that takes the form

Add GHZ circuit function #1499

Add GHZ circuit function #1499

Conversation

mho291 commented Oct 22, 2024 • edited by renatomello Loading

codecov bot commented Oct 22, 2024 • edited Loading

Codecov Report

renatomello commented Oct 23, 2024

renatomello Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

renatomello Oct 24, 2024

Choose a reason for hiding this comment

mho291 Oct 25, 2024

Choose a reason for hiding this comment

renatomello left a comment

Choose a reason for hiding this comment

mho291 commented Oct 24, 2024

scarrazza commented Oct 25, 2024

MatteoRobbiati left a comment

Choose a reason for hiding this comment

MatteoRobbiati Oct 25, 2024

Choose a reason for hiding this comment

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024 via email

HuberyMing commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

renatomello commented Oct 29, 2024

HuberyMing commented Oct 29, 2024

Add `GHZ` circuit function #1499

Add `GHZ` circuit function #1499

mho291 commented Oct 22, 2024 •

edited by renatomello

Loading

codecov bot commented Oct 22, 2024 •

edited

Loading

renatomello Oct 24, 2024 •

edited

Loading