Auto emulation rewrite step #514

msoeken · 2021-02-11T17:06:20Z

This PR implements a rewrite step that can link an operation Op to a set of pairs of an alternative operations AltOp and a simulator Sim, such that AltOp is executed as a replacement for Op when being invoked in Sim.

For example, we could write:

@SubstitutableOnTarget("Microsoft.Quantum.Intrinsic.CCNOT", "ToffoliSimulator")
operation ApplyAnd(control1 : Qubit, control2 : Qubit, target : Qubit) : Unit is Adj+Ctl {...}

to replace calls to ApplyAnd with CCNOT when being called in ToffoliSimulator.

This PR can solve the issue raised in #24.

To be done:

Add integration test project (which loads the rewrite step as Q# reference)
NuGet packaging
API review

msoeken · 2021-02-11T17:07:55Z

@cgranade, I think we need to discuss this in API review.

msoeken · 2021-02-11T17:12:29Z

I could use some help with how to package this as a NuGet package.

bettinaheim · 2021-03-31T01:17:20Z

@msoeken The compiler repo contains an example for how the package needs to look like: https://github.com/microsoft/qsharp-compiler/tree/main/examples/CompilerExtensions/ExtensionPackage
Taking a quick look, you are missing a props file that specifies which dll to load rewrite steps from. Let me know if you need further help with packaging, or if copying the setup from the example works.

msoeken · 2021-05-01T17:18:46Z

@bettinaheim @swernli I incorporated the API changes from microsoft/QuantumLibraries#426 and also added packaging. This PR is ready for review now. Thanks.

bettinaheim · 2021-06-09T15:42:25Z

@bettinaheim @swernli I incorporated the API changes from microsoft/QuantumLibraries#426 and also added packaging. This PR is ready for review now. Thanks.

Lgtm, but I haven't looked at the PR in full detail (e.g. checking for sufficient test coverage etc).

cgranade

Had a few last comments and thoughts, but looks good to me!

src/Simulation/AutoSubstitution.Integration.Tests/Integration.qs

src/Simulation/AutoSubstitution.Tests/CodeGenerationTests.cs

src/Simulation/AutoSubstitution/Substitution.qs

src/Simulation/AutoSubstitution.Tests/CodeGenerationTests.cs

src/Simulation/AutoSubstitution.Tests/TestFiles/Core.qs

src/Simulation/AutoSubstitution/RewriteStep.cs

cgranade · 2021-06-09T23:06:12Z

src/Simulation/AutoSubstitution/RewriteStep.cs

+                        return false;
+                    }
+
+                    var qualifiedName = new QsQualifiedName(alternativeOperation.Substring(0, period), alternativeOperation.Substring(period + 1));


To clarify, does this restrict the substitution target and alternative operation to be in the same namespace? Can alternativeOperation contain . characters to indicate a subnamespace of that namespace?

They can be in different namespaces. Here, I am just splitting the string into namespace + operation name and construct a QsQualifiedName instance from the two parts.

src/Simulation/AutoSubstitution/RewriteStep.cs

