Add user guide qnn - Githubissues

sQUlearn / squlearn

scikit-learn interface for quantum algorithms

https://squlearn.github.io

Apache License 2.0

58 stars 18 forks source link

Add user guide qnn #139

Closed MoritzWillmann closed 1 year ago

MoritzWillmann commented 1 year ago

This is my initial suggestion, I'm happy to take any kind of notes.

This PR solves #115

rothma commented 1 year ago

What's the status of this PR?

MoritzWillmann commented 1 year ago

What's the status of this PR?

It would be good if someone could proofread this. I only set it to WIP so it doesn't get merged yet

David-Kreplin commented 1 year ago

I will take care of this next week, since I was originally assigned to this task.

David-Kreplin commented 1 year ago

I added some first edits untio the optimization section

David-Kreplin commented 1 year ago

I reviewed and edited the qnn user guide:

Add an example how to initilize the QNN class
Changed the plot from svg to dynamically constructed once
Overall edits and corrections of what has been written.

From my side, that is finished and can be merged.

David-Kreplin commented 1 year ago

Unfortunatly referencing the figures does not work for the matplotlib output. I did some research, but couldn't figure out how that is done, so I just changed the caption and the reference in the text

MoritzWillmann commented 1 year ago

Unfortunatly referencing the figures does not work for the matplotlib output. I did some research, but couldn't figure out how that is done, so I just changed the caption and the reference in the text

This still looks a bit weird, I'll try to fix it. Honestly I'm not entirely sure if I like the plot directive too much...

David-Kreplin commented 1 year ago

Unfortunatly referencing the figures does not work for the matplotlib output. I did some research, but couldn't figure out how that is done, so I just changed the caption and the reference in the text

This still looks a bit weird, I'll try to fix it. Honestly I'm not entirely sure if I like the plot directive too much...

Great thing about the plot directive is, that is done dynamically, hence when things are changing, wo don't have to produce another svg manually. Better improvement would be, if all plot / python codes are in files, so that search and replace / refactor would work if we rename stuff.

MoritzWillmann commented 1 year ago

I just fixed the numbering of the captions. From my side everything looks good 🎉