Adding WASM support #77

neal-erickson · 2024-01-02T19:14:31Z

Allowing WASM to work correctly from both the Circuit construction approach as well as allowing it to be passed in on the CLI for PECOS round-tripping.

.gitignore

.pre-commit-config.yaml

pytket/phir/phirgen.py

tests/data/qasm/bell.qasm

tests/test_api.py

pytket/phir/phirgen.py

pytket/phir/cli.py

ruff.toml

pytket/phir/cli.py

Co-authored-by: Kartik Singhal <[email protected]>

qartik

Few more small suggestions, I still need to test the PR locally on my machine.

Edit: Done, looking good. Will wait for the test update before approval.

pytket/phir/cli.py

pytket/phir/phirgen.py

qciaran · 2024-01-09T00:09:34Z

I primarily use pytket.phir.api.pytket_to_phir() or pytket.phir.api.qasm_to_phir(). It seems like these do not include wasm input. I see the CLI has the option to read in a wasm file. Also, when running wasm, I often directly supply the wasm byte object, so if possible it would be nice to either supply the byte object or file path.

qciaran · 2024-01-09T22:47:01Z

I get what I expect when running a simulation after generating PHIR from using circuit_from_qasm_wasm and pytket_to_phir.

tests/data/qasm/bell.qasm

tests/test_api.py

qartik · 2024-01-18T13:44:30Z

Looking good, thanks for finding a solution for consuming wat files. It will be nice if we can consume either wasm or wat files through the CLI as well. Could you also update the README after making changes to the CLI?

pytket/phir/api.py

qartik

LGTM.

qartik

As noticed by @Asa-Kosto-QTM in #96, the tket opt level arg needs to be handled correctly here. Currently, showing up as a merge conflict.

neal-erickson · 2024-01-21T00:45:54Z

@qartik tket_opt_level fix was already in place due to CLI changes. main merged into this branch.

qartik · 2024-01-22T18:08:48Z

tests/test_api.py

+
+        wasm_bytes = get_wat_as_wasm_bytes(WatFile.add)
+
+        wasm_uid = hashlib.sha256(base64.b64encode(wasm_bytes)).hexdigest()


@neal-erickson I referenced https://github.com/CQCL/tket/blob/6906704b0ad64d077dff5c71454652926f91ee12/pytket/pytket/wasm/wasm.py#L77-L81 to generate this wasm_id

qartik · 2024-01-22T18:09:30Z

tests/test_api.py

+
+        phir = json.loads(phir_str)
+
+        expected_metadata = {"ff_object": (f"WASM module uid: {w!s}")}


Here, since we are in pytket land, we can just use the string representation of the WasmFileHandler instance.

qartik

LGTM

qartik · 2024-01-23T11:08:06Z

It will be nice if we can consume either wasm or wat files through the CLI as well.

I was trying to see if I can add the functionality to accept .wat files but noticed that currently even .wasm files fail with an error:

❯ cat wasm.qasm
OPENQASM 2.0;
include "qelib1.inc";

qreg q[2];
h q;
ZZ q[1],q[0];
creg cr[3];
creg cs[3];
creg co[3];
measure q[0]->cr[0];
measure q[1]->cr[1];

cs = cr;
co = add(cr, cs);

❯ phirc -v -w add.wasm wasm.qasm
Processing wasm.qasm
Including WASM from file add.wasm

PHIR to be simulated:
{"format": "PHIR/JSON", "version": "0.1.0", "metadata": {"source": "pytket-phir v0.2.2.dev35", "strict_parallelism": true}, "ops": [{"data": "qvar_define", "data_type": "qubits", "variable": "q", "size": 2}, {"data": "cvar_define", "data_type": "u32", "variable": "cr", "size": 3}, {"data": "cvar_define", "data_type": "u32", "variable": "cs", "size": 3}, {"data": "cvar_define", "data_type": "u32", "variable": "co", "size": 3}, {"//": "Parallel Rz(1)"}, {"qop": "RZ", "angles": [[1.0], "pi"], "args": [["q", 0], ["q", 1]]}, {"//": "Parallel PhasedX(0.5, 0.5)"}, {"qop": "R1XY", "angles": [[0.5, 0.5], "pi"], "args": [["q", 0], ["q", 1]]}, {"//": "Parallel RZ"}, {"block": "qparallel", "ops": [{"qop": "RZ", "angles": [[0.5], "pi"], "args": [["q", 0]]}, {"qop": "RZ", "angles": [[1.5], "pi"], "args": [["q", 1]]}]}, {"//": "ZZPhase(0.5) q[1], q[0];"}, {"qop": "RZZ", "angles": [[0.5], "pi"], "args": [[["q", 1], ["q", 0]]]}, {"mop": "Transport", "duration": [0.0, "ms"]}, {"//": "Parallel RZ"}, {"block": "qparallel", "ops": [{"qop": "RZ", "angles": [[1.5], "pi"], "args": [["q", 0]]}, {"qop": "RZ", "angles": [[0.5], "pi"], "args": [["q", 1]]}]}, {"qop": "Measure", "args": [["q", 0], ["q", 1]], "returns": [["cr", 0], ["cr", 1]]}, {"mop": "Transport", "duration": [0.0, "ms"]}, {"//": "CopyBits cr[0], cr[1], cr[2], cs[0], cs[1], cs[2];"}, {"cop": "=", "returns": [["cs", 0], ["cs", 1], ["cs", 2]], "args": [["cr", 0], ["cr", 1], ["cr", 2]]}, {"mop": "Transport", "duration": [0.0, "ms"]}, {"//": "WASM function=add args=['cr', 'cs'] returns=['co']"}, {"cop": "ffcall", "function": "add", "args": ["cr", "cs"], "metadata": {"ff_object": "WASM module uid: 48b455b2aba63187d5f1720a71762c3f5cfbd359c309c1fa91e5d7027b2e111a"}, "returns": ["co"]}, {"mop": "Transport", "duration": [0.0, "ms"]}]}

