qiskit-machine-learning icon indicating copy to clipboard operation
qiskit-machine-learning copied to clipboard

Improved content for Tutorial 1 (QAMP fall'22)

Open SanyaNanda opened this issue 2 years ago • 4 comments

Summary

Enhancing the documentation of Tutorial "01_neural_networks" as a mentee for QAMP 2022. Mentor: @ElePT Mentee: @SanyaNanda

Details and comments

  1. Restructured the notebook (Objective, Introduction, Tutorial and what was learned)
  2. Imports placed where required
  3. Added Detailed Explanations for OpflowQNN, TwoLayerQNN and CircuitQNN like steps to follow when constructing the neural network etc using the API reference
  4. Inline comments for better understanding of the code and arguments used in function
  5. Hyperlinks to API references wherever required

SanyaNanda avatar Sep 22 '22 09:09 SanyaNanda

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Sep 22 '22 09:09 CLAassistant

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.

manoelmarques avatar Sep 30 '22 15:09 manoelmarques

Hi @manoelmarques

Thankyou for the guidance, will keep these points in mind for future commits

SanyaNanda avatar Sep 30 '22 16:09 SanyaNanda

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 Coverage Status
Change from base Build 3265936974: 0.0%
Covered Lines: 3263
Relevant Lines: 3691

💛 - Coveralls

coveralls avatar Sep 30 '22 16:09 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.

adekusar-drl avatar Nov 04 '22 18:11 adekusar-drl

Thank you! I will do this and get in touch in case of queries

SanyaNanda avatar Nov 05 '22 14:11 SanyaNanda