qiskit-machine-learning
qiskit-machine-learning copied to clipboard
Improved content for Tutorial 1 (QAMP fall'22)
Summary
Enhancing the documentation of Tutorial "01_neural_networks" as a mentee for QAMP 2022. Mentor: @ElePT Mentee: @SanyaNanda
Details and comments
- Restructured the notebook (Objective, Introduction, Tutorial and what was learned)
- Imports placed where required
- Added Detailed Explanations for OpflowQNN, TwoLayerQNN and CircuitQNN like steps to follow when constructing the neural network etc using the API reference
- Inline comments for better understanding of the code and arguments used in function
- Hyperlinks to API references wherever required
Hi @SanyaNanda , thank you for the tutorial improvements.
Before commiting code/tutorials, we run make black
that reformats the code/tutorials against some standard rules. I ran it against your tutorial.
Also, we don't use custom kernels in tutorials as they will be run automatically by the CI and by other people that won't have them. I removed the custom kernel and used the Python3.
Hi @manoelmarques
Thankyou for the guidance, will keep these points in mind for future commits
Pull Request Test Coverage Report for Build 3271788878
- 0 of 0 changed or added relevant lines in 0 files are covered.
- No unchanged relevant lines lost coverage.
- Overall coverage remained the same at 88.404%
Totals | |
---|---|
Change from base Build 3265936974: | 0.0% |
Covered Lines: | 3263 |
Relevant Lines: | 3691 |
💛 - Coveralls
Thanks for taking care of this. The 01 tutorial was significantly changed. Could you please merge your work with the latest version of the tutorial? I can help if you have issues.
Thank you! I will do this and get in touch in case of queries