From 15d9a0091567ede027a2e608987932da6715976a Mon Sep 17 00:00:00 2001 From: majafranz Date: Fri, 17 Mar 2023 12:48:46 +0100 Subject: [PATCH] initial commit --- .github/workflows/build-docker.yml | 34 + .gitignore | 8 + Dockerfile | 114 + LICENCE | 340 + README.md | 125 + .../configs/best_params/quantum.py | 71 + experimental_analysis/configs/database.py | 8 + experimental_analysis/configs/example.py | 90 + .../classical/COUTCM/basic_rejoin_shift.py | 64 + .../classical/COUTCM/mod_reduced_rejoin.py | 59 + .../COUTCM/mod_reduced_rejoin_384.py | 59 + .../classical/PGCM16/basic_rejoin_shift.py | 64 + .../classical/PGCM16/mod_reduced_rejoin.py | 58 + .../PGCM16/mod_reduced_rejoin_384.py | 58 + .../classical/PGCM8/basic_rejoin_shift.py | 65 + .../configs/hyper/quantum/COUTCM/base.py | 48 + .../configs/hyper/quantum/EXTIME/base.py | 52 + .../configs/hyper/quantum/PGCM16/base.py | 47 + experimental_analysis/configs/noisy_base.py | 50 + experimental_analysis/execute.py | 38 + .../hyper_search/hyper_call_classical_xval.py | 25 + .../hyper_search/hyper_call_quantum_xval.py | 55 + .../hyper_search/hyper_classical.py | 77 + .../hyper_search/hyper_classical_xval.py | 57 + .../hyper_search/hyper_quantum_agent.py | 93 + .../hyper_search/hyper_quantum_agent_min.py | 88 + .../hyper_search/hyper_quantum_base.py | 100 + .../hyper_search/hyper_quantum_base_min.py | 92 + .../hyper_search/hyper_quantum_critic.py | 94 + .../hyper_search/hyper_quantum_critic_min.py | 91 + experimental_analysis/main.py | 38 + .../noisy_simulation/call_q_agent.sh | 122 + .../noisy_simulation/call_q_base.sh | 122 + .../noisy_simulation/hyper_quantum_agent.py | 63 + .../noisy_simulation/hyper_quantum_base.py | 73 + .../paper_runs/run_classical_COUTCM.py | 32 + .../paper_runs/run_classical_PGCM16.py | 32 + .../paper_runs/run_classical_PGCM8.py | 20 + .../paper_runs/run_classical_rel4.py | 25 + .../paper_runs/run_fullq_rel4.py | 30 + .../paper_runs/run_qagent_rel4.py | 31 + .../paper_runs/run_qcritic_rel4.py | 31 + experimental_analysis/requirements.txt | 9 + .../src/algorithms/dqn/algorithm.py | 213 + .../src/algorithms/dqn/buffer.py | 116 + .../src/algorithms/dqn/policies.py | 148 + .../src/algorithms/dqn/replay.py | 113 + .../src/algorithms/dqn/utils.py | 70 + .../src/algorithms/dqn/validate.py | 52 + .../algorithms/policy_gradient/algorithm.py | 75 + .../src/algorithms/policy_gradient/buffer.py | 84 + .../policy_gradient/ppo/algorithm.py | 158 + experimental_analysis/src/algorithms/utils.py | 257 + experimental_analysis/src/configuration.py | 380 + .../src/database/database.py | 335 + .../src/database/database_utils.py | 359 + .../src/database/file_utils.py | 163 + .../src/database/joo_server.py | 73 + .../src/database/joo_server_utils.py | 53 + .../src/database/query_parser.py | 287 + .../src/database/sql_info.py | 530 + .../src/envs/join_order/actions.py | 14 + .../src/envs/join_order/environment.py | 300 + .../src/envs/join_order/rewards.py | 71 + .../src/envs/join_order/states.py | 198 + experimental_analysis/src/logger.py | 334 + .../src/models/classical/layers.py | 22 + .../src/models/quantum/noise_models_qiskit.py | 26 + .../src/models/quantum/vqc_layer_qiskit.py | 461 + .../src/models/quantum/vqc_layer_tfq.py | 332 + experimental_analysis/src/validate.py | 12 + experimental_analysis/tools/queries2csv.py | 54 + .../tools/query_generation.py | 181 + info/supplementary.pdf | Bin 0 -> 240398 bytes paper/Makefile | 27 + paper/colors.tex | 8 + paper/commands.tex | 108 + paper/gen_img.sh | 21 + paper/img-gen/convergence_rejoin_base.pdf | Bin 0 -> 42650 bytes paper/img-gen/convergence_rejoin_q_4rels.pdf | Bin 0 -> 24176 bytes paper/img-gen/convergence_rejoin_q_layers.pdf | Bin 0 -> 35345 bytes paper/img-gen/noisy_validation.pdf | Bin 0 -> 228377 bytes paper/img-gen/noisy_validation_median.pdf | Bin 0 -> 26456 bytes paper/img-gen/num_params.pdf | Bin 0 -> 26923 bytes paper/img-tikz/num_qubits.tex | 819 + paper/img.tex | 8 + paper/main.tex | 768 + paper/paper.pdf | Bin 0 -> 748822 bytes paper/references.bib | 1587 + paper/supplementary.pdf | Bin 0 -> 240257 bytes paper/supplementary.tex | 343 + paper/tikz-figs/circuit.tex | 72 + paper/tikz-figs/dimensions.tex | 19 + paper/tikz-figs/joins.tex | 135 + paper/tikz-figs/overview.tex | 141 + paper/tikz-figs/single_vs_multi.tex | 62 + paper/tikz-figs/step1.tex | 41 + paper/tikz-figs/step2.tex | 40 + paper/tikz-figs/vqc_detail.tex | 50 + plots/img-pdf/convergence_rejoin_base.pdf | Bin 0 -> 8925 bytes plots/img-pdf/convergence_rejoin_q_4rels.pdf | Bin 0 -> 5917 bytes plots/img-pdf/convergence_rejoin_q_layers.pdf | Bin 0 -> 12567 bytes plots/img-pdf/noisy_validation.pdf | Bin 0 -> 145454 bytes plots/img-pdf/noisy_validation_median.pdf | Bin 0 -> 6207 bytes plots/img-pdf/num_params.pdf | Bin 0 -> 8437 bytes plots/img-pdf/num_qubits.pdf | Bin 0 -> 7167 bytes plots/img-tikz/convergence_rejoin_base.tex | 1770 + plots/img-tikz/convergence_rejoin_q_4rels.tex | 465 + .../img-tikz/convergence_rejoin_q_layers.tex | 2215 + plots/img-tikz/noisy_validation.tex | 8657 + plots/img-tikz/noisy_validation_median.tex | 707 + plots/img-tikz/num_params.tex | 1243 + plots/img-tikz/num_qubits.tex | 819 + plots/layout.r | 72 + plots/plot.r | 619 + scalability/circuit_depth.csv | 169 + scalability/num_params.csv | 270001 +++++++++++++++ scalability/num_qubits.csv | 163 + scalability/num_qubits_stats.py | 120 + scalability/param_stats.py | 65 + scripts/generate_paper.sh | 29 + scripts/generate_plots.sh | 21 + scripts/install_postgres.sh | 58 + scripts/run.sh | 58 + scripts/run_classic.sh | 24 + scripts/run_noise.sh | 25 + scripts/run_quantum.sh | 28 + scripts/setup_JOB.sh | 20 + scripts/setup_JOB_without_cloning.sh | 26 + 129 files changed, 299946 insertions(+) create mode 100644 .github/workflows/build-docker.yml create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENCE create mode 100644 README.md create mode 100644 experimental_analysis/configs/best_params/quantum.py create mode 100644 experimental_analysis/configs/database.py create mode 100644 experimental_analysis/configs/example.py create mode 100644 experimental_analysis/configs/hyper/classical/COUTCM/basic_rejoin_shift.py create mode 100644 experimental_analysis/configs/hyper/classical/COUTCM/mod_reduced_rejoin.py create mode 100644 experimental_analysis/configs/hyper/classical/COUTCM/mod_reduced_rejoin_384.py create mode 100644 experimental_analysis/configs/hyper/classical/PGCM16/basic_rejoin_shift.py create mode 100644 experimental_analysis/configs/hyper/classical/PGCM16/mod_reduced_rejoin.py create mode 100644 experimental_analysis/configs/hyper/classical/PGCM16/mod_reduced_rejoin_384.py create mode 100644 experimental_analysis/configs/hyper/classical/PGCM8/basic_rejoin_shift.py create mode 100644 experimental_analysis/configs/hyper/quantum/COUTCM/base.py create mode 100644 experimental_analysis/configs/hyper/quantum/EXTIME/base.py create mode 100644 experimental_analysis/configs/hyper/quantum/PGCM16/base.py create mode 100644 experimental_analysis/configs/noisy_base.py create mode 100644 experimental_analysis/execute.py create mode 100644 experimental_analysis/hyper_search/hyper_call_classical_xval.py create mode 100644 experimental_analysis/hyper_search/hyper_call_quantum_xval.py create mode 100644 experimental_analysis/hyper_search/hyper_classical.py create mode 100644 experimental_analysis/hyper_search/hyper_classical_xval.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_agent.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_agent_min.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_base.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_base_min.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_critic.py create mode 100644 experimental_analysis/hyper_search/hyper_quantum_critic_min.py create mode 100644 experimental_analysis/main.py create mode 100644 experimental_analysis/noisy_simulation/call_q_agent.sh create mode 100644 experimental_analysis/noisy_simulation/call_q_base.sh create mode 100644 experimental_analysis/noisy_simulation/hyper_quantum_agent.py create mode 100644 experimental_analysis/noisy_simulation/hyper_quantum_base.py create mode 100644 experimental_analysis/paper_runs/run_classical_COUTCM.py create mode 100644 experimental_analysis/paper_runs/run_classical_PGCM16.py create mode 100644 experimental_analysis/paper_runs/run_classical_PGCM8.py create mode 100644 experimental_analysis/paper_runs/run_classical_rel4.py create mode 100644 experimental_analysis/paper_runs/run_fullq_rel4.py create mode 100644 experimental_analysis/paper_runs/run_qagent_rel4.py create mode 100644 experimental_analysis/paper_runs/run_qcritic_rel4.py create mode 100644 experimental_analysis/requirements.txt create mode 100644 experimental_analysis/src/algorithms/dqn/algorithm.py create mode 100644 experimental_analysis/src/algorithms/dqn/buffer.py create mode 100644 experimental_analysis/src/algorithms/dqn/policies.py create mode 100644 experimental_analysis/src/algorithms/dqn/replay.py create mode 100644 experimental_analysis/src/algorithms/dqn/utils.py create mode 100644 experimental_analysis/src/algorithms/dqn/validate.py create mode 100644 experimental_analysis/src/algorithms/policy_gradient/algorithm.py create mode 100644 experimental_analysis/src/algorithms/policy_gradient/buffer.py create mode 100644 experimental_analysis/src/algorithms/policy_gradient/ppo/algorithm.py create mode 100644 experimental_analysis/src/algorithms/utils.py create mode 100644 experimental_analysis/src/configuration.py create mode 100644 experimental_analysis/src/database/database.py create mode 100644 experimental_analysis/src/database/database_utils.py create mode 100644 experimental_analysis/src/database/file_utils.py create mode 100644 experimental_analysis/src/database/joo_server.py create mode 100644 experimental_analysis/src/database/joo_server_utils.py create mode 100644 experimental_analysis/src/database/query_parser.py create mode 100644 experimental_analysis/src/database/sql_info.py create mode 100644 experimental_analysis/src/envs/join_order/actions.py create mode 100644 experimental_analysis/src/envs/join_order/environment.py create mode 100644 experimental_analysis/src/envs/join_order/rewards.py create mode 100644 experimental_analysis/src/envs/join_order/states.py create mode 100644 experimental_analysis/src/logger.py create mode 100644 experimental_analysis/src/models/classical/layers.py create mode 100644 experimental_analysis/src/models/quantum/noise_models_qiskit.py create mode 100644 experimental_analysis/src/models/quantum/vqc_layer_qiskit.py create mode 100644 experimental_analysis/src/models/quantum/vqc_layer_tfq.py create mode 100644 experimental_analysis/src/validate.py create mode 100644 experimental_analysis/tools/queries2csv.py create mode 100644 experimental_analysis/tools/query_generation.py create mode 100644 info/supplementary.pdf create mode 100644 paper/Makefile create mode 100644 paper/colors.tex create mode 100644 paper/commands.tex create mode 100644 paper/gen_img.sh create mode 100644 paper/img-gen/convergence_rejoin_base.pdf create mode 100644 paper/img-gen/convergence_rejoin_q_4rels.pdf create mode 100644 paper/img-gen/convergence_rejoin_q_layers.pdf create mode 100644 paper/img-gen/noisy_validation.pdf create mode 100644 paper/img-gen/noisy_validation_median.pdf create mode 100644 paper/img-gen/num_params.pdf create mode 100644 paper/img-tikz/num_qubits.tex create mode 100644 paper/img.tex create mode 100644 paper/main.tex create mode 100644 paper/paper.pdf create mode 100644 paper/references.bib create mode 100644 paper/supplementary.pdf create mode 100644 paper/supplementary.tex create mode 100644 paper/tikz-figs/circuit.tex create mode 100644 paper/tikz-figs/dimensions.tex create mode 100644 paper/tikz-figs/joins.tex create mode 100644 paper/tikz-figs/overview.tex create mode 100644 paper/tikz-figs/single_vs_multi.tex create mode 100644 paper/tikz-figs/step1.tex create mode 100644 paper/tikz-figs/step2.tex create mode 100644 paper/tikz-figs/vqc_detail.tex create mode 100644 plots/img-pdf/convergence_rejoin_base.pdf create mode 100644 plots/img-pdf/convergence_rejoin_q_4rels.pdf create mode 100644 plots/img-pdf/convergence_rejoin_q_layers.pdf create mode 100644 plots/img-pdf/noisy_validation.pdf create mode 100644 plots/img-pdf/noisy_validation_median.pdf create mode 100644 plots/img-pdf/num_params.pdf create mode 100644 plots/img-pdf/num_qubits.pdf create mode 100644 plots/img-tikz/convergence_rejoin_base.tex create mode 100644 plots/img-tikz/convergence_rejoin_q_4rels.tex create mode 100644 plots/img-tikz/convergence_rejoin_q_layers.tex create mode 100644 plots/img-tikz/noisy_validation.tex create mode 100644 plots/img-tikz/noisy_validation_median.tex create mode 100644 plots/img-tikz/num_params.tex create mode 100644 plots/img-tikz/num_qubits.tex create mode 100644 plots/layout.r create mode 100644 plots/plot.r create mode 100644 scalability/circuit_depth.csv create mode 100644 scalability/num_params.csv create mode 100644 scalability/num_qubits.csv create mode 100644 scalability/num_qubits_stats.py create mode 100644 scalability/param_stats.py create mode 100755 scripts/generate_paper.sh create mode 100755 scripts/generate_plots.sh create mode 100755 scripts/install_postgres.sh create mode 100755 scripts/run.sh create mode 100755 scripts/run_classic.sh create mode 100755 scripts/run_noise.sh create mode 100755 scripts/run_quantum.sh create mode 100755 scripts/setup_JOB.sh create mode 100755 scripts/setup_JOB_without_cloning.sh diff --git a/.github/workflows/build-docker.yml b/.github/workflows/build-docker.yml new file mode 100644 index 000000000..19bdf9360 --- /dev/null +++ b/.github/workflows/build-docker.yml @@ -0,0 +1,34 @@ +name: Docker Image + +env: + REGISTRY: ghcr.io + IMAGE_NAME: qce24_repro +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Build Dockerimage + run: docker build -t ${{ env.IMAGE_NAME }}:latest . + + - name: Log in to the Container registry + uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Tag Docker image + run: docker image tag ${{ env.IMAGE_NAME }}:latest ${{ env.REGISTRY }}/lfd/rl_for_jo/${{ env.IMAGE_NAME }}:latest + + - name: Push Docker image + run: docker image push ${{ env.REGISTRY }}/lfd/rl_for_jo/${{ env.IMAGE_NAME }}:latest diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..d09608203 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +logs/ +__pycache__/ +queries/ +.venv/ +JOB/ +.python-version +postgres +paper/build/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..b42ea6ede --- /dev/null +++ b/Dockerfile @@ -0,0 +1,114 @@ +FROM ubuntu:22.04 + +LABEL author="Maja Franz " + +ENV DEBIAN_FRONTEND=noninteractive +ENV LANG="C.UTF-8" +ENV LC_ALL="C.UTF-8" + +# Install required packages +RUN apt-get update +RUN apt-get install -y software-properties-common +RUN add-apt-repository ppa:deadsnakes/ppa # For Python 3.9 +RUN apt-get install -y \ + python3.9 \ + python3-pip \ + python3.9-distutils \ + python3.9-dev \ + wget \ + git \ + r-base \ + libv8-dev \ + libreadline-dev \ + zlib1g-dev \ + texlive-latex-base \ + texlive-science \ + texlive-fonts-recommended \ + texlive-fonts-extra \ + texlive-publishers \ + texlive-bibtex-extra \ + texlive-luatex \ + biber + +# Install R packages for plotting +RUN R -e "install.packages('tidyverse',dependencies=TRUE, repos='http://cran.rstudio.com/')" +RUN R -e "install.packages('ggh4x',dependencies=TRUE, repos='http://cran.rstudio.com/')" +RUN R -e "install.packages('patchwork',dependencies=TRUE, repos='http://cran.rstudio.com/')" +RUN R -e "install.packages('tikzDevice',dependencies=TRUE, repos='http://cran.rstudio.com/')" +RUN R -e "install.packages('scales',dependencies=TRUE, repos='http://cran.rstudio.com/')" + +# Let Python 3.9 be global python version +RUN ln -s /usr/bin/python3.9 /usr/bin/python + +# Add user +RUN useradd -m -G sudo -s /bin/bash repro && echo "repro:repro" | chpasswd +USER repro + +WORKDIR /home/repro/postgres + +# setup PostgreSQL +ENV RLJO_PSQL_BASE=/home/repro/postgres + +## PostgreSQL +ENV RLJO_PSQL_DATA_DIRECTORY=$RLJO_PSQL_BASE/database +ENV RLJO_PSQL_SRC_DIRECTORY="$RLJO_PSQL_BASE/postgresql-16.0" +ENV RLJO_PSQL_INSTALL_DIRECTORY="$RLJO_PSQL_BASE/install" +ENV RLJO_PG_HINT_PLAN_BASE="$RLJO_PSQL_BASE/pg_hint_plan" +ENV RLJO_PG_HINT_PLAN_SRC_DIRECTORY="$RLJO_PG_HINT_PLAN_BASE/pg_hint_plan-REL16_1_6_0" + +WORKDIR $RLJO_PSQL_BASE +RUN wget https://ftp.postgresql.org/pub/source/v16.0/postgresql-16.0.tar.gz +RUN tar xvfz postgresql-16.0.tar.gz +RUN mkdir $RLJO_PSQL_INSTALL_DIRECTORY +RUN mkdir $RLJO_PSQL_DATA_DIRECTORY +WORKDIR $RLJO_PSQL_SRC_DIRECTORY +RUN ./configure --prefix=$RLJO_PSQL_INSTALL_DIRECTORY --enable-debug +RUN make -j $(nproc) +RUN make install +WORKDIR $RLJO_PSQL_BASE + +ENV PATH=$RLJO_PSQL_BASE/install/bin:$PATH +ENV LD_LIBRARY_PATH=$RLJO_PSQL_BASE/install/lib/ + +RUN initdb -D $RLJO_PSQL_DATA_DIRECTORY --user=postgres +RUN pg_ctl -D $RLJO_PSQL_DATA_DIRECTORY -l $RLJO_PSQL_BASE/logfile start + +## PG hint plugin +RUN mkdir $RLJO_PG_HINT_PLAN_BASE +WORKDIR $RLJO_PG_HINT_PLAN_BASE +RUN wget https://github.com/ossc-db/pg_hint_plan/archive/refs/tags/REL16_1_6_0.tar.gz +RUN tar xvfz REL16_1_6_0.tar.gz +WORKDIR $RLJO_PG_HINT_PLAN_SRC_DIRECTORY +RUN make -j $(nproc) +RUN make install + +ENV PATH=$PATH:/home/repro/postgres/install/bin + + +# setup join order benchmark +WORKDIR /home/repro + +ENV RLJO_JOB_BASE=/home/repro/JOB + +RUN mkdir $RLJO_JOB_BASE +RUN git clone -n https://github.com/danolivo/jo-bench $RLJO_JOB_BASE/jo-bench + +WORKDIR $RLJO_JOB_BASE/jo-bench +RUN git checkout a2019f9 + +# Add artifacts (from host) to home directory +ADD --chown=repro:repro . /home/repro/qce24_repro + +WORKDIR /home/repro/qce24_repro + +# install python packages +ENV PATH=$PATH:/home/repro/.local/bin +# set default python version to 3.9 +RUN echo 'alias python="python3.9"' >> /home/repro/.bashrc + +RUN python3.9 -m pip install -r experimental_analysis/requirements.txt + +# Experiments can be run, plots can be generated or paper can be built when +# container is started, see options in README or run script +ENTRYPOINT ["./scripts/run.sh"] +CMD ["bash"] diff --git a/LICENCE b/LICENCE new file mode 100644 index 000000000..d49b474cd --- /dev/null +++ b/LICENCE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 2024 Maja Franz + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 000000000..15986ff33 --- /dev/null +++ b/README.md @@ -0,0 +1,125 @@ +# Quantum Reinforcement Learning for Join Ordering + +This repository provides the implementation and artifacts accompanying the following article: +``` +@inproceedings{franz:24:qce24, + title = {Hype or Heuristic? Quantum Reinforcement Learning for Join Order Optimisation}, + author = {Maja Franz and Tobias Winker and Sven Groppe and Wolfgang Mauerer}, + booktitle = {IEEE International Conference on Quantum Computing and Engineering (QCE)}, + year = {2024}, + month = {09}, + userd = {IEEE QCE '24}, +} +``` +A preprint is available on [arXiv](https://arxiv.org/abs/2405.07770). + +## Content of this Repository + +- [`experimental_analysis/`](experimental_analysis/): +This directory contains all necessary scripts to run a training and evaluation of the classical and multi-step QRL approaches presented in the publication. +For running experiments with the single-step QML approach, we refer to the [source code](https://github.com/TobiasWinker/QC4DB_QO) accompanying the [related publication](https://doi.org/10.1145/3579142.3594299). +All result sets from the paper are stored as CSV files in [`experimental_analysis/logs/paper_results`](experimental_analysis/logs/paper_results). +The tikz plots from the paper can be reproduced with the script [`scripts/generate_plots.sh`](scripts/generate_plots.sh). + +- [`info/`](info/): +This directory contains supplementary material on the classical baseline replication and on specific hyperparameters. + +- [`paper/`](paper/): +This directory contains the article in PDF and its source code in LaTeX. + +- [`plots/`](plots/): +This directory contains the plots from the paper and the source code to generate them in R. + +- [`scalability/`](scalability/): +In this directory the CSV files, which are used to generate the scalability Figs. 9 and 10, are stored, together with the python scripts, which were used to generate those. + +- [`scripts/`](scripts/): +This directory contains bash scripts, which can either be used as endpoints for the Docker-image, or executed locally. +Furthermore the setup scripts for PostgreSQL-V16 and the JOB can be found there. + + +## Setup + +### Docker + +#### Get docker image +Build image: + +```docker build -t qce24_repro .``` + +or pull image: + +```docker pull ghcr.io/lfd/rl_for_jo/qce24_repro:latest``` + +The image does contain an instance of PostgreSQL-V16. +However the dataset for the Join order benchmark is only installed, once a container is run with the corresponding options for the endpoint. + +#### Create Container + +```docker run --name qce24_repro -it qce24_repro [<-flags>] [