Update Noisy Circuits Documentation and Simulation #456

IsaacP1234 · 2024-12-30T03:31:02Z

Update docs for peturbative expansion simulation and add a flow chart

Add more functionality to peturbative expansion

If you want to submit an unfinished piece of work in order to get comments and discuss, please mark the pull request as a draft and ping the repository maintainer.

Please address only one topic or issue per pull request! Many small PRs are much easier to review and merge than one large PR.

Before merging, all changes and new functionality should be marked in the CHANGELOG file, but feel free to just leave your CHANGELOG notes in the PR description, to avoid merge conflicts with other requests modifying that file. The maintainer will add these CHANGELOG notes for you if you do so.

Before considering your pull request ready for review and merging make sure that all of the following are completed (please keep the clecklist as part of your PR):

The code is properly formatted and commented.
Substantial new functionality is documented within the docs.
All new functionality is tested.
All of the automated tests on github pass.
We recently started enforcing formatting checks. If formatting issues are reported in the new code you have written, please correct them. There will be plenty of old code that is flagged as we are slowly transitioning to enforced formatting. Please do not worry about or address older formatting issues -- keep your PR just focused on your planned contribution.

If possible, keep your git history not too wild (rebase and squash commits, keep commits small and semantically separated) so that review is easier.

codecov · 2024-12-30T03:50:45Z

Codecov Report

Attention: Patch coverage is 0% with 19 lines in your changes missing coverage. Please review.

Project coverage is 82.76%. Comparing base (6065fab) to head (34b7588).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/petrajectory.jl	0.00%	19 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #456      +/-   ##
==========================================
- Coverage   82.82%   82.76%   -0.06%     
==========================================
  Files          70       70              
  Lines        4651     4747      +96     
==========================================
+ Hits         3852     3929      +77     
- Misses        799      818      +19

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

Krastanov

Thanks, Isaac! This is shaping up well. I am sending along a few change requests:

tests
removing some code repetition
embedding the mermaid diagram differently

Krastanov · 2024-12-31T13:53:23Z

src/operator_traits.jl

+operatordeterminism(::Type{sMZ}) = NondeterministicOperatorTrait()
+operatordeterminism(::Type{sMX}) = NondeterministicOperatorTrait()
+operatordeterminism(::Type{sMY}) = NondeterministicOperatorTrait()
+operatordeterminism(::Type{sCNOT}) = DeterministicOperatorTrait()


These should not be needed. Even on the current master I get:

julia> QuantumClifford.operatordeterminism(sMY) QuantumClifford.NondeterministicOperatorTrait() julia> QuantumClifford.operatordeterminism(sCNOT) QuantumClifford.DeterministicOperatorTrait()

These are already appropriately defined for the abstract supertypes, so they are inherited for sMZ or sCNOT

Krastanov · 2024-12-31T13:54:55Z

src/petrajectory.jl

+function applybranches(::NondeterministicOperatorTrait, state, op::sMZ; max_order=1)
+    s = copy(state)
+    d, anticom, res = projectZ!(s, op.qubit)
+    if isnothing(res)
+        tab(stabilizerview(s)).phases[anticom] = 0x0
+        s1 = copy(s)
+        tab(stabilizerview(s)).phases[anticom] = 0x2
+        s2 = s
+        return [(s1, continue_stat, .5, 0), (s2, continue_stat, .5, 0)]
+    else 
+        return [(s, continue_stat, 1, 0)] end
+end


The addition of this guy now requires some form of a test to be added to the test runner as well.

E.g. it can be running a sHadamard followed by an sMZ and confirming that the result is 50/50 split between 0 and 1.

Also running an just a sMZ and confirming that the result is 100% 0.

Krastanov · 2024-12-31T13:55:09Z

src/petrajectory.jl

+        return [(s, continue_stat, 1, 0)] end
+end
+
+function applybranches(::NondeterministicOperatorTrait, state, op::sMX; max_order=1)


Krastanov · 2024-12-31T13:55:16Z

src/petrajectory.jl

+        return [(s, continue_stat, 1, 0)] end
+end
+
+function applybranches(::NondeterministicOperatorTrait, state, op::sMY; max_order=1)


Krastanov · 2024-12-31T14:01:11Z

src/petrajectory.jl

+        return [(s1, continue_stat, .5, 0), (s2, continue_stat, .5, 0)]
+    else 
+        return [(s, continue_stat, 1, 0)] end
+end


there is a lot of code repetition in applybranches for sMY and sMX and sMZ. There is a private function called project_cond! (you can see it being used in projectX! projectY! projectZ!) that should let you remove a ton of the code repetition.

Or even more simply, you can do something like op::T, ...) where {T<:Union{sMZ,sMX,sMY}} in the type signature and then do

if T===sMZ ... elseif T===sMX ... elseif T===sMY ... else error("not reachable") end

Krastanov · 2024-12-31T14:01:49Z

src/petrajectory.jl

    if size(circuit)[1] == 0
-        return A()
+        DataStructures.inc!(dict, (state,continue_stat), branch_weight)
+        return dict


this new behavior also need a test (potentially the same test as the one for the new functionality above)

Krastanov · 2024-12-31T14:05:16Z

docs/src/noisycircuits_perturb.md

@@ -42,7 +42,7 @@ circuit = [n,g1,g2,m,v]

 petrajectories(initial_state, circuit)
 ```
-
+[![](https://mermaid.ink/img/pako:eNq1lltvmzAUgP-K5T60k6DiFrogbS_r9raLljxUCXkwxiRWDI58WRc1_e91MVlIyzRteH4JHH_n41g6jv0AMS8JzGDeVIzf4w0SCsxv8waYIRVSZHl3BxaLFfD994cZrTVDivIGRIe1mQzR1fLDl69zEHrx6s2fs2KbVfxdVmiz8OssW4PlNcZEykMbi451RV5yxhYDbPEbFgP_2sAfheCiQ_EwGp2XIIjUTEXL7-3vqscVfaXF4gEMD-jCc64LGk7q-mo503UXkgA1JZD7uuCMYrATvEAFZVQReSy5q8_m9kNxP2QezOsPxDSRy289jZ0-jbnQBHTFAvAOBNfTIJ4k6UvuE6JMCwIsE8TpJEinryEmT7YWnCQ3aZCsjn2yZ8R2C6goY9lF1Q4PVLxRfoVqyvYZuJwRQatLTyrBtyS7CNrRV3StM95ROHDg8Y7IwVoiB2uJRq6la2wXksiFJB4nMbtonMBuwH91MNpsZ60nAOfzHe7f01JtsnD308OccZEVDOGtN_SBl8bQuTFyboydGxPnxolzY-rceOPc-Na5ceq-w__DpnG_a8Lx2wZ6sCaiRrQ0V8GH5w_kUG1ITXKYmceSVMj8FebmlvhoUKQVn-0bDDNljn4PCq7XG5hVz0e3B_WuNMfALUVrgepf0R1qFpyf3klJFRef7eWzvYM-PgGgdnFL?type=png)](https://mermaid-js.github.io/mermaid-live-editor/edit#pako:eNq1lltvmzAUgP-K5T60k6DiFrogbS_r9raLljxUCXkwxiRWDI58WRc1_e91MVlIyzRteH4JHH_n41g6jv0AMS8JzGDeVIzf4w0SCsxv8waYIRVSZHl3BxaLFfD994cZrTVDivIGRIe1mQzR1fLDl69zEHrx6s2fs2KbVfxdVmiz8OssW4PlNcZEykMbi451RV5yxhYDbPEbFgP_2sAfheCiQ_EwGp2XIIjUTEXL7-3vqscVfaXF4gEMD-jCc64LGk7q-mo503UXkgA1JZD7uuCMYrATvEAFZVQReSy5q8_m9kNxP2QezOsPxDSRy289jZ0-jbnQBHTFAvAOBNfTIJ4k6UvuE6JMCwIsE8TpJEinryEmT7YWnCQ3aZCsjn2yZ8R2C6goY9lF1Q4PVLxRfoVqyvYZuJwRQatLTyrBtyS7CNrRV3StM95ROHDg8Y7IwVoiB2uJRq6la2wXksiFJB4nMbtonMBuwH91MNpsZ60nAOfzHe7f01JtsnD308OccZEVDOGtN_SBl8bQuTFyboydGxPnxolzY-rceOPc-Na5ceq-w__DpnG_a8Lx2wZ6sCaiRrQ0V8GH5w_kUG1ITXKYmceSVMj8FebmlvhoUKQVn-0bDDNljn4PCq7XG5hVz0e3B_WuNMfALUVrgepf0R1qFpyf3klJFRef7eWzvYM-PgGgdnFL)


let's embed this directly as mermaid code so that it is easier to edit in the future. You can see an example of this here:

https://github.com/QuantumSavory/QuantumSavory.jl/blob/master/docs/src/register_interface.md?plain=1#L39

FYI, for this to work, this folder also needs to exist: https://github.com/QuantumSavory/QuantumSavory.jl/tree/master/docs/src/assets

Hi, Stefan! It appears we don't need the <code></code> HTML tags when embedding the mermaid diagrams. In fact, in QuantumSavory, there are two ways in which mermaid diagrams are embedded:

with HTML <code></code> :https://github.com/QuantumSavory/QuantumSavory.jl/blob/master/docs/src/register_interface.md?plain=1#L39 (causes error in documenter-dark mode)

without HTML<code></code>: https://github.com/QuantumSavory/QuantumSavory.jl/blob/8e0ba5bbadf899d6e7d029c32693af37299b6de0/docs/src/howto/firstgenrepeater/firstgenrepeater.md?plain=1#L130

There is rendering error in documenter-dark mode where <code></code> are used: QuantumSavory/QuantumSavory.jl#174.

Since you provided the aforementioned link to<code></code> HTML tags, I wanted to send this message to possibly help avoid documenter-dark mode errors here. Please help review this message, thank you!

IsaacP1234 added 2 commits December 29, 2024 13:28

new apply_branches and docs

ed20e6a

fix applybranches, fix keep

f8f0258

Krastanov requested changes Dec 31, 2024

View reviewed changes

Krastanov mentioned this pull request Dec 31, 2024

Noisy Circuits Improvements #449

Closed

5 tasks

Krastanov marked this pull request as draft December 31, 2024 14:07

IsaacP1234 added 4 commits January 1, 2025 15:26

removed uneeded operator determinism

6212a21

removing applybranches code repetition

9c9550a

flow chart code

34b7588

tests for new applybranches method

7f9dcff

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Noisy Circuits Documentation and Simulation #456

Update Noisy Circuits Documentation and Simulation #456

IsaacP1234 commented Dec 30, 2024

codecov bot commented Dec 30, 2024 •

edited

Loading

Krastanov left a comment

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Krastanov Dec 31, 2024

Fe-r-oz Dec 31, 2024

Update Noisy Circuits Documentation and Simulation #456

Are you sure you want to change the base?

Update Noisy Circuits Documentation and Simulation #456

Conversation

IsaacP1234 commented Dec 30, 2024

codecov bot commented Dec 30, 2024 • edited Loading

Codecov Report

Krastanov 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

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

codecov bot commented Dec 30, 2024 •

edited

Loading