-
-
Notifications
You must be signed in to change notification settings - Fork 166
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
Update about()
and document latest package support
#1201
Comments
@andreamari label/change this issue as you see fit. As written I think it would be a good first issue. |
Thanks @Aaron-Robertson! |
This issue had no activity for 4 months, and will be closed in 2 weeks unless there is new activity. Cheers! |
So just getting my bearings here:
The Mitiq Read the Docs is generated by sphinx, and the supported backends section comes specifically from the README. |
@andreamari Could you help answer the above? |
Not Andrea, but I think I might be able to answer!
Nope!
I think it's workable, but probably not from the README as the README does not get executed like other pages in the documentation. |
|
From what I can glance from the PR (it's from before I started) and the issue (which was closed as "completed", but that may have just been because it is the default close option, as opposed to the other "close as not planned" option), it got complicated, and perhaps the value-add was not quite as great as originally estimated.
Some changes would almost definitely need to be made as it looks like the PR did not make it's way into a passing state. I don't currently love the approach of making an HTTP request to fetch the requirements, but if it's the only option then 🤷🏻.
Lemme know if there's anything in particular that's confusing and we can try to figure it out together! (live or async)
Yup, definitely! As Andrea suggested here, the Frontends and Backends page seems to make sense to demo this functionality if we add it. |
@jordandsullivan @natestemen Would you agree that @Aaron-Robertson's original requirement is met by #2303? |
I would say so yes. |
I apologize for the late reply. #1220 was a first attempt but was based on some dirty workarounds (e.g. http requests as noted by Nate) and so we decided to drop that PR. #2303 seems a cleaner approach. |
Issue Description
Latest supported versions of optional dependencies are not well documented. It is unclear which frontend version(s) to install after a user installs through
pip install mitiq
, but wants to use Qiskit, Pennylane, Braket, and/or PyQuil.Proposed Solution
about()
to include Pennylanelatest_supported()
to parse Qiskit, Pennylane (and Pennylane-Qiskit), Braket, and PyQuil versions fromdev_requirements.txt
Latest Supported
as a column inabout()
underOptional Dependencies
about()
QPROGRAM
type builderlatest_supported()
with output to docs under Supported FrontendsAdditional References
Discussed in Mitiq meeting 04/01/22. See this thread on discord.
The text was updated successfully, but these errors were encountered: