search

Qulacs-Osaka / scikit-qulacs

scikit-qulacs is a library for quantum neural network. This library is based on qulacs and named after scikit-learn.
https://qulacs-osaka.github.io/scikit-qulacs/index.html
MIT License
19 stars 6 forks source link

fix docstring for QNNClassifier #248

Closed terasakisatoshi closed 1 year ago

terasakisatoshi commented 1 year ago

It seems the current docstring in QNNClassifier is not consistent with the actual usage of that. Indeed we get:

image

Let's update this.

forest1040 commented 1 year ago

Thank you!

codecov[bot] commented 1 year ago

Codecov Report

Merging #248 (669b326) into main (fe1107f) will decrease coverage by 0.05%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #248      +/-   ##
==========================================
- Coverage   92.17%   92.12%   -0.06%     
==========================================
  Files          12       12              
  Lines         920      914       -6     
  Branches      176      174       -2     
==========================================
- Hits          848      842       -6     
  Misses         41       41              
  Partials       31       31
Impacted Files Coverage Δ
skqulacs/qnn/classifier.py 90.78% <ø> (-0.12%) :arrow_down:
skqulacs/circuit/circuit.py 82.38% <0.00%> (-0.40%) :arrow_down:
skqulacs/qnn/regressor.py 81.39% <0.00%> (-0.22%) :arrow_down:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more