PECOS results:
Traceback (most recent call last):
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/bin/phirc", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/lib/python3.12/site-packages/pytket/phir/cli.py", line 84, in main
    print(HybridEngine(qsim="state-vector").run(program=phir, shots=10))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/lib/python3.12/site-packages/pecos/engines/hybrid_engine.py", line 160, in run
    self.initialize_sim_components(program, foreign_object)
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/lib/python3.12/site-packages/pecos/engines/hybrid_engine.py", line 101, in initialize_sim_components
    num_qubits = self.cinterp.init(program, foreign_object)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/lib/python3.12/site-packages/pecos/classical_interpreters/phir_classical_interpreter.py", line 95, in init
    self.check_ffc(self.program.foreign_func_calls, self.foreign_obj)
  File "/Users/kartik/GH/CQCL/pytket-phir/.venv/lib/python3.12/site-packages/pecos/classical_interpreters/phir_classical_interpreter.py", line 103, in check_ffc
    func_names = set(fobj.get_funcs())
                     ^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'get_funcs'

Do we know what may be going on? cc: @qciaran

qciaran · 2024-01-23T17:38:35Z

Do we know what may be going on? cc: @qciaran

My guess you are trying to run PHIR that is calling Wasm but not supplying the Wasm to PECOS via a "ForeignObj". It would be something like:

from pecos.foreign_objects.wasmtime import WasmtimeObj
wasm_obj = WasmtimeObj("./wasm/add.wasm")  # input can be file path to .wat or .wasm, or bytes
HybridEngine(...).run(phir, foreign_object=wasm_obj, ...)

It might be good for me to make the run() interface a little nice by supplying a wasm_bytes option and it do all the work of preparing the object for you.

You can see some example useage here: https://github.com/PECOS-packages/PECOS/blob/566029d49f57da5510b4e443f1fb13964aa273ec/tests/integration/test_phir.py#L64

qartik · 2024-01-23T19:44:32Z

pytket/phir/cli.py


 from argparse import ArgumentParser
 from importlib.metadata import version

 from pecos.engines.hybrid_engine import HybridEngine  # type:ignore [import-not-found]
+from pecos.foreign_objects.wasmtime import WasmtimeObj  # type:ignore [import-not-found]


Just sent a PR to pecos at PECOS-packages/PECOS#37 to avoid these type ignores.

qartik

looking good!

qciaran

Working for me/LGTM

nealerickson-qtm and others added 2 commits January 2, 2024 12:09

WASM support

4c4418d

Merge branch 'main' into issue-50-wasm-support

4fe3a7c

qartik reviewed Jan 3, 2024

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

qartik reviewed Jan 3, 2024

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

qartik reviewed Jan 3, 2024

View reviewed changes

pytket/phir/phirgen.py Outdated Show resolved Hide resolved

nealerickson-qtm and others added 2 commits January 2, 2024 20:51

feedback

fa7a818

Merge branch 'main' into issue-50-wasm-support

251d32f

qartik requested changes Jan 4, 2024

View reviewed changes

qartik linked an issue Jan 4, 2024 that may be closed by this pull request

Add Wasm support #50

Closed

neal-erickson and others added 2 commits January 4, 2024 13:29

Update pytket/phir/phirgen.py

e3af6c7

Co-authored-by: Kartik Singhal <[email protected]>

cleanup

12647cf

qartik reviewed Jan 4, 2024

View reviewed changes

pytket/phir/cli.py Outdated Show resolved Hide resolved

pytket/phir/cli.py Outdated Show resolved Hide resolved

pytket/phir/phirgen.py Outdated Show resolved Hide resolved

Merge branch 'main' into issue-50-wasm-support

e7ca093

qartik and others added 11 commits January 10, 2024 09:31