* Update API docs with more examples. (#701) Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * QIR runtime heap alloc and heap free functions removed (#703) * QIR runtime heap alloc and heap free functions removed * Implement Feedback Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * Add QIR Runtime to bootstrap script (#706) * Increasing the CMAKE required version for QIR (#708) This updates the required version for CMAKE in the CMakeLists.txt files for QIR, since we are now using features not correctly supported on older versions. * Added first version of Qubit manager to QIR (#696) This is the first version of the native Qubit Manager for QIR. Initial unit tests are included. Qubit Manager supports * Allocation and release of qubits including arrays of qubits. * Reuse encouraged/discouraged. Extending capacity enabled/disabled. * Restricted reuse areas and segments to support low-depth circuits. Qubit manager builds and tests are run as part of the qir-runtime-unittests. It is used in the bridge to the full state simulator. Commits: * Added first draft version of Qubit manager to QIR * Review feedback. Rearranged functions, QubitIdType, consts, etc. * include cstring for memcpy * Renamed QubitManager * Adjustment after QubitManager rename * Moved QubitManager.h to public * Using QubitManager, adjusted defaults, minor fixes * Removed unused comment * CR feedback: fixes to types, failures, braces, etc. * CR feedback - updated types, unique_ptr, etc. * Auxilliary stuff is now nested in CQubitmanager * Initializer lists * Updated CRestrictedReuseAreaStack and used iterator. * int32_t, more checks, some refactoring * Refactoring: marking and counting is done in allocate/release qubit id * Deletion of qubit object, protected members for overrides, Is...Qubit renames * Moved allocated marking to listQubitListInSharedArray class * Added comments, mostly status array * Tests, refactoring, replaced IsFreeQubit with IsFreeQubitId Co-authored-by: Dmitry Vasilevsky <dmitryv@microsoft.com> * Added treating warnings as errors (#718) * Added "QIR Runtime API Design Guidelines" (#711) * Initial add of QIR-RT-API-Design-Guidelines.md * Use of exceptions recommendation (#719) * Co-authored-by: Mathias Soeken * Co-authored-by: DmitryVasilevsky * Auto emulation rewrite step (#514) * First proposal for auto emulation feature. * Deprecation. * Update to newer version. * Successful tests. * Compatibility checks. * Do not change this file. * Signature checking too restrictive. * Add integration test. * Update QDK version. * Incorporate microsoft/QuantumLibraries#426. * Rename emulation to substitution. * Rename projects and directories. * Packaging. * Fix line-feed problems. * Fix LF. * Adressing reviewer feedback. * Update Sdk version. * Fixes dependency error. Co-authored-by: Mathias Soeken <masoeken@microsoft.com> Co-authored-by: Chris Granade <chgranad@microsoft.com> Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * Added compiler warning flags -Wall, -Wextra (#725) * Added -Wall, -Wextra * Add DelaySign.cs to AutoSubstitution project. (#729) * extra sln Co-authored-by: Chris Granade <chgranad@microsoft.com> Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> Co-authored-by: Pankaj Patil <pankaj.patil2099@hotmail.com> Co-authored-by: DmitryVasilevsky <60718360+DmitryVasilevsky@users.noreply.github.com> Co-authored-by: Dmitry Vasilevsky <dmitryv@microsoft.com> Co-authored-by: Robin Kuzmin <kuzmin.robin@gmail.com> Co-authored-by: Mathias Soeken <mathias.soeken@microsoft.com> Co-authored-by: Mathias Soeken <masoeken@microsoft.com>

* Replace generated files in Quantum.Client with reference to the Azure.QuantumJobs package (#697) * Changes to enable Mocks for iq# and integrate with Live tests (#707) * Credentials parameter (#721) * Move to CredentialFactory. * Adding support for DeviceCode * Merge main (#731) * Update API docs with more examples. (#701) Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * QIR runtime heap alloc and heap free functions removed (#703) * QIR runtime heap alloc and heap free functions removed * Implement Feedback Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * Add QIR Runtime to bootstrap script (#706) * Increasing the CMAKE required version for QIR (#708) This updates the required version for CMAKE in the CMakeLists.txt files for QIR, since we are now using features not correctly supported on older versions. * Added first version of Qubit manager to QIR (#696) This is the first version of the native Qubit Manager for QIR. Initial unit tests are included. Qubit Manager supports * Allocation and release of qubits including arrays of qubits. * Reuse encouraged/discouraged. Extending capacity enabled/disabled. * Restricted reuse areas and segments to support low-depth circuits. Qubit manager builds and tests are run as part of the qir-runtime-unittests. It is used in the bridge to the full state simulator. Commits: * Added first draft version of Qubit manager to QIR * Review feedback. Rearranged functions, QubitIdType, consts, etc. * include cstring for memcpy * Renamed QubitManager * Adjustment after QubitManager rename * Moved QubitManager.h to public * Using QubitManager, adjusted defaults, minor fixes * Removed unused comment * CR feedback: fixes to types, failures, braces, etc. * CR feedback - updated types, unique_ptr, etc. * Auxilliary stuff is now nested in CQubitmanager * Initializer lists * Updated CRestrictedReuseAreaStack and used iterator. * int32_t, more checks, some refactoring * Refactoring: marking and counting is done in allocate/release qubit id * Deletion of qubit object, protected members for overrides, Is...Qubit renames * Moved allocated marking to listQubitListInSharedArray class * Added comments, mostly status array * Tests, refactoring, replaced IsFreeQubit with IsFreeQubitId Co-authored-by: Dmitry Vasilevsky <dmitryv@microsoft.com> * Added treating warnings as errors (#718) * Added "QIR Runtime API Design Guidelines" (#711) * Initial add of QIR-RT-API-Design-Guidelines.md * Use of exceptions recommendation (#719) * Co-authored-by: Mathias Soeken * Co-authored-by: DmitryVasilevsky * Auto emulation rewrite step (#514) * First proposal for auto emulation feature. * Deprecation. * Update to newer version. * Successful tests. * Compatibility checks. * Do not change this file. * Signature checking too restrictive. * Add integration test. * Update QDK version. * Incorporate microsoft/QuantumLibraries#426. * Rename emulation to substitution. * Rename projects and directories. * Packaging. * Fix line-feed problems. * Fix LF. * Adressing reviewer feedback. * Update Sdk version. * Fixes dependency error. Co-authored-by: Mathias Soeken <masoeken@microsoft.com> Co-authored-by: Chris Granade <chgranad@microsoft.com> Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> * Added compiler warning flags -Wall, -Wextra (#725) * Added -Wall, -Wextra * Add DelaySign.cs to AutoSubstitution project. (#729) * extra sln Co-authored-by: Chris Granade <chgranad@microsoft.com> Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> Co-authored-by: Pankaj Patil <pankaj.patil2099@hotmail.com> Co-authored-by: DmitryVasilevsky <60718360+DmitryVasilevsky@users.noreply.github.com> Co-authored-by: Dmitry Vasilevsky <dmitryv@microsoft.com> Co-authored-by: Robin Kuzmin <kuzmin.robin@gmail.com> Co-authored-by: Mathias Soeken <mathias.soeken@microsoft.com> Co-authored-by: Mathias Soeken <masoeken@microsoft.com> * Apply suggestions from code review Co-authored-by: Chris Granade <chgranad@microsoft.com> * Incorporating feedback. * Build 0.17.2106.147878. Co-authored-by: Chris Granade <chgranad@microsoft.com> Co-authored-by: Stefan J. Wernli <swernli@microsoft.com> Co-authored-by: Pankaj Patil <pankaj.patil2099@hotmail.com> Co-authored-by: DmitryVasilevsky <60718360+DmitryVasilevsky@users.noreply.github.com> Co-authored-by: Dmitry Vasilevsky <dmitryv@microsoft.com> Co-authored-by: Robin Kuzmin <kuzmin.robin@gmail.com> Co-authored-by: Mathias Soeken <mathias.soeken@microsoft.com> Co-authored-by: Mathias Soeken <masoeken@microsoft.com>

msoeken and others added 6 commits December 1, 2020 23:00

First proposal for auto emulation feature.

a845ccb

Merge branch 'main' into merge

9da6e3e

Deprecation.

807e9d1

Update to newer version.

c45a3cd

Successful tests.

3d78eae

Compatibility checks.

d92efa9

Do not change this file.

8654388

msoeken marked this pull request as ready for review February 11, 2021 17:11

msoeken requested review from bettinaheim and swernli February 11, 2021 17:12

msoeken added 2 commits February 12, 2021 13:36

Signature checking too restrictive.

5083938

Add integration test.

7adf9fa

msoeken mentioned this pull request Mar 3, 2021

API discussion on auto emulation rewrite step microsoft/QuantumLibraries#424

Closed

Chris Granade added 2 commits March 15, 2021 11:37

Merge branch 'main' into msoeken/auto-emulation

8f55e5c

Merge branch 'main' into msoeken/auto-emulation

b28679a

msoeken and others added 8 commits April 30, 2021 15:22

Merge branch 'main' into msoeken/auto-emulation

41bb1a7

Update QDK version.

f363fa7

Incorporate microsoft/QuantumLibraries#426.

a2d25d7

Rename emulation to substitution.

4a92681

Rename projects and directories.

8189afb

Packaging.

681725b

Fix line-feed problems.

6c0f3d7

Fix LF.

f94c9b5

Merge branch 'main' into msoeken/auto-emulation

93fff5b

bettinaheim requested a review from cgranade June 9, 2021 15:41

cgranade approved these changes Jun 9, 2021

View reviewed changes

msoeken added 3 commits June 14, 2021 11:50

Adressing reviewer feedback.

8a165ca

Update Sdk version.

6096a22

Fixes dependency error.

b1d6544

msoeken enabled auto-merge (squash) June 15, 2021 12:19

Merge branch 'main' into msoeken/auto-emulation

f85b2d2

msoeken merged commit 232081d into main Jun 15, 2021

msoeken deleted the msoeken/auto-emulation branch June 15, 2021 14:15

msoeken added this to the June 2021 milestone Jun 16, 2021

This was referenced Jul 5, 2021

Add a Replacement(simulator, operation) attribute #453

Closed

Auto substitution sample microsoft/Quantum#522

Merged

Auto emulation rewrite step #514

Auto emulation rewrite step #514

Uh oh!

Conversation

msoeken commented Feb 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msoeken commented Feb 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msoeken commented Feb 11, 2021

Uh oh!

bettinaheim commented Mar 31, 2021

Uh oh!

msoeken commented May 1, 2021

Uh oh!

bettinaheim commented Jun 9, 2021

Uh oh!

cgranade left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cgranade Jun 9, 2021

Choose a reason for hiding this comment

Uh oh!

msoeken Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

msoeken commented Feb 11, 2021 •

edited

Loading

msoeken commented Feb 11, 2021 •

edited

Loading