Skip to content

Including jit and contractions #17

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Including jit and contractions #17

wants to merge 1 commit into from

Conversation

@kareem1925
Copy link
Member

@kareem1925 kareem1925 commented Dec 4, 2025 •
edited
Loading

  1. Measurement docstrings: expanded vector/matrix measurement, POVM, …PNR, expectation, JIT wrappers with shapes, key handling, and noise notes

  2. RNG handling: split keys drop first subkey to decorrelate repeated calls across different seeds

  3. Kraus/measure paths: validated operator shapes, clarified contraction use, restored standalone ordering after application

  4. Envelope measurement/Kraus: ensure contractions align with Config and maintain post-op consistency

  5. Adapters overview: reorder targets forward, call kernels, contract optionally, restore ordering; added jit/meta entry points

  6. Kernels overview: stateless tensor primitives for apply/measure/trace/kraus assuming targets front-most

  7. Linear/ops layers: thin array-facing dispatchers into adapters/kernels

  8. Meta helpers: DimsMeta stores dims/indices/permutations to keep shapes static for JIT and vmap

  9. ShapePlan: pairs DimsMeta with state ordering for compiled kernels to reuse metadata across calls

  10. Jitted helpers: bind metas for static-shape invocation paths

  11. Core modules: added adapters, kernels, linear, ops, rng, jitted, meta, init wiring

  12. State interfaces: added shared BaseState typing surface for compiled kernels

  13. Shape planning utils: added compiled kernels and plan builder for repeated ops

  14. Measurement RNG tests: ensure different base keys yield different outcomes after splitting

  15. Adapter/Kraus tests: contraction flags, jit/meta paths, shape validation covered

  16. Ops utils tests: contract vs. non-contract apply_kraus_matrix behavior verified

  17. Doc infrastructure: enabled myst_parser for Markdown, mocked heavy imports to avoid build failures

  18. Docs cleanup: fixed headings/underlines/code blocks in index, intro, contributing, benchmarks, examples pages

  19. Added api/core pages: documented adapters/kernels and exposed in API toc

  20. Added update notes: summarized core changes, meta/shape planning flow, and follow-up steps

  21. Change summary: captured new modules and metadata strategy in docs/change_summary.md

  22. Removed outdated roadmaps: dropped obsolete markdown plans to declutter repo

  23. Sphinx exclusions: temporarily skipped broken example pages until formatting repaired

  24. CustomState py3.12: enabled postponed annotations to avoid ndarray|None parsing error

  25. Expression interpreter docs: rewritten for clarity and to fix Sphinx indentation issues

  26. Measurements docstrings: clarified POVM/PNR noise models and destructiveness flags

  27. Kraus docstrings: inline examples added to adapters/kernels for users

  28. Envelope repr: adjusted tensor product symbol to match tests and docs

  29. Lint fixes: removed unused imports, trimmed whitespace, resolved triple-quote syntax error

  30. API toc: expanded autosummary to include new core and state utils modules

  31. Benchmarks/contributing: fixed list-table content and heading underline lengths

  32. Example rst fixes: corrected code directives and underlines in jaynes_cummings/time_bin/super_dense_coding

  33. Measurement notes: documented destructive vs non-destructive outcomes and returned shapes

  34. Kraus planning: explained how contraction is toggled and where reshape happens

  35. RNG utilities: documented borrow/split behavior for stochastic paths

  36. Suggested next steps: re-enable excluded examples once formatting is corrected

  37. Testing: added coverage for jit/meta flows, contraction flags, and measurement RNG split

  38. ShapePlan guidance: encourage reuse to keep JIT shapes static

  39. Core overview: clarified adapter vs kernel responsibilities in docs

  40. Summary: single commit consolidating code, tests, and documentation updates for the new measurement and core architecture

Before submitting

Please complete the following checklist when submitting a PR:

  • [] All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    test directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes.

  • The Photon_Weave source code conforms to
    PEP8 standards.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.

Context:

Description of the Change:

Benefits:

Possible Drawbacks:

Related GitHub Issues:

@kareem1925
1) Measurement docstrings: expanded vector/matrix measurement, POVM, …
2a53d53 
…PNR, expectation, JIT wrappers with shapes, key handling, and noise notes

2) RNG handling: split keys drop first subkey to decorrelate repeated calls across different seeds
3) Kraus/measure paths: validated operator shapes, clarified contraction use, restored standalone ordering after application
4) Envelope measurement/Kraus: ensure contractions align with Config and maintain post-op consistency
5) Adapters overview: reorder targets forward, call kernels, contract optionally, restore ordering; added jit/meta entry points
6) Kernels overview: stateless tensor primitives for apply/measure/trace/kraus assuming targets front-most
7) Linear/ops layers: thin array-facing dispatchers into adapters/kernels
8) Meta helpers: DimsMeta stores dims/indices/permutations to keep shapes static for JIT and vmap
9) ShapePlan: pairs DimsMeta with state ordering for compiled kernels to reuse metadata across calls
10) Jitted helpers: bind metas for static-shape invocation paths
11) Core modules: added adapters, kernels, linear, ops, rng, jitted, meta, __init__ wiring
12) State interfaces: added shared BaseState typing surface for compiled kernels
13) Shape planning utils: added compiled kernels and plan builder for repeated ops
14) Measurement RNG tests: ensure different base keys yield different outcomes after splitting
15) Adapter/Kraus tests: contraction flags, jit/meta paths, shape validation covered
16) Ops utils tests: contract vs. non-contract apply_kraus_matrix behavior verified
17) Doc infrastructure: enabled myst_parser for Markdown, mocked heavy imports to avoid build failures
18) Docs cleanup: fixed headings/underlines/code blocks in index, intro, contributing, benchmarks, examples pages
19) Added api/core pages: documented adapters/kernels and exposed in API toc
20) Added update notes: summarized core changes, meta/shape planning flow, and follow-up steps
21) Change summary: captured new modules and metadata strategy in docs/change_summary.md
22) Removed outdated roadmaps: dropped obsolete markdown plans to declutter repo
23) Sphinx exclusions: temporarily skipped broken example pages until formatting repaired
24) CustomState py3.12: enabled postponed annotations to avoid ndarray|None parsing error
25) Expression interpreter docs: rewritten for clarity and to fix Sphinx indentation issues
26) Measurements docstrings: clarified POVM/PNR noise models and destructiveness flags
27) Kraus docstrings: inline examples added to adapters/kernels for users
28) Envelope repr: adjusted tensor product symbol to match tests and docs
29) Lint fixes: removed unused imports, trimmed whitespace, resolved triple-quote syntax error
30) API toc: expanded autosummary to include new core and state utils modules
31) Benchmarks/contributing: fixed list-table content and heading underline lengths
32) Example rst fixes: corrected code directives and underlines in jaynes_cummings/time_bin/super_dense_coding
33) Measurement notes: documented destructive vs non-destructive outcomes and returned shapes
34) Kraus planning: explained how contraction is toggled and where reshape happens
35) RNG utilities: documented borrow/split behavior for stochastic paths
36) Suggested next steps: re-enable excluded examples once formatting is corrected
37) Testing: added coverage for jit/meta flows, contraction flags, and measurement RNG split
38) ShapePlan guidance: encourage reuse to keep JIT shapes static
39) Core overview: clarified adapter vs kernel responsibilities in docs
40) Summary: single commit consolidating code, tests, and documentation updates for the new measurement and core architecture
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SimonSekavcnik SimonSekavcnik Awaiting requested review from SimonSekavcnik

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kareem1925