λambeq documentation

About this repository

This repository holds the documentation of the lambeq Python library.

About lambeq

lambeq is a toolkit for quantum natural language processing (QNLP).

• Documentation: https://docs.quantinuum.com/lambeq/
• User support: lambeq-support@quantinuum.com
• Contributions: Please read our guide.
• If you want to subscribe to lambeq's mailing list, let us know by sending an email to lambeq-support@quantinuum.com.

Getting started with lambeq

Prerequisites

• Python 3.10+

Installation

lambeq can be installed with the command:

bash pip install lambeq

The default installation of lambeq includes Bobcat parser, a state-of-the-art statistical parser (see related paper) fully integrated with the toolkit.

To install lambeq with optional dependencies for extra features, run:

bash pip install lambeq[extras]

To enable DepCCG support, you will need to install the external parser separately.

Note: The DepCCG-related functionality is no longer actively supported in lambeq, and may not work as expected. We strongly recommend using the default Bobcat parser which comes as part of lambeq.

If you still want to use DepCCG, for example because you plan to apply lambeq on Japanese, you can install DepCCG separately following the instructions on the DepCCG homepage. After installing DepCCG, you can download its model by using the script provided in the contrib folder of this repository:

bash python contrib/download_depccg_model.py

Usage

The docs/examples directory contains notebooks demonstrating usage of the various tools in lambeq.

Example - parsing a sentence into a diagram (see docs/examples/parser.ipynb):

```python from lambeq import BobcatParser

parser = BobcatParser() diagram = parser.sentence2diagram('This is a test sentence') diagram.draw() ```

Testing lambeq

Run all tests with the command:

bash pytest

Note: if you have installed lambeq in a virtual environment, remember to install pytest in the same environment using pip.

Building documentation

To build the documentation, first clone locally this repository and install the required dependencies:

bash pip install -r requirements.txt

then run the command:

bash ./build-docs.sh

The docs will be under the build directory just under the repository root. To serve it locally:

bash cd build python -m http.server

and then go to http://localhost:8000 to load the index page.

License

Distributed under the Apache 2.0 license. See LICENSE for more details.

Citation

If you wish to attribute our work, please cite the accompanying paper:

@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}, }