Skip to content

[Docs] Fix TOCs and update QNN derived primitives #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 2, 2024

Conversation

edoaltamura
Copy link
Collaborator

Summary

Added the elements from Qiskit Algorithms to the top-level TOC.

Fixed the docstrings for Sampler/EstimatorQNN and added a note on default V1 primitives.

Scattered clean-up of other sections of the docs.

Details and comments

This PR is part of the broader docs update of #846.

@edoaltamura edoaltamura added stable backport potential The bug might be minimal and/or import enough to be port to stable documentation 📖 labels Nov 26, 2024
@edoaltamura edoaltamura added this to the v.0.8.1 milestone Nov 26, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 12053405030

Details

  • 2 of 3 (66.67%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.496%

Changes Missing Coverage Covered Lines Changed/Added Lines %
qiskit_machine_learning/optimizers/spsa.py 2 3 66.67%
Totals Coverage Status
Change from base Build 12022513230: 0.0%
Covered Lines: 4304
Relevant Lines: 4756

💛 - Coveralls

@OkuyanBoga OkuyanBoga merged commit 698b9f0 into qiskit-community:main Dec 2, 2024
15 checks passed
@OkuyanBoga OkuyanBoga deleted the docs-patch-25nov branch December 2, 2024 14:58
mergify bot pushed a commit that referenced this pull request Dec 2, 2024
* Fix docs and update QNN derived primitives

* Fix LearningRate in TOCs

* Fix string formatting

* Fix spelling

* Fix spelling

* Fix spelling

* Fix copyright

(cherry picked from commit 698b9f0)
OkuyanBoga added a commit that referenced this pull request Dec 9, 2024
* Fix StackOverflow formatting typo in `README.md` (#847)

* Fix StackOverflow formatting typo

* Bump numpy version to 2

* Post release 0.8 (#844)

* Change version and activate stable tutorial tests

* Bump VERSION.txt

* Cleanup and bugfix to support different primitives. (#55) (#855)

* Cleanup and bugfix for different primitives support (#55)

* Quick fix and lint for unit tests.

* Fixed a bug in ComputeUncompute and lint corrections.

* Fix formatting for algorithm tests

* Reformatting some variables to make lint compliant.

* Refactor: Cleanup code, preserve existing formatting, apply minor bug fixes, and update missing documentation

* Removing unsupported classes.

* Fix for lint

* Fix lint errors uncovered during workflow checks

* Adjust a unit test to accomodate noise-related variations

* Docs 0p8 clean (#857)

* Reducing numpy version for deploy-docs.yml to fix numpy 2.0 bug (#851)

* Update deploy-docs.yml (#853)

- Updated Python version from 3.9 to 3.10.
- Removed version constraint on torchvision.
- Removed Numpy version constraint.

* Update deploy-docs.yml to '3.10' (#854)

---------

Co-authored-by: M. Emre Sahin <[email protected]>
Co-authored-by: Oscar <[email protected]>

* Remove `fastdtw` (#861)

* ci(mergify): upgrade configuration to current format (#860)

Co-authored-by: Mergify <37929162+mergify[bot]@users.noreply.github.com>

* [Docs] Fix TOCs and update QNN derived primitives (#862)

* Fix docs and update QNN derived primitives

* Fix LearningRate in TOCs

* Fix string formatting

* Fix spelling

* Fix spelling

* Fix spelling

* Fix copyright

* Pin Qiskit to `<1.3` (#865)

* Added callback function support for adam-amsgrad optimizer. (#869)

* Added callback functionality to ADAM optimiser

* Added unittest for callback function

* Cumulative update to extend the V2 support for algorithms, updated tutorials, and partial multiclass support for VQC. (#870)

* Added migration guide for 0.8

* Added V2 support for algorithms

* V2 support added for unit tests of the algorithms and tutorials are updated for V2

* Spell check and lint

* Update 02_migration_guide_0.8.rst

* Update 02_migration_guide_0.8.rst

adding optimisation level

* Bugfix for V2 primitives without transpilation

* Fix tutorials and release notes

* Update 04_torch_qgan.ipynb

* Bugfix for Qiskit 1.x register name ambiguity

* Restored docs

* Typo fix in gradients

---------

Co-authored-by: smens <[email protected]>
Co-authored-by: Oscar <[email protected]>

* Add predict_proba Support to PegasosQSVC and NeuralNetworkClassifier (#871)

* Adding a predict_proba function to classifiers. (#57)

* Update README.md

* Predict proba for NNC and PegQSVC

* Rewriting predict proba features and docstring

It was very inefficient before and didn't have the validation checks needed. The code is now more clear and docstring has been added.

* Tweak documentation for NNC and PegasosQSVC, silence lint E1101 on torch connector

* Update test with `QNN.predict_proba`

* Update test with `PegasosESVC.predict_proba`

* Added a release note and solved conflicts with main

---------

Co-authored-by: FrancescaSchiav <[email protected]>
Co-authored-by: oscar-wallis <[email protected]>
Co-authored-by: Edoardo Altamura <[email protected]>
Co-authored-by: smens <[email protected]>

* Reformatted docs

* Fix usage of sklearn

---------

Co-authored-by: FrancescaSchiav <[email protected]>
Co-authored-by: oscar-wallis <[email protected]>
Co-authored-by: Edoardo Altamura <[email protected]>
Co-authored-by: smens <[email protected]>

* Bump version to 0.8.1

Update version for bug-fix release

---------

Co-authored-by: Edoardo Altamura <[email protected]>
Co-authored-by: Oscar <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: smens <[email protected]>
Co-authored-by: FrancescaSchiav <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants