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

Update Documentation for wire_names and _Global #1531

Merged
merged 37 commits into from
Dec 16, 2024
Merged

Conversation

csookim
Copy link
Member

@csookim csookim commented Nov 28, 2024

All changes are related to variable names, docstrings, and documentation. No changes to the logic.

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.

@yjmaxpayne yjmaxpayne marked this pull request as ready for review November 28, 2024 07:39
@csookim csookim marked this pull request as draft November 28, 2024 07:50
Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.68%. Comparing base (bbf0ccf) to head (9ef4b40).
Report is 68 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1531   +/-   ##
=======================================
  Coverage   99.68%   99.68%           
=======================================
  Files          80       80           
  Lines       11585    11586    +1     
=======================================
+ Hits        11549    11550    +1     
  Misses         36       36           
Flag Coverage Δ
unittests 99.68% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@csookim csookim marked this pull request as ready for review November 28, 2024 13:21
Copy link
Member

@alecandido alecandido left a comment

Choose a reason for hiding this comment

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

In general, the PR seems alright, and I just have a relevant note about a single point.

However, if I'm correct, this is still partially lacking the explanation for a question that we already received, i.e. the role of wire_names in the qubit selection.
With this, I mean that we should clarify the following points:

  1. wire_names is absolutely not limiting the qubits used for placing or routing, if these non-trivial passes are included in the transpiler - thus, using wire_names as input for a non-trivial placer/routing is only possibly helpful to improve the transpiler solution, but it won't prevent the usage of any qubit in the platform
  2. wire_names are instead exactly honored by the Qibolab backend, when used directly (no transpilation), leading to compilation errors if the connectivity is insufficient
  3. padding should not be required at any stage, since the information that used to provide is now fully replaced by the usage of wire_names and the connectivity, to the point that we should even be able to drop the Preprocessing (though this should be confirmed)

doc/source/code-examples/advancedexamples.rst Outdated Show resolved Hide resolved
@csookim

This comment was marked as resolved.

@csookim csookim requested a review from alecandido December 1, 2024 08:28
@csookim csookim requested a review from renatomello December 5, 2024 08:51
csookim and others added 15 commits December 11, 2024 17:07
@csookim csookim requested a review from renatomello December 11, 2024 08:30
doc/source/code-examples/advancedexamples.rst Outdated Show resolved Hide resolved
doc/source/code-examples/advancedexamples.rst Outdated Show resolved Hide resolved
@renatomello renatomello added this pull request to the merge queue Dec 16, 2024
Merged via the queue into master with commit 1e99772 Dec 16, 2024
27 checks passed
@renatomello renatomello deleted the wire_names_docs branch December 16, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants