added documentation for get_standard_gate_name_mapping #13230

Shivansh20128 · 2024-09-27T11:37:03Z

Summary

Added documentation for the function get_standard_gate_name_mapping() in the Standard Gates section here.
#Closes #13108

Details and comments

I have added the necessary details about the function with code examples in the documentation.

qiskit-bot · 2024-09-27T11:37:08Z

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:02:49Z

Pull Request Test Coverage Report for Build 11716766133

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
767 unchanged lines in 29 files lost coverage.
Overall coverage decreased (-0.02%) to 88.78%

Files with Coverage Reduction	New Missed Lines	%
qiskit/compiler/transpiler.py	1	93.14%
crates/accelerate/src/unitary_synthesis.rs	1	92.2%
qiskit/transpiler/target.py	1	96.13%
crates/qasm2/src/expr.rs	1	94.02%
qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py	1	96.97%
qiskit/circuit/parameter.py	1	98.36%
qiskit/synthesis/unitary/qsd.py	1	97.58%
qiskit/transpiler/passes/synthesis/unitary_synthesis.py	2	58.05%
qiskit/transpiler/passes/optimization/consolidate_blocks.py	2	96.15%
qiskit/transpiler/preset_passmanagers/generate_preset_pass_manager.py	3	97.83%

Totals
Change from base Build 11690680453:	-0.02%
Covered Lines:	77780
Relevant Lines:	87610

💛 - Coveralls

1ucian0

Thanks! My understanding of the OP message in the issue is to extend qiskit.circuit.library.standard_gates.get_standard_gate_name_mapping docstring. I think it makes sense to mention it too at module level.

qiskit/circuit/library/__init__.py

Shivansh20128 · 2024-09-29T18:40:14Z

Thanks! My understanding of the OP message in the issue is to extend qiskit.circuit.library.standard_gates.get_standard_gate_name_mapping docstring. I think it makes sense to mention it too at module level.

I did not understand what you mean by that. Do I need to add this documentation somewhere else?

1ucian0

Do I need to add this documentation somewhere else?

Yes. The documentation should go under def get_standard_gate_name_mapping in qiskit/circuit/library/standard_gates/__init__.py.

qiskit/circuit/library/__init__.py

Shivansh20128 · 2024-09-30T10:42:51Z

Do I need to add this documentation somewhere else?

Yes. The documentation should go under def get_standard_gate_name_mapping in qiskit/circuit/library/standard_gates/__init__.py.

Okay. I will move it there.
Thank you

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Eric-Arellano

Thanks for working on this!

Eric-Arellano · 2024-09-30T20:56:15Z

qiskit/circuit/library/__init__.py

+get_standard_gate_name_mapping()
+-------------------------------------
+It returns a dictionary mapping the name of standard gates and instructions to an object for that name.


This whole section should be removed. Instead, you're going to use .. autofunction to auto-populate the docs from the function docstring.

I'm not sure yet where the Qiskit devs will want this function to show up on https://docs.quantum.ibm.com/api/qiskit/circuit_library. So for now, you could put a new section called Utility functions (section TBD) at the bottom of this module docstring. Use == rather than -- for the header type, and make sure the header is at least as long as the text above it.

Then, you'll put this under the header:

.. autofunction:: get_standard_gate_name_mapping

However, you'll need to make one more change. Right now, you have to import the full qiskit.circuit.library.standard_gates rather than being able to import qiskit.circuit.library. You can set up this import alias by adding to the bottom of the file from .standard_gates import get_standard_gate_name_mapping. That will allow both imports to work, and it will get the Sphinx docs working correctly.

Okay. I have made the required changes in the new commits.
Thank you

qiskit/circuit/library/standard_gates/__init__.py

Eric-Arellano · 2024-09-30T20:59:26Z

qiskit/circuit/library/standard_gates/__init__.py

+    For Example:
+
+    For the identity gate, the dictionary contains a mapping-
+
+    .. parsed-literal::
+        'id': Instruction(name='id', num_qubits=1, num_clbits=0, params=[])
+
+    Note here that the object on the right belongs to the broad class: 
+
+    * :class:`qiskit.circuit.Instruction`


I don't think this example is necessary. The example you have below it is already good. It's also useful to have the following paragraph before the example so that you are first told what to expect, rather than having to infer it from the example.

Okay, I have removed this example.
Thank you

qiskit/circuit/library/standard_gates/__init__.py

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

…ub.com/Shivansh20128/qiskit into doc_fix_get_standard_gate_name_mapping

Eric-Arellano

The CI failure is not from your change - it was unrelated. Pulling main into your branch (usually git pull upstream main) should fix it.

qiskit/circuit/library/standard_gates/__init__.py

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Eric-Arellano · 2024-10-03T14:05:44Z

qiskit/circuit/library/__init__.py

+Utility functions (section TBD)
+================================
+
+.. autofunction:: get_standard_gate_name_mapping


Qiskit devs: do you have any suggestions on what to name the section and where it makes sense to live in this module page? I don't use the circuit library enough to have an opinion.

I put it in the prelude (without a section) as it is the only one (see 18693b7). If, in the future, we get more, we can create a tooling section. what do you think?

It looks like this:

If a native speaker can check the English, we are good to merge this one.

If a native speaker can check the English, we are good to merge this one.

@Eric-Arellano ?

Eric-Arellano

Thanks @1ucian0 , this works for me to be in the prelude since it helps you to discover what is available

qiskit/circuit/library/__init__.py

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

1ucian0 · 2024-11-07T13:05:41Z

Thanks both!

* added documentation for get_standard_gate_name_mapping * doc fix at line 145 * Update qiskit/circuit/library/__init__.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * added docs get_standard_gate_name_mapping * reformatting at line 65-66 * update fix formatting * Update qiskit/circuit/library/standard_gates/__init__.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * docfix using autofunction * content updated get_standard_gate_name_mapping * Update qiskit/circuit/library/standard_gates/__init__.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * Update qiskit/circuit/library/__init__.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> (cherry picked from commit 3889fe0) # Conflicts: # qiskit/circuit/library/__init__.py

1ucian0 · 2024-11-08T13:46:20Z

@Mergifyio backport stable/1.3

mergify · 2024-11-08T13:46:27Z

backport stable/1.3

✅ Backports have been created

Backport to branch stable/1.3 not needed, change already in branch stable/1.3

added documentation for get_standard_gate_name_mapping

c44f3cf

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

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

1ucian0 reviewed Sep 29, 2024

View reviewed changes

qiskit/circuit/library/__init__.py Outdated Show resolved Hide resolved

Shivansh20128 and others added 2 commits September 30, 2024 00:01

Merge branch 'Qiskit:main' into doc_fix_get_standard_gate_name_mapping

622d561

doc fix at line 145

eef26e9

1ucian0 reviewed Sep 30, 2024

View reviewed changes

qiskit/circuit/library/__init__.py Outdated Show resolved Hide resolved

Shivansh20128 and others added 5 commits September 30, 2024 20:15

Update qiskit/circuit/library/__init__.py

6a93ad1

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Merge branch 'Qiskit:main' into doc_fix_get_standard_gate_name_mapping

a1b2006

added docs get_standard_gate_name_mapping

99c83fc

reformatting at line 65-66

2f1d8e9

update fix formatting

6348365

Eric-Arellano reviewed Sep 30, 2024

View reviewed changes

Shivansh20128 and others added 5 commits October 1, 2024 21:13

Merge branch 'Qiskit:main' into doc_fix_get_standard_gate_name_mapping

73878ce

Update qiskit/circuit/library/standard_gates/__init__.py

65c30f3

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

docfix using autofunction

ffb1cd3

Merge branch 'doc_fix_get_standard_gate_name_mapping' of https://gith…

90acee0

…ub.com/Shivansh20128/qiskit into doc_fix_get_standard_gate_name_mapping

content updated get_standard_gate_name_mapping

7c9bd45

Eric-Arellano reviewed Oct 2, 2024

View reviewed changes

qiskit/circuit/library/standard_gates/__init__.py Outdated Show resolved Hide resolved

Shivansh20128 and others added 2 commits October 3, 2024 19:32

Update qiskit/circuit/library/standard_gates/__init__.py

48c8a5c

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Merge branch 'main' into doc_fix_get_standard_gate_name_mapping

49d62b9

Eric-Arellano reviewed Oct 3, 2024

View reviewed changes

Merge branch 'main' into doc_fix_get_standard_gate_name_mapping

18693b7

Eric-Arellano previously approved these changes Nov 6, 2024

View reviewed changes

qiskit/circuit/library/__init__.py Outdated Show resolved Hide resolved

Update qiskit/circuit/library/__init__.py

7a943d5

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Shivansh20128 dismissed Eric-Arellano’s stale review via 7a943d5 November 7, 2024 04:45

1ucian0 approved these changes Nov 7, 2024

View reviewed changes

1ucian0 added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Nov 7, 2024

Eric-Arellano added this pull request to the merge queue Nov 7, 2024

Merged via the queue into Qiskit:main with commit 3889fe0 Nov 7, 2024
18 checks passed

mergify bot mentioned this pull request Nov 7, 2024

added documentation for get_standard_gate_name_mapping (backport #13230) #13406

Closed

raynelfss added the Changelog: None Do not include in changelog label Nov 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added documentation for get_standard_gate_name_mapping #13230

added documentation for get_standard_gate_name_mapping #13230

Shivansh20128 commented Sep 27, 2024

qiskit-bot commented Sep 27, 2024

coveralls commented Sep 27, 2024 •

edited

Loading

1ucian0 left a comment

Shivansh20128 commented Sep 29, 2024

1ucian0 left a comment

Shivansh20128 commented Sep 30, 2024

Eric-Arellano left a comment

Eric-Arellano Sep 30, 2024

Shivansh20128 Oct 1, 2024

Eric-Arellano Sep 30, 2024

Shivansh20128 Oct 1, 2024

Eric-Arellano left a comment

Eric-Arellano Oct 3, 2024

1ucian0 Nov 5, 2024

1ucian0 Nov 6, 2024

1ucian0 Nov 6, 2024

Eric-Arellano left a comment

1ucian0 commented Nov 7, 2024

1ucian0 commented Nov 8, 2024

mergify bot commented Nov 8, 2024 •

edited

Loading

added documentation for get_standard_gate_name_mapping #13230

added documentation for get_standard_gate_name_mapping #13230

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 11716766133

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

1ucian0 left a comment

Choose a reason for hiding this comment

Shivansh20128 commented Sep 29, 2024

1ucian0 left a comment

Choose a reason for hiding this comment

Shivansh20128 commented Sep 30, 2024

Eric-Arellano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

1ucian0 commented Nov 7, 2024

1ucian0 commented Nov 8, 2024

mergify bot commented Nov 8, 2024 • edited Loading

✅ Backports have been created

coveralls commented Sep 27, 2024 •

edited

Loading

mergify bot commented Nov 8, 2024 •

edited

Loading