Add and change some docstrings for a better quality #174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #174 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 291 291
=========================================
Hits 291 291
Continue to review full report at Codecov.
|
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
pennylane_qiskit/qiskit_device.py
Outdated
Comment on lines
185
to
187
| Keyword Args: | ||
| kwargs (dict): keyword arguments to be set for the Qiskit transpiler. For more details, | ||
| see the `Qiskit documentation <https://qiskit.org/documentation/stubs/qiskit.compiler.transpile.html>`_. |
There was a problem hiding this comment.
As with the example in pennylane_qiskit/ibmq.py, instead of a general item, we'd want some specific set of keyword arguments here, right?
There was a problem hiding this comment.
@antalszava Yes that would be ideal but they are so many transpiler arguments that I thought it was better just to link it, what do you think?
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
antalszava
reviewed
Jan 27, 2022
antalszava
approved these changes
Jan 27, 2022
There was a problem hiding this comment.
Thanks @rmoyard! 💯 Once the comments are addressed, this is good to go from my side.
rmoyard
added a commit
that referenced
this pull request
Feb 14, 2022
* Small change. * First check. * Typo. * Add link. * Change. * Change. * Update pennylane_qiskit/qiskit_device.py * Update from review. * Typo * Update docstring transpiler. * Update. Co-authored-by: antalszava <antalszava@gmail.com>
antalszava
added a commit
that referenced
this pull request
Feb 15, 2022
* Small change. * Update header.html * Add native support for the SX gate (#158) * Add SX support * changelog * SX inverse tests * Define the `QiskitDevice.batch_execute` method (#156) * first draft * license * apply; compile in the method * statevector & batch generate samples * docstrings * tests * batch_params check & check call count for batch_execute * IBMQ check * docstrings * batch execution pipeline test for gradient computation * IBMQ grad test * state * no single tape case; re-add basis state prep to the test * name and docstring * renames * comment * docstrings, names * remove unnecessary reset * Update pennylane_qiskit/qiskit_device.py Co-authored-by: Romain <rmoyard@gmail.com> * Update pennylane_qiskit/qiskit_device.py Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Romain <rmoyard@gmail.com> * Update the batch execution tests to use the new QNode (#159) * batch execute call counter * get PennyLane master * comment * flaky * Update test_expval.py * more flaky Co-authored-by: Romain <rmoyard@gmail.com> * Change token for IBMQ tests (#161) * Small change. * Change token. * Add env. * Not device test. * Batch execute twice * Add job_time (#160) * commit * black * test * checking coverage * reset test * qasm_simulator * test * test * change * update * record * Romain changes * Update ibmq.py * final change * Update test_ibmq.py * Update CHANGELOG.md Co-authored-by: Romain <rmoyard@gmail.com> * Add the `qml.Identity` operation to PennyLane-Qiskit (#162) * Add the qml.Identity gate to the Qiskit plugin * Add Identity to converter test * Fix pylint:f-string in qiskit_device.py * Changelog & additional test * Update CHANGELOG.md Co-authored-by: Romain <rmoyard@gmail.com> * Fix `batch_execute` output type for QNodes with multiple outputs (#163) * asarray * check type * changelog * Update the tracker used with batch execution (#167) * tracker test * changelog * Update tests/test_integration.py Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Romain <rmoyard@gmail.com> * Update header.html * Python 3.10 (#170) * changelog & tests * changelog * Version bump (#168) * Version bump s Please enter the commit message for your changes. Lines starting * add pl version Co-authored-by: Josh Izaac <josh146@gmail.com> * v0.21.0-dev version bump (#172) * inc version * add flaky * Improve token-specified login flow. (#169) * Test that we can create multiple IBMQ devices using an environment token. * Improve token-specified login flow. * Fix formatting. * extend skipping logic * Test token login elision. * Temporarily restrict code coverage analysis. * Update changelog. * Fix formatting. * more no cover for the IBMQ device * Update tests/test_ibmq.py Co-authored-by: antalszava <antalszava@gmail.com> * Update tests/test_ibmq.py Co-authored-by: antalszava <antalszava@gmail.com> * Update test_ibmq.py Co-authored-by: Antal Szava <antalszava@gmail.com> * Change IBMQ login (#175) * Small change. * Change test. * Test. * Update. * Change tests. * Fix bugs for the trainable arguments update (#177) * Small change. * Tests * Exchange. * Update. * Update. * Add circuit-runner, sampler and custom VQE programs from Qiskit-Runtime (#157) * Small change. * First commit * Working circuit runner. * Sampler * Sampler * VQE is working. * Headers. * Update for batches. * Update docstrigs. * CodeFactor. * Add tests for runtime. * Tests. * Test. * Test circuit runner. * Test Sampler. * Correct generate_samples * Add entry points. * More shots. * Add token arg. * Change import * Change Sampler sample. * Circuit runner kwargs test. * Shots kwargs * Change import. * Add kwargs Sampler test. * Import. * Impport again. * Import change * Add test tracker. * Update track tests. * Update tracker runtime. * Update tracker. * Update. * Codfactor changes. * Update. * Update codefactor * More codefactor. * Add callback * Update * Move vqe * Update. * Add test VQE. * Update. * delete * Update VQE test. * Add shots. * Update test * Update delete * Unused import. * More iteration. * m * Change tol. * More VQE tests. * Black * Update. * Update. * Update * Update pennylane_qiskit/vqe/__init__.py Co-authored-by: antalszava <antalszava@gmail.com> * Update from review. * Update tests. * Typo. * Update from tests. * Runtime updated. * Runtime updated. * Update vqe * Update * Update from Antal review. * Update * Black. * More test. * Update parameters * Codefactor update. * Update. * Update. * Change order jac. * Typo. * Params. * Update tests. * ValueError. * print * Update. * Tol. * Update review. * Add doc. * Unused variable. * Update tests. * Update params. * Update review. * Readd mthree * Typo. * Path. * Black * Change path. * Update runtime_programs/vqe_runtime_program.py * Update doc/devices/runtime.rst Co-authored-by: antalszava <antalszava@gmail.com> * Update review. * coverarc * coverarc omit + skip IBMQ and Runtime tests * Changelog Co-authored-by: antalszava <antalszava@gmail.com> * Add and change some docstrings for a better quality (#174) * Small change. * First check. * Typo. * Add link. * Change. * Change. * Update pennylane_qiskit/qiskit_device.py * Update from review. * Typo * Update docstring transpiler. * Update. Co-authored-by: antalszava <antalszava@gmail.com> * Changes. * Review * Review * Wrong changelog number Co-authored-by: Josh Izaac <josh146@gmail.com> Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> Co-authored-by: Tanner Rogalsky <tanner@tannerrogalsky.com>
antalszava
added a commit
that referenced
this pull request
Feb 15, 2022
* changelog and bump version * Change callback function for Sicpy intermediate results (#187) * Small change. * Update header.html * Add native support for the SX gate (#158) * Add SX support * changelog * SX inverse tests * Define the `QiskitDevice.batch_execute` method (#156) * first draft * license * apply; compile in the method * statevector & batch generate samples * docstrings * tests * batch_params check & check call count for batch_execute * IBMQ check * docstrings * batch execution pipeline test for gradient computation * IBMQ grad test * state * no single tape case; re-add basis state prep to the test * name and docstring * renames * comment * docstrings, names * remove unnecessary reset * Update pennylane_qiskit/qiskit_device.py Co-authored-by: Romain <rmoyard@gmail.com> * Update pennylane_qiskit/qiskit_device.py Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Romain <rmoyard@gmail.com> * Update the batch execution tests to use the new QNode (#159) * batch execute call counter * get PennyLane master * comment * flaky * Update test_expval.py * more flaky Co-authored-by: Romain <rmoyard@gmail.com> * Change token for IBMQ tests (#161) * Small change. * Change token. * Add env. * Not device test. * Batch execute twice * Add job_time (#160) * commit * black * test * checking coverage * reset test * qasm_simulator * test * test * change * update * record * Romain changes * Update ibmq.py * final change * Update test_ibmq.py * Update CHANGELOG.md Co-authored-by: Romain <rmoyard@gmail.com> * Add the `qml.Identity` operation to PennyLane-Qiskit (#162) * Add the qml.Identity gate to the Qiskit plugin * Add Identity to converter test * Fix pylint:f-string in qiskit_device.py * Changelog & additional test * Update CHANGELOG.md Co-authored-by: Romain <rmoyard@gmail.com> * Fix `batch_execute` output type for QNodes with multiple outputs (#163) * asarray * check type * changelog * Update the tracker used with batch execution (#167) * tracker test * changelog * Update tests/test_integration.py Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Romain <rmoyard@gmail.com> * Update header.html * Python 3.10 (#170) * changelog & tests * changelog * Version bump (#168) * Version bump s Please enter the commit message for your changes. Lines starting * add pl version Co-authored-by: Josh Izaac <josh146@gmail.com> * v0.21.0-dev version bump (#172) * inc version * add flaky * Improve token-specified login flow. (#169) * Test that we can create multiple IBMQ devices using an environment token. * Improve token-specified login flow. * Fix formatting. * extend skipping logic * Test token login elision. * Temporarily restrict code coverage analysis. * Update changelog. * Fix formatting. * more no cover for the IBMQ device * Update tests/test_ibmq.py Co-authored-by: antalszava <antalszava@gmail.com> * Update tests/test_ibmq.py Co-authored-by: antalszava <antalszava@gmail.com> * Update test_ibmq.py Co-authored-by: Antal Szava <antalszava@gmail.com> * Change IBMQ login (#175) * Small change. * Change test. * Test. * Update. * Change tests. * Fix bugs for the trainable arguments update (#177) * Small change. * Tests * Exchange. * Update. * Update. * Add circuit-runner, sampler and custom VQE programs from Qiskit-Runtime (#157) * Small change. * First commit * Working circuit runner. * Sampler * Sampler * VQE is working. * Headers. * Update for batches. * Update docstrigs. * CodeFactor. * Add tests for runtime. * Tests. * Test. * Test circuit runner. * Test Sampler. * Correct generate_samples * Add entry points. * More shots. * Add token arg. * Change import * Change Sampler sample. * Circuit runner kwargs test. * Shots kwargs * Change import. * Add kwargs Sampler test. * Import. * Impport again. * Import change * Add test tracker. * Update track tests. * Update tracker runtime. * Update tracker. * Update. * Codfactor changes. * Update. * Update codefactor * More codefactor. * Add callback * Update * Move vqe * Update. * Add test VQE. * Update. * delete * Update VQE test. * Add shots. * Update test * Update delete * Unused import. * More iteration. * m * Change tol. * More VQE tests. * Black * Update. * Update. * Update * Update pennylane_qiskit/vqe/__init__.py Co-authored-by: antalszava <antalszava@gmail.com> * Update from review. * Update tests. * Typo. * Update from tests. * Runtime updated. * Runtime updated. * Update vqe * Update * Update from Antal review. * Update * Black. * More test. * Update parameters * Codefactor update. * Update. * Update. * Change order jac. * Typo. * Params. * Update tests. * ValueError. * print * Update. * Tol. * Update review. * Add doc. * Unused variable. * Update tests. * Update params. * Update review. * Readd mthree * Typo. * Path. * Black * Change path. * Update runtime_programs/vqe_runtime_program.py * Update doc/devices/runtime.rst Co-authored-by: antalszava <antalszava@gmail.com> * Update review. * coverarc * coverarc omit + skip IBMQ and Runtime tests * Changelog Co-authored-by: antalszava <antalszava@gmail.com> * Add and change some docstrings for a better quality (#174) * Small change. * First check. * Typo. * Add link. * Change. * Change. * Update pennylane_qiskit/qiskit_device.py * Update from review. * Typo * Update docstring transpiler. * Update. Co-authored-by: antalszava <antalszava@gmail.com> * Changes. * Review * Review * Wrong changelog number Co-authored-by: Josh Izaac <josh146@gmail.com> Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> Co-authored-by: Tanner Rogalsky <tanner@tannerrogalsky.com> * Update CHANGELOG.md Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Josh Izaac <josh146@gmail.com> Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> Co-authored-by: Tanner Rogalsky <tanner@tannerrogalsky.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[sc-9622]