Merge branch 'main' into issue-50-wasm-support

f5009f7

Merge branch 'main' into issue-50-wasm-support

2874c39

Merge branch 'main' into issue-50-wasm-support

3b3a01d

removing direct wasm usage, adding wasmtime, improving testing

10b482c

Merge branch 'main' into issue-50-wasm-support

c834934

cleanup

fd76eae

removing large file exemption

8d84539

Merge branch 'wasm-support' into issue-50-wasm-support

6906eeb

style: ignore the whole file vs per line for misc

1d2f0ff

build(mypy): include wasmtime in pre-commit mypy

749ad20

style: remove unneeded import

9265dee

qartik reviewed Jan 18, 2024

View reviewed changes

tests/data/qasm/bell.qasm Outdated Show resolved Hide resolved

qartik reviewed Jan 18, 2024

View reviewed changes

tests/test_api.py Outdated Show resolved Hide resolved

qartik reviewed Jan 18, 2024

View reviewed changes

tests/test_api.py Outdated Show resolved Hide resolved

qartik reviewed Jan 18, 2024

View reviewed changes

tests/test_api.py Outdated Show resolved Hide resolved

style(mypy): remove unneeded cast

69d9d09

feedback

47c4699

qciaran reviewed Jan 18, 2024

View reviewed changes

pytket/phir/api.py Show resolved Hide resolved

making the temp files work on windows

1734e43

qartik approved these changes Jan 19, 2024

View reviewed changes

qartik requested changes Jan 20, 2024

View reviewed changes

Merge branch 'main' into issue-50-wasm-support

a0347ff

nealerickson-qtm and others added 5 commits January 22, 2024 09:51

fixing test

73f80ef

Merge branch 'main' into issue-50-wasm-support

b3f71f9

Fixing windows on test

f2e72af

style: move misc ignore to whole file

f3e8b62

test(wasm): avoid magic hash for testing WASM module uid

e42c997

qartik reviewed Jan 22, 2024

View reviewed changes

docs: update README, add dev-all target for phirc CLI deps

1f401de

qartik previously approved these changes Jan 22, 2024

View reviewed changes

fix(cli): use -v for verbose and simplify

74227d3

qartik dismissed their stale review via 74227d3 January 23, 2024 11:03

nealerickson-qtm and others added 2 commits January 23, 2024 12:22

Using PECOS wasm correctly

6849cbf

style: avoid unneeded import

f8dd59a

qartik reviewed Jan 23, 2024

View reviewed changes

qartik approved these changes Jan 23, 2024

View reviewed changes

qciaran approved these changes Jan 23, 2024

View reviewed changes

neal-erickson merged commit a199f3c into main Jan 23, 2024
6 checks passed

neal-erickson deleted the issue-50-wasm-support branch January 23, 2024 19:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding WASM support #77

Adding WASM support #77

neal-erickson commented Jan 2, 2024

qartik left a comment •

edited

Loading

qciaran commented Jan 9, 2024

qciaran commented Jan 9, 2024

qartik commented Jan 18, 2024

qartik left a comment

qartik left a comment •

edited

Loading

neal-erickson commented Jan 21, 2024

qartik Jan 22, 2024

qartik Jan 22, 2024 •

edited

Loading

qartik left a comment

qartik commented Jan 23, 2024

qciaran commented Jan 23, 2024 •

edited by qartik

Loading

qartik Jan 23, 2024

qartik left a comment

qciaran left a comment


		wasm_bytes = get_wat_as_wasm_bytes(WatFile.add)

		wasm_uid = hashlib.sha256(base64.b64encode(wasm_bytes)).hexdigest()


		phir = json.loads(phir_str)

		expected_metadata = {"ff_object": (f"WASM module uid: {w!s}")}

Adding WASM support #77

Adding WASM support #77

Conversation

neal-erickson commented Jan 2, 2024

qartik left a comment • edited Loading

Choose a reason for hiding this comment

qciaran commented Jan 9, 2024

qciaran commented Jan 9, 2024

qartik commented Jan 18, 2024

qartik left a comment

Choose a reason for hiding this comment

qartik left a comment • edited Loading

Choose a reason for hiding this comment

neal-erickson commented Jan 21, 2024

qartik Jan 22, 2024

Choose a reason for hiding this comment

qartik Jan 22, 2024 • edited Loading

Choose a reason for hiding this comment

qartik left a comment

Choose a reason for hiding this comment

qartik commented Jan 23, 2024

qciaran commented Jan 23, 2024 • edited by qartik Loading

qartik Jan 23, 2024

Choose a reason for hiding this comment

qartik left a comment

Choose a reason for hiding this comment

qciaran left a comment

Choose a reason for hiding this comment

qartik left a comment •

edited

Loading

qartik left a comment •

edited

Loading

qartik Jan 22, 2024 •

edited

Loading

qciaran commented Jan 23, 2024 •

edited by qartik

Loading