diff --git a/docs/_static/images/lambeq_cover.png b/docs/_static/images/lambeq_cover.png new file mode 100644 index 0000000..d1b3486 Binary files /dev/null and b/docs/_static/images/lambeq_cover.png differ diff --git a/docs/_static/images/lambeq_logo.png b/docs/_static/images/lambeq_logo.png index c730606..b0a305c 100644 Binary files a/docs/_static/images/lambeq_logo.png and b/docs/_static/images/lambeq_logo.png differ diff --git a/docs/_static/nav-config.js b/docs/_static/nav-config.js index 1bcfece..0528340 100644 --- a/docs/_static/nav-config.js +++ b/docs/_static/nav-config.js @@ -3,11 +3,11 @@ const navConfig = { { "title": "Getting started", - "href": "installation.html", + "href": "intro.html", }, { - "title": "NLP 101", - "href": "nlp-intro.html", + "title": "User guide", + "href": "pipeline.html", }, { "title": "Tutorials", diff --git a/docs/_templates/lambeq_landing_page.html b/docs/_templates/lambeq_landing_page.html new file mode 100644 index 0000000..31a2a74 --- /dev/null +++ b/docs/_templates/lambeq_landing_page.html @@ -0,0 +1,275 @@ + + + + + lambeq + + + + + + + + + + + + + + +
+ +
+
+
+
+
+
+
+
+

Natural Language Processing on Quantum Computers

+
+
+ + + +
Github
+ + + + +
Join us on Discord
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

Getting Started

+
+
+
+

Learn the basics of lambeq and compositional models of meaning.

+
+
+ +

lambeq pipeline

+

Understand how a sentence is converted into a quantum circuit.

+ +
+ +

lambeq use cases

+

Read about the various use cases on which lambeq can help you advance your research.

+ +
+
+
+
+
+

Tutorials

+
+
+
+

Jump into hands-on tutorials to learn how to put lambeq to work.

+
+
+ +

Convert sentences into circuits

+

Get familiar with lambeq's stages such as diagram creation, rewriting and parameterisation.

+ +
+ +

Training models

+

Learn how to use the provided state-of-the-art trainers to train your models for language processing tasks.

+ +
+
+
+
+
+

Advanced

+
+
+
+

Take a look at lambeq's internals and start mastering low-level aspects of the toolkit.

+
+
+ +

Low-level lambeq

+

Delve into the mathematics and see how string diagrams fit to monoidal categories theory.

+ +
+ +

Extending lambeq

+

Learn how to take advantage of the extensible nature of lambeq and how to add new features tailored to you work.

+ +
+
+
+
+
+
+
+ +
+
+
+
+
+ +
+
+
Get in touch for support
+

Need help? Contact our support team here.

+
+ + +
+
+
Publications
+

Find our latest research publications here.

+
+ +
+
+
+
+
+ +
+ +
+ + + + \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index c90da4b..fe82b7a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -87,6 +87,10 @@ 'conf_py_path': '/docs/' } +html_additional_pages = { + "index": "lambeq_landing_page.html" +} + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/docs/index.rst b/docs/index.rst index 27ded0b..44aefcf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,59 +1,20 @@ -lambeq -====== - -.. image:: _static/images/Quantinuum_logo.png - :width: 240px - :align: right - -``lambeq`` is an open-source, modular, extensible high-level Python library for experimental :term:`Quantum Natural Language Processing ` (QNLP), created by `Quantinuum `_'s QNLP team. At a high level, the library allows the conversion of any sentence to a :term:`quantum circuit`, based on a given :term:`compositional model` and certain parameterisation and choices of :term:`ansätze `, and facilitates :ref:`training ` for both quantum and classical NLP experiments. The notes for the latest release can be found :ref:`here `. - -``lambeq`` is available for Python 3.10 and higher, on Linux, macOS and Windows. To install, type: - -.. code-block:: bash - - pip install lambeq - -or refer to :ref:`sec-installation` for more information. To start the tutorial, go to `Step 1: Sentence Input `_. To see the example notebooks, go to :ref:`sec-examples`. To use the command-line interface, read :ref:`sec-cli`. To make your own contributions to ``lambeq``, see :ref:`sec-contributing`. - -.. note:: - Please do not try to read this documentation directly from the preview provided in the `GitHub repository `_, since some of the pages will not be rendered properly. - -User support ------------- - -If you need help with ``lambeq`` or you think you have found a bug, please send an email to lambeq-support@cambridgequantum.com. You can also open an issue at ``lambeq``'s `GitHub repository `_. Someone from the development team will respond to you as soon as possible. Furthermore, if you want to subscribe to ``lambeq``'s mailing list (lambeq-users@cambridgequantum.com), send an email to lambeq-support@cambridgequantum.com to let us know. - -Note that the best way to get in touch with the QNLP community and learn about ``lambeq`` is to join our `QNLP discord server `_, where you can ask questions, get notified about important announcements and news, and chat with other QNLP researchers. - -Licence -------- - -Licensed under the `Apache 2.0 License `_. - -How to cite ------------ -If you use ``lambeq`` for your research, please cite the accompanying paper [Kea2021]_: - -.. code-block:: bash - - @article{kartsaklis2021lambeq, - title={lambeq: {A}n {E}fficient {H}igh-{L}evel {P}ython {L}ibrary for {Q}uantum {NLP}}, - author={Dimitri Kartsaklis and Ian Fan and Richie Yeung and Anna Pearson and Robin Lorenz and Alexis Toumi and Giovanni de Felice and Konstantinos Meichanetzidis and Stephen Clark and Bob Coecke}, - year={2021}, - journal={arXiv preprint arXiv:2110.04236}, - } - .. toctree:: :caption: Getting started :maxdepth: 1 + intro installation troubleshooting + CONTRIBUTING + +.. toctree:: + :caption: User guide + :maxdepth: 1 + pipeline - parsing string-diagrams + parsing use-cases - CONTRIBUTING .. toctree:: :caption: NLP-101 diff --git a/docs/use-cases.rst b/docs/use-cases.rst index b74f0a6..12ef021 100644 --- a/docs/use-cases.rst +++ b/docs/use-cases.rst @@ -156,11 +156,10 @@ As soon as you are satisfied with the results of the simulations, it's time for .. csv-table:: Quantum platforms. :header: "Platform", "Technology" :widths: 30, 60 - :align: center "`Alpine Quantum Technologies `_", "`Trapped ions `_" "`Amazon Braket `_", "`Annealing `_, trapped ions, `superconducting qubits `_, `photonics `_" - "`Atom Computing `_", "`Neutral atoms `_" in an "`optical lattice `_" + "`Atom Computing `_", "`Neutral atoms `_ in an `optical lattice `_" "`Google Quantum AI `_", "Superconducting qubits" "`IBM Quantum `_", "Superconducting qubits" "`IonQ Cloud access `_", "Trapped ions" @@ -170,7 +169,7 @@ As soon as you are satisfied with the results of the simulations, it's time for "`Quandela `_", "Photonics" "`Quantinuum `_", "Trapped ions" "`Quantware `_", "Superconducting qubits" - "`QuEra `_", Neutral atoms + "`QuEra `_", "Neutral atoms" "`Rigetti Quantum Cloud Services `_", "Superconducting qubits" .. rubric:: See also: