Integration of Mitiq's ZNE

victor-onofre commented 4 months ago

Description

Integrate Mitiq into OpenQAOA to allow error mitigation techniques to take place during the execution of the QAOA. We have created a wrapper focusing on the ZNE technique following a similar structure to the SPAM Twirling wrapper.
- This is a project born from the Quantum Open Source Foundation Mentorship program
- New dependency to add: Mitiq
- Fixes #207

Checklist

[x] I have performed a self-review of my code.
[x] I have commented my code and used numpy-style docstrings
[ ] I have made corresponding updates to the documentation.
[x] My changes generate no new warnings
[ ] I have added/updated tests to make sure bugfix/feature works.
[x] New and existing unit tests pass locally with my changes.

Type of change

Please delete options that are not relevant.

[x] New feature (non-breaking change which adds functionality)
[x] This change requires a documentation update

How Has This Been Tested?

We have been testing the wrapper with the Max Cut problem but we need help on defining unit-tests. What will be the best test to add?

victor-onofre commented 4 months ago

Hi! As I mentioned in the description, we need some help defining the unit tests for the integration. At the moment, we are running multiple tests with the Max Cut problem using a noise model, and different parameters of the ZNE. We are using depolarizing noise with 1-qubit gate error of 0.0001989 and 2-qubit gate error of 0.007905.

victor-onofre commented 3 months ago

Hi @KilianPoirier,

All the comments have been addressed, and the dev branch has been merged. We have added two tests similar to the SPAM wrapper, it is still necessary to add a couple more, and we plan to do it next week. I think you can now review all these changes.

The example notebook is a good idea. Do we do that in this PR or create another one?

Thanks!

KilianPoirier commented 3 months ago

Concerning the example notebook, feel free to add them to this PR since everything is related to the feature you're developing.

victor-onofre commented 3 months ago

Hi @KilianPoirier,

I have added mitiq to the requirements, but the tests are still waiting for approval. Some of the previous errors were related to that issue.

We are going to work on the example notebooks and the rest of the tests.

Thanks!

KilianPoirier commented 3 months ago

Hi @victor-onofre ,

Thanks for updating the requirements. Good news, the tests are passing! Let me know when you implement your own tests and the example notebook.

victor-onofre commented 2 months ago

Hi @KilianPoirier! We have push an update with the example notebook and the tests. Now is ready for another review.

Thanks!

KilianPoirier commented 2 months ago

Hey @victor-onofre , it seems the regular tests are failing now.

It is most likely due to the use of images in your example notebook. Can you try copying the images directly in the notebook without using PIL? I believe that if the notebook is ran correctly and the image is resolved, the image itself will be tracked in the notebook without a need to import it.

I will also have a look at the docs and let you know if I find anything.

AdrianoLusso commented 1 month ago

Hi @KilianPoirier! We have followed the two recommendations you give us to solve the docs issue (not using PIL and adding the line in openqaoa/docs/source/index.rst). We have also solved the other secondary issues.

Thanks for your feedback!

entropicalabs / openqaoa