Doc fix ZZ_feature_maps #13231

Shivansh20128 · 2024-09-27T11:51:33Z

Summary

I have added docstrings for data, entanglement_blocks, num_parameters, and parameters properties in the ZZ_Feature_Map documentation. Also, I updated the code example where to concatenate two circuits, the "+" has been replaced with the "compose" operation.
#Closes #12431

Details and comments

Also updated some formatting in the code example as the "copy to clipboard" button also copied the arrows which needed to be removed explicitly.

qiskit-bot · 2024-09-27T11:51:38Z

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the following people are relevant to this code:

@Cryoris
@Qiskit/terra-core
@ajavadia

coveralls · 2024-09-27T12:17:15Z

Pull Request Test Coverage Report for Build 11128933879

Details

0 of 0 changed or added relevant lines in 0 files are covered.
26 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.03%) to 88.839%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	8	91.23%
crates/qasm2/src/parse.rs	18	95.77%

Totals
Change from base Build 11126578403:	-0.03%
Covered Lines:	74115
Relevant Lines:	83426

💛 - Coveralls

Cryoris

Thanks for the contribution @Shivansh20128 🙂 For the derived methods whose documentation don't show up correctly (data, num_parameters, etc.) could you just copy-paste the docstring from the parent class? It would be good if they are consistent.

Cryoris · 2024-09-27T12:57:38Z

qiskit/circuit/library/data_preparation/_zz_feature_map.py

@@ -19,7 +19,7 @@


 class ZZFeatureMap(PauliFeatureMap):
-    r"""Second-order Pauli-Z evolution circuit.
+    r"""Second-order Pauli-Z evolution circuit: Using the Pauli-Z gate to create entanglement between pairs of qubits allowing them to evolve.


The first line is just a very brief summary, I would keep it as is 🙂

Suggested change

r"""Second-order Pauli-Z evolution circuit: Using the Pauli-Z gate to create entanglement between pairs of qubits allowing them to evolve.

r"""Second-order Pauli-Z evolution circuit.

Okay. I will revert it back. I modified it because it was unclear to me what it meant, so I thought it could be unclear to others as well.

Shivansh20128 · 2024-09-27T13:26:08Z

Thanks for the contribution @Shivansh20128 🙂 For the derived methods whose documentation don't show up correctly (data, num_parameters, etc.) could you just copy-paste the docstring from the parent class? It would be good if they are consistent.

Okay, I will do that.
Thanks for the review.

Cryoris

Thanks for the fix!

Cryoris · 2024-10-01T11:17:13Z

Ah actually it seems the CI is complaining, could you run black to correctly format the files?

Shivansh20128 · 2024-10-01T15:52:54Z

Thanks for the review. I ran the black command and it did some reformatting. I hope it should not give an error now.

Cryoris

Great, thanks for the fix!

Cryoris · 2024-10-03T05:58:16Z

@Mergifyio backport stable/1.2

mergify · 2024-10-03T05:58:21Z

backport stable/1.2

🟠 Pending

Backport to branch stable/1.2 in progress

* initial formatting changes * .compose used for concatination of two circuits * updated docstring data property * updated entanglement_blocks docstring * updated docstring of num_parameters * updates docstring of parameters * update _zz_feature_map.py documentation * update changes to ZZ_Feature_Map * update doc strings matched with parent class * _zz_feature_map.py reformatted (cherry picked from commit f1b2580) # Conflicts: # qiskit/circuit/library/data_preparation/zz_feature_map.py

* initial formatting changes * .compose used for concatination of two circuits * updated docstring data property * updated entanglement_blocks docstring * updated docstring of num_parameters * updates docstring of parameters * update _zz_feature_map.py documentation * update changes to ZZ_Feature_Map * update doc strings matched with parent class * _zz_feature_map.py reformatted

* Doc fix ZZ_feature_maps (#13231) * initial formatting changes * .compose used for concatination of two circuits * updated docstring data property * updated entanglement_blocks docstring * updated docstring of num_parameters * updates docstring of parameters * update _zz_feature_map.py documentation * update changes to ZZ_Feature_Map * update doc strings matched with parent class * _zz_feature_map.py reformatted (cherry picked from commit f1b2580) # Conflicts: # qiskit/circuit/library/data_preparation/zz_feature_map.py * merge conflicy & other typos --------- Co-authored-by: Shivansh Mittal <88429611+Shivansh20128@users.noreply.github.com> Co-authored-by: Julien Gacon <jules.gacon@googlemail.com>

* initial formatting changes * .compose used for concatination of two circuits * updated docstring data property * updated entanglement_blocks docstring * updated docstring of num_parameters * updates docstring of parameters * update _zz_feature_map.py documentation * update changes to ZZ_Feature_Map * update doc strings matched with parent class * _zz_feature_map.py reformatted

Shivansh20128 added 7 commits September 27, 2024 17:14

initial formatting changes

86bb538

.compose used for concatination of two circuits

5ae059b

updated docstring data property

1d2bd16

updated entanglement_blocks docstring

740a049

updated docstring of num_parameters

15727f6

updates docstring of parameters

195c182

update _zz_feature_map.py documentation

72be69e

Shivansh20128 requested a review from a team as a code owner September 27, 2024 11:51

qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Sep 27, 2024

Cryoris reviewed Sep 27, 2024

View reviewed changes

Shivansh20128 added 2 commits September 27, 2024 19:07

update changes to ZZ_Feature_Map

dc9c90e

update doc strings matched with parent class

afb0f72

Cryoris previously approved these changes Oct 1, 2024

View reviewed changes

Cryoris added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Oct 1, 2024

Shivansh20128 and others added 2 commits October 1, 2024 20:51

Merge branch 'Qiskit:main' into doc_fix_ZZ_Feature_Maps

b792440

_zz_feature_map.py reformatted

45e29d9

Shivansh20128 dismissed Cryoris’s stale review via 45e29d9 October 1, 2024 15:51

Cryoris approved these changes Oct 2, 2024

View reviewed changes

Cryoris added this pull request to the merge queue Oct 2, 2024

Merged via the queue into Qiskit:main with commit f1b2580 Oct 2, 2024
15 checks passed

Shivansh20128 deleted the doc_fix_ZZ_Feature_Maps branch October 2, 2024 07:18

Eric-Arellano mentioned this pull request Oct 2, 2024

Improve ZZFeatureMap API docs #12431

Closed

Cryoris added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Oct 3, 2024

mergify bot mentioned this pull request Oct 3, 2024

Doc fix ZZ_feature_maps (backport #13231) #13262

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc fix ZZ_feature_maps #13231

Doc fix ZZ_feature_maps #13231

Shivansh20128 commented Sep 27, 2024

qiskit-bot commented Sep 27, 2024

coveralls commented Sep 27, 2024 •

edited

Loading

Cryoris left a comment

Cryoris Sep 27, 2024

Shivansh20128 Sep 27, 2024

Shivansh20128 commented Sep 27, 2024

Cryoris left a comment

Cryoris commented Oct 1, 2024

Shivansh20128 commented Oct 1, 2024

Cryoris left a comment

Cryoris commented Oct 3, 2024

mergify bot commented Oct 3, 2024

	r"""Second-order Pauli-Z evolution circuit: Using the Pauli-Z gate to create entanglement between pairs of qubits allowing them to evolve.
	r"""Second-order Pauli-Z evolution circuit.

Doc fix ZZ_feature_maps #13231

Doc fix ZZ_feature_maps #13231

Conversation

Shivansh20128 commented Sep 27, 2024

Summary

Details and comments

qiskit-bot commented Sep 27, 2024

coveralls commented Sep 27, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11128933879

Details

💛 - Coveralls

Cryoris left a comment

Choose a reason for hiding this comment

Cryoris Sep 27, 2024

Choose a reason for hiding this comment

Shivansh20128 Sep 27, 2024

Choose a reason for hiding this comment

Shivansh20128 commented Sep 27, 2024

Cryoris left a comment

Choose a reason for hiding this comment

Cryoris commented Oct 1, 2024

Shivansh20128 commented Oct 1, 2024

Cryoris left a comment

Choose a reason for hiding this comment

Cryoris commented Oct 3, 2024

mergify bot commented Oct 3, 2024

🟠 Pending

coveralls commented Sep 27, 2024 •

edited

Loading