diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index be69b1b..1f22c7c 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -4,6 +4,7 @@ on: push: branches: - docs_public + - main permissions: contents: read diff --git a/docs/source/api.rst b/docs/source/api.rst index 4414796..144b973 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -1,5 +1,5 @@ -API Reference -============= +Transpilation Functions +======================= .. automodule:: rivet_transpiler.transpiler - :members: transpile, transpile_chain, transpile_right, transpile_left, get_full_map + :members: diff --git a/docs/source/conf.py b/docs/source/conf.py index 5de06e7..f60179b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -16,7 +16,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "QML Compiler" +project = "Rivet Transpiler" copyright = "2024, Haiqu Inc." # pylint: disable=redefined-builtin author = "Haiqu Inc." diff --git a/docs/source/index.rst b/docs/source/index.rst index 9add6e1..b981e3f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -117,6 +117,6 @@ Haiqu, info@haiqu.ai, +1 650 788 6011 .. toctree:: :maxdepth: 1 :hidden: - :caption: API Reference + :caption: Transpilation Functions api diff --git a/examples/fourier_adder/fourier_adder.ipynb b/examples/fourier_adder/fourier_adder.ipynb index 77349d2..a851d05 100644 --- a/examples/fourier_adder/fourier_adder.ipynb +++ b/examples/fourier_adder/fourier_adder.ipynb @@ -821,7 +821,7 @@ "\n", "
\n", " \n", - " \n", + " \n", " \n", "
" ] @@ -840,30 +840,6 @@ "\n", "![image.png](attachment:abb1fa17-882e-4d05-ac3e-fa7fafd43aee.png)" ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "7fc32194-9082-46a4-81c6-5cd68efe720e", - "metadata": {}, - "outputs": [], - "source": [] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "cbde53f9-514e-4068-94c4-a796f717d067", - "metadata": {}, - "outputs": [], - "source": [] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "4b7e8450-80ab-4d6d-854d-4a6a441c1400", - "metadata": {}, - "outputs": [], - "source": [] } ], "metadata": { diff --git a/examples/fourier_adder/fourier_adder.png b/examples/fourier_adder/fourier_adder.png new file mode 100644 index 0000000..f2bade7 Binary files /dev/null and b/examples/fourier_adder/fourier_adder.png differ diff --git a/rivet_transpiler/transpiler.py b/rivet_transpiler/transpiler.py index 9921d17..7f5af76 100644 --- a/rivet_transpiler/transpiler.py +++ b/rivet_transpiler/transpiler.py @@ -1,26 +1,5 @@ """ Rivet Transpiler functions. - -`transpile` - transpilation function featuring: - - different transpilation stacks: - * Qiskit - * BQSKit - * Pytket - - custom PassManager - - dynamical decoupling - - transpiler options - -`transpile_chain` consistently transpile and "stitch" a chain of -quantum circuits. - -`transpile_right` - transpile an additional circuit to the right part of -the existing circuit. - -`transpile_left` - transpile an additional circuit to the left part of -the existing circuit. - -`transpile_and_compress` - transpile and topologically compress a circuit -considering a coupling map of the selected backend. """ import qiskit