lambeq
About
lambeq is a toolkit for quantum natural language processing (QNLP).
Documentation: https://cqcl.github.io/lambeq/
Getting started
Prerequisites
- Python 3.7+
Installation
Direct pip install
The base lambeq can be installed with the command:
pip install lambeq
This does not include optional dependencies such as depccg and PyTorch, which have to be installed separately. In particular, depccg is required for lambeq.ccg2discocat.DepCCGParser.
To install lambeq with depccg, run instead:
pip install cython numpy
pip install 'lambeq[depccg]'
depccg_en download
See below for further options.
Automatic installation (recommended)
This runs an interactive installer to help pick the installation destination and configuration.
- Run:
sh <(curl 'https://cqcl.github.io/lambeq/install.sh')
Git installation
This requires Git to be installed.
-
Download this repository:
git clone https://github.com/CQCL/lambeq
-
Enter the repository:
cd lambeq -
Make sure
pipis up-to-date:pip install --upgrade pip wheel
-
(Optional) If installing the optional dependency
depccg, the following packages must be installed before installingdepccg:pip install cython numpy
Further information can be found on the depccg homepage.
-
Install lambeq from the local repository using pip:
pip install --use-feature=in-tree-build .To include depccg, run instead:
pip install --use-feature=in-tree-build .[depccg]
To include all optional dependencies, run instead:
pip install --use-feature=in-tree-build .[all]
-
If using a pretrained depccg parser, download a pretrained model:
depccg_en download
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/ccg2discocat.ipynb):
from lambeq.ccg2discocat import DepCCGParser
depccg_parser = DepCCGParser()
diagram = depccg_parser.sentence2diagram('This is a test sentence')
diagram.draw()
Note: all pre-trained depccg models apart from the basic one are broken, and depccg has not yet been updated to fix this. Therefore, it is recommended to just use the basic parser, as shown here.
Testing
Run all tests with the command:
pytest
Note: if you have installed in a virtual environment, remember to install pytest in the same environment using pip.
Building Documentation
To build the documentation, first install the required dependencies:
pip install -r docs/requirements.txt
then run the commands:
cd docs
make clean
make html
the docs will be under docs/_build.
To rebuild the rst files themselves, run:
sphinx-apidoc --force -o docs lambeq
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},
}
189 Dec 25, 2022
37 Dec 13, 2022
192 Dec 20, 2022
56 Jan 02, 2023
15 Nov 26, 2022
585 Dec 31, 2022
2 Jan 30, 2022
8.5k Jan 02, 2023
2 Jan 09, 2022
62 Dec 21, 2022
11 Dec 13, 2022
12 Oct 07, 2022
314 Dec 28, 2022
158 Dec 21, 2022
5.6k Jan 09, 2023
9 Mar 30, 2022
96 Dec 26, 2022
40 Dec 09, 2022
247 Dec 25, 2022
3 Oct 07, 2022