What is lambeq?
===============

``lambeq`` :cite:p:`kartsaklis_2021` is an open-source, modular, extensible high-level Python library for experimental :term:`Quantum Natural Language Processing <quantum NLP (QNLP)>` (QNLP), created by `Quantinuum <https://www.quantinuum.com>`_'s QNLP team. At a high level, the library allows the conversion of any text or sentence to a :term:`quantum circuit`, based on a given :term:`compositional model` and certain parameterisation and choices of :term:`ansätze <ansatz (plural: ansätze)>`, while it also facilitates :ref:`training <sec-training>` for both quantum and classical NLP experiments. The notes for the latest release can be found :ref:`here <sec-release-notes>`.

``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. Some other useful starting points are listed below.

- For a more complete introduction to ``lambeq`` and what you can do with it, please see :ref:`sec-lambeq_comp`.
- To read more about lambeq's pipeline, go to :ref:`sec-pipeline`.
- To start the tutorials, go to :ref:`sec-sent_input`. 
- To learn more about NLP and QNLP, read our :ref:`sec-nlp101` guide.
- To study 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`.

.. rubric:: See also:

- :ref:`How to cite <sec-cite>`
- :ref:`Licence <sec-licence>`