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

Improving documentation for QuantumNetwork class + bug fix #1192

Merged
merged 22 commits into from
Feb 7, 2024

Conversation

Canoming
Copy link
Contributor

@Canoming Canoming commented Feb 5, 2024

Checklist:

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

@Canoming Canoming requested a review from renatomello February 5, 2024 14:42
@Canoming Canoming self-assigned this Feb 5, 2024
@Canoming Canoming linked an issue Feb 5, 2024 that may be closed by this pull request
Copy link

codecov bot commented Feb 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2bfd6ec) 100.00% compared to head (11e8e3d) 99.99%.
Report is 2 commits behind head on master.

❗ Current head 11e8e3d differs from pull request most recent head 09256fc. Consider uploading reports for the commit 09256fc to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##            master    #1192      +/-   ##
===========================================
- Coverage   100.00%   99.99%   -0.01%     
===========================================
  Files           69       69              
  Lines        10107    10106       -1     
===========================================
- Hits         10107    10105       -2     
- Misses           0        1       +1     
Flag Coverage Δ
unittests 99.99% <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.

@renatomello renatomello changed the title Documentation for Quantum networks Improving documentation for QuantumNetwork class Feb 6, 2024
@renatomello renatomello added documentation Improvements or additions to documentation quantum_info module PRs and issues related to the quantum information module labels Feb 6, 2024
@renatomello renatomello added this to the Qibo 0.2.5 milestone Feb 6, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2024

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (8e9d1c0) 100.00% compared to head (a18089b) 99.96%.
Report is 52 commits behind head on master.

❗ Current head a18089b differs from pull request most recent head d5f8ab1. Consider uploading reports for the commit d5f8ab1 to get more accurate results

Files Patch % Lines
src/qibo/quantum_info/quantum_networks.py 84.61% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##            master    #1192      +/-   ##
===========================================
- Coverage   100.00%   99.96%   -0.04%     
===========================================
  Files           68       68              
  Lines        10215    10220       +5     
===========================================
+ Hits         10215    10216       +1     
- Misses           0        4       +4     
Flag Coverage Δ
unittests 99.96% <84.61%> (-0.04%) ⬇️

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.

renatomello
renatomello previously approved these changes Feb 6, 2024
@renatomello
Copy link
Contributor

@Canoming let us know if you plan on adding more things to this PR, otherwise we can merge it

@Canoming
Copy link
Contributor Author

Canoming commented Feb 6, 2024

@Canoming let us know if you plan on adding more things to this PR, otherwise we can merge it

I'm trying to write a small use case of QuantumNetwork. But I would like to first check if there is a reason we chose the function name channel over is_channel: #1189 (comment) . I can commit the use case after we confirm the function name

@renatomello
Copy link
Contributor

@Canoming let us know if you plan on adding more things to this PR, otherwise we can merge it

I'm trying to write a small use case of QuantumNetwork. But I would like to first check if there is a reason we chose the function name channel over is_channel: #1189 (comment) . I can commit the use case after we confirm the function name

It's already changed

@renatomello renatomello added do not merge Blocked by some other development or PR and removed do not merge Blocked by some other development or PR labels Feb 7, 2024
@renatomello renatomello self-requested a review February 7, 2024 04:39
@renatomello renatomello dismissed their stale review February 7, 2024 04:39

Code still in progress

@Canoming
Copy link
Contributor Author

Canoming commented Feb 7, 2024

I have updated the test and added a tutorial for the QuantumNetwork. The tests are not ideal at this stage as I didn't test the output of @. However, I need to implement a more complex link_product for a better test, which is planned for the next step.

@renatomello renatomello changed the title Improving documentation for QuantumNetwork class Improving documentation for QuantumNetwork class + bug fix Feb 7, 2024
@renatomello renatomello added this pull request to the merge queue Feb 7, 2024
Merged via the queue into master with commit 5d3f0f6 Feb 7, 2024
19 checks passed
@renatomello renatomello deleted the quantum_networks branch February 7, 2024 11:35
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 quantum_info module PRs and issues related to the quantum information module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improvement of QuantumNetwork documentation and examples
4 participants