Skip to content
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

Add documentation for supported functionality #2540

Merged
merged 50 commits into from
May 16, 2022

Conversation

eddddddy
Copy link
Contributor

@eddddddy eddddddy commented May 4, 2022

Context:
In general, the amount of configurations for QNodes is quite large, and due to the supported 5 interfaces, it is quite hard to estimate a priori which scenarios are supported, which can not be supported for mathematical/programmatical reasons and which are simply not yet supported because they haven't been implemented.

Description of the Change:
Provides an overview in the documentation that informs users about the supported scenarios, and explains which scenarios are conceptually unsupportable and why.

Benefits:
Better documentation and faster lookups.

Possible Drawbacks:

Related GitHub Issues:
Closes #1997

@codecov
Copy link

codecov bot commented May 4, 2022

Codecov Report

Merging #2540 (70090ba) into master (dd28293) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2540   +/-   ##
=======================================
  Coverage   99.58%   99.58%           
=======================================
  Files         243      243           
  Lines       19595    19595           
=======================================
+ Hits        19513    19514    +1     
+ Misses         82       81    -1     
Impacted Files Coverage Δ
pennylane/devices/default_qubit_torch.py 93.13% <0.00%> (+0.98%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd28293...70090ba. Read the comment docs.

@eddddddy eddddddy changed the title [WIP] Add documentation for supported functionality Add documentation for supported functionality May 9, 2022
tests/test_docs.py Outdated Show resolved Hide resolved
@antalszava antalszava self-requested a review May 9, 2022 21:12
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
tests/test_docs.py Outdated Show resolved Hide resolved
Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @eddddddy, this is a huge effort and will bring us forward a lot 💪 🎉

Not only does it provide info to users, but we also have a more systematic check-in place for cases that can go a long way for our testing practices.

Left some suggestions. No real blockers, rather polishing. One general thought is that if a functionality doesn't work as we'd like and there's an issue open (or will be opened), then linking the issue number/link in a comment can also help with a TODO marker. Also, in the issue itself, marking the parts of this addition can help because once the issue is resolved, those parts would also have to be updated.

doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
tests/docs/test_supported_confs.py Show resolved Hide resolved
tests/docs/test_supported_confs.py Outdated Show resolved Hide resolved
tests/docs/test_supported_confs.py Show resolved Hide resolved
tests/docs/test_supported_confs.py Outdated Show resolved Hide resolved
tests/docs/test_supported_confs.py Outdated Show resolved Hide resolved
eddddddy and others added 6 commits May 11, 2022 12:42
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
eddddddy and others added 14 commits May 11, 2022 12:48
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
@antalszava
Copy link
Contributor

[sc-19547]

Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @eddddddy! 🏆 Once the comments are addressed, this is ready to be merged. The ones marked as minor/as an idea are up for consideration, no definite need to change the behaviour there.

doc/introduction/interfaces.rst Show resolved Hide resolved
doc/introduction/interfaces.rst Outdated Show resolved Hide resolved
doc/introduction/interfaces.rst Outdated Show resolved Hide resolved
doc/introduction/interfaces.rst Show resolved Hide resolved
doc/introduction/unsupported_gradients.rst Outdated Show resolved Hide resolved
tests/docs/test_supported_confs.py Outdated Show resolved Hide resolved
tests/docs/test_supported_confs.py Show resolved Hide resolved
tests/docs/test_supported_confs.py Show resolved Hide resolved
tests/docs/test_supported_confs.py Outdated Show resolved Hide resolved
doc/introduction/unsupported.rst Outdated Show resolved Hide resolved
@eddddddy eddddddy merged commit b683694 into PennyLaneAI:master May 16, 2022
@eddddddy eddddddy deleted the supported_confs branch May 16, 2022 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide a table of supported functionalities
2 participants