Qcnn upgrade #1083

jykhoo1987 · 2023-11-09T10:53:20Z

Checklist:

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

3 'upgrades' implemented in qcnn class:

arbitrary 2-qubit circuit can be used as input during initialization which will be used as the base circuit when building the convolution layer
minimization is now implemented via qibo.optimizers.optimize, whereas it was only scipy.minimize previously
introduced a flag to make copy of initial state during initialization. By default, it will check backend during class initialization and be turned on if backend is qibojit to get around the in-place update issue.

Credits to @rahula06 for implementing most of these changes.

We will work on the updated documentation and make a separate pull request for that.

1. Now accepts arbitrary 2-qubit circuit blocks as input 2. Switched from scipy.optimize.minimize to qibo.optimizers.optimize

Update test for qcnn upgrade: 1. Now accepts arbitrary 2-qubit circuit blocks as input 2. Switched from scipy.optimize.minimize to qibo.optimizers.optimize

correction

fix pytest

fix #print

fix pytest for 100% coverage of updated qcnn class

install tensorflow

remove backend settings in minimize

remove explicit sgd check since use case follows as per qibo.optimizer.optimize

make initial state copy in Predictions function if backend is qibojit

test qibojit backend case to create copy of initial state

add import qibo to check backend

add copy flag during initialization

for more information, see https://pre-commit.ci

codecov · 2023-11-09T10:55:35Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (ea72695) 100.00% compared to head (40e39d1) 99.97%.
Report is 135 commits behind head on master.

Files	Patch %	Lines
src/qibo/models/qcnn.py	93.10%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##            master    #1083      +/-   ##
===========================================
- Coverage   100.00%   99.97%   -0.03%     
===========================================
  Files           68       68              
  Lines         9790     9803      +13     
===========================================
+ Hits          9790     9801      +11     
- Misses           0        2       +2

Flag	Coverage Δ
unittests	`99.97% <93.10%> (-0.03%)`	⬇️

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.

MatteoRobbiati

Many thanks @jykhoo1987 for implementing this.
Some comments follow.

src/qibo/models/qcnn.py

tests/test_models_qcnn.py

MatteoRobbiati · 2023-11-17T16:26:25Z

tests/test_models_qcnn.py

@@ -303,3 +305,47 @@ def test_qcnn_training():
    predictions.append(1)
    labels = np.array([[1], [-1], [1]])
    test_qcnn.Accuracy(labels, predictions)
+
+
+def test_two_qubit_ansatz():


I would pass backend as argument of the tests here. With this you will execute the tests in all the backends. Now that the qibojit in-place update is fixed in the main of the qcnn model, all the tests should pass.

I think it suffices if we test the backends for the training, so we can keep it to the tests that involve training maybe

It always better to test the code for all the available backends, in order not to have surprises if an external user decides to use this model with, e.g. tensorflow and training it with some automatic differentiation method.

You only need to add backend as an argument of your tests, e.g.:

def test_two_qubit_ansatz(backend): # same code here

tests/test_models_qcnn.py

src/qibo/models/qcnn.py

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

scarrazza · 2023-12-01T11:43:45Z

@jykhoo1987 I will wait for your change until later today, if you do not manage we postpone this feature for the next release.

jykhoo1987 · 2023-12-06T08:58:39Z

Apologies for the delay. @rahula06 will look into the rest of this PR later this week when he is back from leave.

update in response to comments.

for more information, see https://pre-commit.ci

The last two training tests now test both qibojit and numpy backends.

for more information, see https://pre-commit.ci

…qcnn_upgrade

for more information, see https://pre-commit.ci

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into qcnn_upgrade

for more information, see https://pre-commit.ci

codecov-commenter · 2024-02-06T09:00:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ea72695) 100.00% compared to head (894f6d9) 100.00%.
Report is 296 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #1083   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           68        68           
  Lines         9790      9803   +13     
=========================================
+ Hits          9790      9803   +13

Flag	Coverage Δ
unittests	`100.00% <100.00%> (ø)`

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.

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into qcnn_upgrade

rahula06 · 2024-02-06T10:21:36Z

It seems that going back to the old test works, so that the qibojit backend test is indeed working. My best guess is that the codecov tool might not be able to evaluate these pytest fixtures very well. If you are okay, we could just keep the tests with the explicit parametrization to pass the checks. If anyone has better knowledge of how codecov works or could suggest an alternative, that would be great too :)

MatteoRobbiati

Thanks, a few comments follow.
Then I think we are ready :)

src/qibo/models/qcnn.py

tests/test_models_qcnn.py

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

rahula06 · 2024-02-06T17:26:52Z

Thanks, a few comments follow. Then I think we are ready :)

fixed, and still seems to pass all the tests!

MatteoRobbiati

Thanks.

jykhoo1987 and others added 15 commits November 1, 2023 19:56

Update qcnn.py

a8aea99

1. Now accepts arbitrary 2-qubit circuit blocks as input 2. Switched from scipy.optimize.minimize to qibo.optimizers.optimize

Update test_models_qcnn.py

fa205a2

Update test for qcnn upgrade: 1. Now accepts arbitrary 2-qubit circuit blocks as input 2. Switched from scipy.optimize.minimize to qibo.optimizers.optimize

Update test_models_qcnn.py

eb12cad

correction

Update test_models_qcnn.py

c369f57

Update test_models_qcnn.py

8cb02f7

fix pytest

Update qcnn.py

fecdcb8

fix #print

Update test_models_qcnn.py

321c167

fix pytest for 100% coverage of updated qcnn class

Update test_models_qcnn.py

8d6fdaa

install tensorflow

Update qcnn.py

3aac965

remove backend settings in minimize

Update test_models_qcnn.py

470622a

remove explicit sgd check since use case follows as per qibo.optimizer.optimize

Update qcnn.py

d61ed16

make initial state copy in Predictions function if backend is qibojit

Update test_models_qcnn.py

5d0139f

test qibojit backend case to create copy of initial state

Update qcnn.py

baa44b3

add import qibo to check backend

Update qcnn.py

fe22938

add copy flag during initialization

[pre-commit.ci] auto fixes from pre-commit.com hooks

ae83dbc

for more information, see https://pre-commit.ci

MatteoRobbiati requested review from MatteoRobbiati and Edoardo-Pedicillo November 15, 2023 08:08

MatteoRobbiati requested changes Nov 17, 2023

View reviewed changes

rahula06 and others added 2 commits November 23, 2023 10:47

remove dividend from src/qibo/models/qcnn.py

fb49d45

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

Update src/qibo/models/qcnn.py

6af5b68

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

scarrazza added this to the Qibo 0.2.3 milestone Nov 29, 2023

scarrazza modified the milestones: Qibo 0.2.3, Qibo 0.2.4 Dec 1, 2023

rahula06 and others added 4 commits December 11, 2023 02:46

Update qcnn.py

cff29f8

update in response to comments.

[pre-commit.ci] auto fixes from pre-commit.com hooks

ce5441e

for more information, see https://pre-commit.ci

Update test_models_qcnn.py

bbae846

The last two training tests now test both qibojit and numpy backends.

[pre-commit.ci] auto fixes from pre-commit.com hooks

09d7e01

for more information, see https://pre-commit.ci

pre-commit-ci bot and others added 10 commits January 23, 2024 07:50

[pre-commit.ci] auto fixes from pre-commit.com hooks

de0d253

for more information, see https://pre-commit.ci

Conftest test

27eefac

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into …

150646d

…qcnn_upgrade

Update pyproject.toml

d578f96

Explicitly add the fixture

bd994ec

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into …

5672019

…qcnn_upgrade

[pre-commit.ci] auto fixes from pre-commit.com hooks

40e39d1

for more information, see https://pre-commit.ci

Test old test_qcnn

1c538ed

test

2e5fd50

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into qcnn_upgrade

[pre-commit.ci] auto fixes from pre-commit.com hooks

cdabfea

for more information, see https://pre-commit.ci

Rahul Arvind added 2 commits February 6, 2024 17:10

even older testing

92a8183

test

7700634

Merge branch 'qcnn_upgrade' of https://github.com/qiboteam/qibo into qcnn_upgrade

MatteoRobbiati self-requested a review February 6, 2024 10:34

MatteoRobbiati requested changes Feb 6, 2024

View reviewed changes

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

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

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

tests/test_models_qcnn.py Outdated Show resolved Hide resolved

rahula06 and others added 4 commits February 6, 2024 23:58

Update src/qibo/models/qcnn.py

d9a3baa

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

Update src/qibo/models/qcnn.py

6096424

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

Update src/qibo/models/qcnn.py

643752c

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

Update tests/test_models_qcnn.py

894f6d9

Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>

MatteoRobbiati self-requested a review February 7, 2024 07:16

MatteoRobbiati approved these changes Feb 7, 2024

View reviewed changes

MatteoRobbiati enabled auto-merge February 7, 2024 09:04

renatomello added the enhancement New feature or request label Feb 7, 2024

renatomello approved these changes Feb 7, 2024

View reviewed changes

MatteoRobbiati added this pull request to the merge queue Feb 7, 2024

Merged via the queue into master with commit 3f367cc Feb 7, 2024
21 checks passed

renatomello deleted the qcnn_upgrade branch February 7, 2024 09:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Qcnn upgrade #1083

Qcnn upgrade #1083

jykhoo1987 commented Nov 9, 2023 •

edited by renatomello

Loading

codecov bot commented Nov 9, 2023 •

edited

Loading

MatteoRobbiati left a comment

MatteoRobbiati Nov 17, 2023

rahula06 Dec 10, 2023

MatteoRobbiati Dec 21, 2023

scarrazza commented Dec 1, 2023

jykhoo1987 commented Dec 6, 2023

codecov-commenter commented Feb 6, 2024 •

edited

Loading

rahula06 commented Feb 6, 2024

MatteoRobbiati left a comment

rahula06 commented Feb 6, 2024

MatteoRobbiati left a comment

Qcnn upgrade #1083

Qcnn upgrade #1083

Conversation

jykhoo1987 commented Nov 9, 2023 • edited by renatomello Loading

codecov bot commented Nov 9, 2023 • edited Loading

Codecov Report

MatteoRobbiati left a comment

Choose a reason for hiding this comment

MatteoRobbiati Nov 17, 2023

Choose a reason for hiding this comment

rahula06 Dec 10, 2023

Choose a reason for hiding this comment

MatteoRobbiati Dec 21, 2023

Choose a reason for hiding this comment

scarrazza commented Dec 1, 2023

jykhoo1987 commented Dec 6, 2023

codecov-commenter commented Feb 6, 2024 • edited Loading

Codecov Report

rahula06 commented Feb 6, 2024

MatteoRobbiati left a comment

Choose a reason for hiding this comment

rahula06 commented Feb 6, 2024

MatteoRobbiati left a comment

Choose a reason for hiding this comment

jykhoo1987 commented Nov 9, 2023 •

edited by renatomello

Loading

codecov bot commented Nov 9, 2023 •

edited

Loading

codecov-commenter commented Feb 6, 2024 •

edited

Loading