{ "cells": [ { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "%matplotlib inline" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n# Defining Custom Compilers\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "A :py:class:`~trueq.compilation.Compiler` instance contains a list of\n:py:class:`~trueq.compilation.base.Pass` instances. During compilation of a circuit,\neach of these passes are executed, in order, to mutate a copy of the circuit. See the\n:doc:`compiler API page<../../api/compilation>` for a complete list of\nbuilt-in passes and their documentation.\n\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Predefined Pass Lists\nSeveral useful combinations of pass classes are provided as members of the\ncompiler class: :py:attr:`~trueq.compilation.Compiler.HARDWARE_PASSES`\\,\n:py:attr:`~trueq.compilation.Compiler.SIMPLIFY_PASSES`\\,\n:py:attr:`~trueq.compilation.Compiler.RC_PASSES`\\, and\n:py:attr:`~trueq.compilation.Compiler.NATIVE2Q_PASSES`\\. See their documentation for\nfurther details.\n\nNote that these pass classes need to be instantiated before they can be given to the\ncompiler constructor. For certain types of advanced usage, directly invoking the\nconstructor may be the preferred method. However, the compiler also has two static\ncovenience methods to automate pass instantiation:\n:py:meth:`~trueq.compilation.Compiler.from_config` and\n:py:meth:`~trueq.compilation.Compiler.basic`\\. The first of these uses a\n:py:class:`~trueq.Config` object to pass relevant gate factories to each pass, and the\nsecond is a further specialization that auto-instantiates these factories based on\na desired entangling gate and mode (which may not be relevant to all passes).\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "import trueq as tq\n\n# a compiler to simplify circuits\ncompiler1 = tq.Compiler.basic(passes=tq.Compiler.SIMPLIFY_PASSES)\n\n# a compiler that does randomized compiling\ncompiler2 = tq.Compiler.basic(passes=tq.Compiler.RC_PASSES)\n\n# a compiler that decomposes two-qubit gates into the specified entangling gate,\n# then randomly compiles, and then converts all gates into hardware compatable gates.\n# for this example, we use the maximally entangling cross-resonance gate.\npasses = (\n tq.Compiler.NATIVE2Q_PASSES + tq.Compiler.RC_PASSES + tq.Compiler.HARDWARE_PASSES\n)\ncompiler3 = tq.Compiler.basic(entangler=tq.Gate.rp(\"ZX\", 90), passes=passes)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We demonstrate the last of these compilers by defining the following circuit:\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "circuit = tq.Circuit(\n [{range(4): tq.Gate.h}, {(0, 1): tq.Gate.rp(\"ZZ\", 22), (2, 3): tq.Gate.cz}]\n).measure_all()\ncircuit" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We see that the compiled circuit contains only CNOT gates, Z rotations, and X90\nrotations. Adjacent single qubit gates have been merged together on each qubit.\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "compiler3.compile(circuit)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Custom Pass Lists\nCustom lists of passes can be used if none of the predifined lists have the desired\nbehaviour. We can pass lists of these classes to\n:py:meth:`~trueq.compilation.Compiler.from_config` or\n:py:meth:`~trueq.compilation.Compiler.basic`\\, as discussed above, or we can use the\ncompiler constructor directly, as in the following example.\n\nFirst, we define a device configuration. Here, we use the Berkeley gate as the\nentangling operation.\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "b = tq.Gate.from_generators(\"XX\", 90, \"YY\", 45)\nconfig = tq.Config(\n factories=[\n tq.config.GateFactory.from_matrix(\"B\", b),\n tq.config.GateFactory.from_hamiltonian(\"x90\", [[\"X\", 90]]),\n tq.config.GateFactory.from_hamiltonian(\"z\", [[\"Z\", \"phi\"]]),\n ],\n mode=\"ZXZXZ\",\n)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Next, we define a compiler. Unlike,\n:py:attr:`~trueq.compilation.Compiler.HARDWARE_PASSES`\\, this compiler starts by\nmerging adjacent two-qubit gates. Also, we know that any two qubit gate can be\ndecomposed into two Berkeley gates interleaved with single qubit gates. We use\n:py:class:`tq.compilation.NativeDecomp` fixed at ``depth=2`` to force every\ntwo-qubit gate to decompose into two Berkeley gates, even if only one is required.\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "decomposer = tq.compilation.NativeDecomp(depth=2, factories=config.factories)\ncompiler = tq.Compiler(\n [\n tq.compilation.Merge(n_labels=2),\n tq.compilation.Parallel(decomposer),\n tq.compilation.Merge(),\n tq.compilation.Native1Q(config.factories),\n tq.compilation.RemoveEmptyCycle(),\n ]\n)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Next, we define a circuit to test this compiler on.\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "circuit = tq.Circuit(\n [\n {range(4): tq.Gate.h},\n {(0, 1): tq.Gate.rp(\"ZZ\", 22)},\n {(0, 1): tq.Gate.cnot, (2, 3): tq.Gate.swap},\n ]\n).measure_all()\ncircuit" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The resulting compiled circuit is as follows.\n\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": { "collapsed": false }, "outputs": [], "source": [ "compiler.compile(circuit)" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.7.11" } }, "nbformat": 4, "nbformat_minor": 0 }