" Input: { } Output: { return - return code = 0, if successful > 0, if error (error) - error text if return > 0 } "
Getting started
$ python3 --version # skip the following session if Python 3.6.x is already installed
$ sudo apt-get install python3 python3-pip
First, install brew if missing. Then:
$ brew update
$ brew unlink python
$ brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/f2a764ef944b1080be64bd88dca9a1d80130c558/Formula/python.rb
$ export PATH=/usr/local/opt/python/bin:$PATH # we suggest to put this into your .bashrc config file to avoid repeating in every terminal window
Use the official downloads and instructions.
$ python3 -m pip install marshmallow==2.15.0 qiskit==0.7 pandas==0.23.4 sklearn --user
Choose a directory where you would like to place the hackathon repository, change to that directory and run:
$ git clone https://github.com/riverlane/paris
In what follows, we refer to files in this repository (e.g. evaluate.py
), so make sure you stay in that directory.
Alternatively, you can download this repository as a zip file.
We suggest sticking to using git
, however, as we may need to provide updates during the hackathon (which you will then be able to obtain via git pull
).
To help you learn how quantum circuits work, we have provided a primer Qiskit program:
$ python3 qiskit_primer.py
Feel free to modify it to study the effects of applying quantum circuits to initial states.
ck-quantum
repository and its dependencies:$ ck pull repo:ck-quantum
You can check how to install Docker on your system here.
$ docker run -it --publish 3355:3344 ctuning/qck-hackathon.20190127
$ docker build --tag hackathon.20190127 https://raw.githubusercontent.com/ctuning/ck-quantum/master/docker/hackathon.20190127/Dockerfile
$ docker run -it --publish 3355:3344 hackathon.20190127
Please note that some functions will have to be run differently if you are using a Docker container.
The task repository contains several *.pyz
files specifying each problem to
solve. Each of these contains a set of training data - quantum state vectors
labelled by a parity (-1 or 1). For each problem, you are asked to compose a
quantum circuit which, when applied to each state vector in a test set, can
predict the correct parity label as accurately as possible.
In the first session of the day, we will help you set up your computers and walk through solving Problem 0. We will also show you how to share your solutions by using Collective Knowledge. Next, you will be free to attempt the remaining Problems 1-5 on your own. Each problem is outlined below.
To test your solutions, use evaluate.py
e.g. as follows:
$ python3 evaluate.py --fun discrete_solver --stats --problem discrete_problem1 -n 4
This runs your function discrete_solver
on discrete_problem1
, using 4 vectors for the training set.
Specific details are outlined below for each problem.
If you use the non-quantum solutions like classical_svm
, you may want to use more training examples.
The parameter -n
controls this.
To build quantum circuits, we will use the Qiskit simulator. Further documentation and examples can be found here.
For a good overview of quantum circuits and logic gates, check this wikipedia page.
discrete_problem0
)Number of qubits: 1
There are two state vectors labelled by 1
and -1
. We need to apply to the
single qubit a quantum circuit that will transform its state to one that will
retrieve the correct labels when measured.
You can look at manual_solver.py
in the
example_solutions
directory, and try to come up with a circuit that does this.
(Hint: Applying a Hadamard gate to
each state should do this.)
To run the solver, type the command:
$ python3 evaluate.py --fun manual_solver --problem discrete_problem0
discrete_problem1
)Number of qubits: 2
Now we have two qubits! The circuit consists of only two gates, one gate for each qubit. We promise the gates are combinations of X and H. Your job is to work out which ones.
You can look at manual_solver.py
, and try to come up with a circuit that does this.
To run this solver, type the command:
$ python3 evaluate.py --fun manual_solver --problem discrete_problem1
Alternatively, you could look at discrete_solver.py
, which can help automate the decision.
To run this solver, type the command:
$ python3 evaluate.py --fun discrete_solver --problem discrete_problem1
discrete_problem2
)Number of qubits: 2
Now there are multiple gates for each qubit. You will need to try interacting the qubits with one another using
CNOT gates.
CNOT gates are only applied to neighbouring qubits, e.g. qubit_0
-> qubit_1
, qubit_1
-> qubit_2
.
You can also use H, X and Y gates.
You can look at manual_solver.py
and try to come up with a circuit which does this.
To run the solver, type the command:
$ python3 evaluate.py --fun manual_solver --problem discrete_problem2
It will probably be too annoying and difficult to manually try all combinations.
Try modifying discrete_solver.py
to include the extra gates needed.
To run this solver, type the command:
$ python3 evaluate.py --fun discrete_solver --problem discrete_problem2
discrete_problem3
)Number of qubits: 4
A larger problem with a 2 qubit gate. There is a single 1-qubit gate (H, X, or Y) on each qubit to start, and then a single CNOT gate linking 2 neighbouring qubits.
You will need to restrict the search to only circuits with 5 gates that have this structure.
You can modify discrete_solver.py
to begin, but you will notice that the number of combinations is extremely large and so the solver will take a very long time to run. You should write your own solver which exploits the structure given above to reduce the number of circuit possibilities.
In order to do so, you need to know how we have produced the training and test data. We began with a quantum state on which we made a measurement. For the initial states we have chosen, this measurement is always equal to +/-1, and so this gave us a label. We then applied some quantum circuit to the original state to give the quantum state that we are giving you as data.
Therefore, the circuits you have been finding so far are 'undoing' the effect of the circuit we applied in order to get back to the original state. You can now use the information above about the circuit we applied to construct the inverse circuit. You will find it useful to know that all of H, X, Y and CNOT are self-inverse - the effect of each can be 'undone' by applying the same gate again. You will need to think carefully about how to invert a circuit which consists of multiple gates - in which order should the inverse gates be applied?
To run this solver, type the command:
$ python3 evaluate.py --fun <SOLVER_FUNCTION> --problem discrete_problem3
substituting <SOLVER_FUNCTION>
for your own.
continuous_problem4
)Number of qubits: 4
In this problem, we have used gates that we have not considered before – rotation gates. Each gate is parameterised by an angle, which can have any value from 0 to 2 pi. These gates perform rotations of the qubit state in the Bloch sphere.
This problem is based on a "state preperation circuit" for VQE used in quantum chemistry.
The circuit is called the Hardware Efficient Ansatz.
You should use continuous_solver.py
for this and larger continuous problems, since we are now trying to find a circuit which is a function of continuously varying parameters and not just discrete combinations of fixed gates.
You can try to optimise some parameters, i.e. circuit depth and minimize parameters.
To run this solver, type the command:
$ python3 evaluate.py --fun continuous_solver --problem continuous_problem4
continuous_problem5
)Number of qubits: 6
In order to solve this problem you will need to invert the circuit we are giving explicitly:
You need to optimise the rotation parameters. The angles are given above as 0, but it can be anything from 0 to 2pi.
You can try and use continuous_solver.py
but it will not be very efficient. You should make your own function that exploits the structure shown above.
To run this solver, type the command:
$ python3 evaluate.py --fun <SOLVER_FUNCTION> --stats --problem continuous_problem5
substituting <SOLVER_FUNCTION>
for your own.
The main type of objects that CK works with is called a "CK entry". A "CK entry" is a directory with metadata, optional data and optional code.
You will use CK to: 1. Convert your solutions into CK experiment entries. 1. View your own experiment entries using "the CK dashboard" in the local mode. 1. Upload your CK experiment entries to the cKnowledge.org server. 1. View everyone's solutions on the common CK dashboard on the server.
Each run of evaluate.py
creates a .json
output file in the current directory.
In order to be counted as a solution, it will have to be first "stored" as a CK entry:
$ ck store_experiment qml [--json_file=<json_file_name>] [--team=<schroedinger-cat-herders>]
An experiment entry is stored together with the team name.
If you do not specify the JSON file to upload, this command will prompt you to choose one from the current directory.
You can either supply the team name from the command line using the --team
option or enter it interactively when prompted.
To view your local experiment entries on a local dashboard:
$ ck display dashboard --scenario=hackathon.20190127
This command will open a browser page and turn itself into a server to that page. You can leave this server command running in its own terminal and open a new one. Or you can kill it when the page loads and reclaim the terminal - it's up to you.
To view your local experiment entries on a local dashboard, just follow the link to the local dashboard .
After some loading time you should see your local experiments displayed as data points in your browser.
In order for your solution to count in the competition, you will have to upload your best results to the server:
$ ck upload qml [ <experiment entries> ]
If you do not specify the entries to upload, this command will prompt you to choose one from a list. Please note that your competition points will depend on who uploads their solution to the server faster. (It is the time on the server during the upload that counts, not the local time during the run on your machine.) So please upload as soon as you are ready.
Visit the common dashboard.
... but you are more than welcome to try our 1st open QCK challenge!