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

Remove XIR files and clean up documentation #69

Merged
merged 23 commits into from
Nov 24, 2021

Conversation

Mandrenkov
Copy link
Collaborator

@Mandrenkov Mandrenkov commented Nov 15, 2021

Context:
The XIR is now available on PyPI and is being actively maintained in a different repository.

After this PR is merged, Jet can be released on PyPI.

Description of the Change:

  • Removed all XIR source files and tests (the former is now fetched from PyPI).
  • Updated the XIR interpreter to use the latest version and conventions of the XIR.
  • Created a standalone requirements.txt file as per the PyPA guidelines.
  • Renamed get_xir_library() to get_xir_manifest() and added declarations for the supported outputs.
  • Fixed a number of small issues including typos, missing hyperlinks, and outdated documentation.

Benefits:

  • Jet is more streamlined and no longer contains any XIR implementation or tests.
  • The high-level documentation is more current and consistent with other Xanadu repositories.

Possible Drawbacks:

  • Some existing XIR scripts may no longer be interpretable by Jet since the previous revision of the XIR interpreter was based on an old version of the XIR.

Related GitHub Issues:
None.

@github-actions
Copy link

github-actions bot commented Nov 15, 2021

Test Report (C++) on Ubuntu

    1 files  ±0      1 suites  ±0   0s ⏱️ ±0s
524 tests ±0  524 ✔️ ±0  0 💤 ±0  0 ±0 
873 runs  ±0  873 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 9d2b62b. ± Comparison against base commit cb4ab41.

This pull request removes 318 and adds 318 tests. Note that renamed tests count towards both.
runner.global ‑ ContractTensors - c128_t/Contract T0(a) and T1(a,b) -> T2(b)
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b) and T1(a,b) -> scalar
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b) and T1(b) -> T2(a)
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b,c) and T1(b,c,d) -> T2(a,d)
runner.global ‑ ContractTensors - c64_t/Contract T0(a) and T1(a,b) -> T2(b)
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b) and T1(a,b) -> scalar
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b) and T1(b) -> T2(a)
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b,c) and T1(b,c,d) -> T2(a,d)
runner.global ‑ DefaultPermuter<>::Transpose Non power-of-2 data/{b,c,a} - > {a,b,c}
runner.global ‑ DefaultPermuter<>::Transpose Non power-of-2 data/{c,a,b} - > {a,b,c}
…
runner.global ‑ ContractTensors - c128_t/Contract T0(a) and T1(a,b) -> T2(b)
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b) and T1(a,b) -> scalar
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b) and T1(b) -> T2(a)
runner.global ‑ ContractTensors - c128_t/Contract T0(a,b,c) and T1(b,c,d) -> T2(a,d)
runner.global ‑ ContractTensors - c64_t/Contract T0(a) and T1(a,b) -> T2(b)
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b) and T1(a,b) -> scalar
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b) and T1(b) -> T2(a)
runner.global ‑ ContractTensors - c64_t/Contract T0(a,b,c) and T1(b,c,d) -> T2(a,d)
runner.global ‑ DefaultPermuter<>::Transpose Non power-of-2 data/{b,c,a} - > {a,b,c}
runner.global ‑ DefaultPermuter<>::Transpose Non power-of-2 data/{c,a,b} - > {a,b,c}
…

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Nov 15, 2021

Test Report (Python) on Ubuntu

    1 files  ±    0      1 suites  ±0   5s ⏱️ -2s
300 tests  - 256  300 ✔️  - 256  0 💤 ±0  0 ±0 

Results for commit 9d2b62b. ± Comparison against base commit cb4ab41.

This pull request removes 556 and adds 300 tests. Note that renamed tests count towards both.
python.tests.jet.test_circuit ‑ test_wire_index
python.tests.jet.test_circuit.TestCircuit ‑ test_append_dangling_gate
python.tests.jet.test_circuit.TestCircuit ‑ test_append_dangling_state
python.tests.jet.test_circuit.TestCircuit ‑ test_append_one_wire_gate
python.tests.jet.test_circuit.TestCircuit ‑ test_append_one_wire_state
python.tests.jet.test_circuit.TestCircuit ‑ test_append_two_wire_gate
python.tests.jet.test_circuit.TestCircuit ‑ test_append_two_wire_state
python.tests.jet.test_circuit.TestCircuit ‑ test_constructor
python.tests.jet.test_circuit.TestCircuit ‑ test_indices
python.tests.jet.test_circuit.TestCircuit ‑ test_take_expected_value[Observables]
…
python.tests.test_circuit ‑ test_wire_index
python.tests.test_circuit.TestCircuit ‑ test_append_dangling_gate
python.tests.test_circuit.TestCircuit ‑ test_append_dangling_state
python.tests.test_circuit.TestCircuit ‑ test_append_one_wire_gate
python.tests.test_circuit.TestCircuit ‑ test_append_one_wire_state
python.tests.test_circuit.TestCircuit ‑ test_append_two_wire_gate
python.tests.test_circuit.TestCircuit ‑ test_append_two_wire_state
python.tests.test_circuit.TestCircuit ‑ test_constructor
python.tests.test_circuit.TestCircuit ‑ test_indices
python.tests.test_circuit.TestCircuit ‑ test_take_expected_value[Observables]
…

♻️ This comment has been updated with latest results.

@Mandrenkov Mandrenkov changed the title [WIP] Remove XIR files Remove XIR files and clean up documentation Nov 16, 2021
@Mandrenkov Mandrenkov marked this pull request as ready for review November 16, 2021 01:16
Copy link
Contributor

@trbromley trbromley left a comment

Choose a reason for hiding this comment

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

Thanks @Mandrenkov! I just had a few questions about the links in the readme

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
python/requirements.txt Outdated Show resolved Hide resolved
Copy link

@thisac thisac left a comment

Choose a reason for hiding this comment

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

Great work @Mandrenkov! 💯 Nothing major blocking, will approve as soon as the comments from myself and Tom are addressed. 🙂

python/jet/interpreter.py Outdated Show resolved Hide resolved
python/jet/interpreter.py Outdated Show resolved Hide resolved
python/tests/test_interpreter.py Show resolved Hide resolved
python/tests/test_interpreter.py Show resolved Hide resolved
Copy link

@thisac thisac left a comment

Choose a reason for hiding this comment

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

Looks great! 💯

python/jet/interpreter.py Show resolved Hide resolved
@Mandrenkov
Copy link
Collaborator Author

Thanks, @thisac and @trbromley!

@Mandrenkov Mandrenkov merged commit 63d75e1 into main Nov 24, 2021
@Mandrenkov Mandrenkov deleted the sc-8030-remove-xir-files branch November 24, 2021 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants