{"id":22882521,"url":"https://github.com/cqcl/lambeq-docs","last_synced_at":"2025-11-08T14:03:21.690Z","repository":{"id":255334016,"uuid":"848726253","full_name":"CQCL/lambeq-docs","owner":"CQCL","description":"User manual and example notebooks for the lambeq QNLP library","archived":false,"fork":false,"pushed_at":"2025-03-20T11:21:56.000Z","size":4513,"stargazers_count":3,"open_issues_count":6,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T04:48:27.635Z","etag":null,"topics":["python","qnlp"],"latest_commit_sha":null,"homepage":"https://docs.quantinuum.com/lambeq/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CQCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-28T09:43:20.000Z","updated_at":"2025-04-22T06:50:59.000Z","dependencies_parsed_at":"2024-09-11T16:37:49.771Z","dependency_job_id":"6af72878-3b48-4032-8099-1a9daf5d0900","html_url":"https://github.com/CQCL/lambeq-docs","commit_stats":null,"previous_names":["cqcl/lambeq-docs"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Flambeq-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Flambeq-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Flambeq-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Flambeq-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/lambeq-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816522,"owners_count":21808702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","qnlp"],"created_at":"2024-12-13T18:18:06.788Z","updated_at":"2025-11-08T14:03:21.618Z","avatar_url":"https://github.com/CQCL.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# λambeq documentation\n\n![Build status](https://github.com/CQCL/lambeq-docs/actions/workflows/docs.yml/badge.svg)\n[![License](https://img.shields.io/github/license/CQCL/lambeq-docs)](LICENSE)\n[![PyPI version](https://img.shields.io/pypi/v/lambeq)](//pypi.org/project/lambeq)\n[![PyPI downloads](https://img.shields.io/pypi/dm/lambeq)](//pypi.org/project/lambeq)\n[![arXiv](https://img.shields.io/badge/arXiv-2110.04236-green)](//arxiv.org/abs/2110.04236)\n\n## About this repository\n\nThis repository holds the documentation of the [lambeq Python library](https://github.com/CQCL/lambeq).\n\n## About lambeq\n\nlambeq is a toolkit for quantum natural language processing (QNLP).\n\n- Documentation: https://docs.quantinuum.com/lambeq/\n- User support: \u003clambeq-support@quantinuum.com\u003e\n- Contributions: Please read [our guide](https://docs.quantinuum.com/lambeq/CONTRIBUTING.html).\n- If you want to subscribe to lambeq's mailing list, let us know by sending an email to \u003clambeq-support@quantinuum.com\u003e.\n\n## Getting started with lambeq\n\n### Prerequisites\n\n- Python 3.10+\n\n### Installation\n\nlambeq can be installed with the command:\n\n```bash\npip install lambeq\n```\n\nThe default installation of lambeq includes Bobcat parser, a state-of-the-art statistical parser (see [related paper](https://arxiv.org/abs/2109.10044)) fully integrated with the toolkit.\n\nTo install lambeq with optional dependencies for extra features, run:\n\n```bash\npip install lambeq[extras]\n```\n\nTo enable DepCCG support, you will need to install the external parser separately.\n\n---\n**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`.\n\n---\n\nIf 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](//github.com/masashi-y/depccg). After installing DepCCG, you can download its model by using the script provided in the `contrib` folder of this repository:\n\n```bash\npython contrib/download_depccg_model.py\n```\n\n## Usage\n\nThe [docs/examples](//github.com/CQCL/lambeq-docs/tree/main/docs/examples)\ndirectory contains notebooks demonstrating usage of the various tools in\nlambeq.\n\nExample - parsing a sentence into a diagram (see\n[docs/examples/parser.ipynb](//github.com/CQCL/lambeq-docs/blob/main/docs/examples/parser.ipynb)):\n\n```python\nfrom lambeq import BobcatParser\n\nparser = BobcatParser()\ndiagram = parser.sentence2diagram('This is a test sentence')\ndiagram.draw()\n```\n\n## Testing lambeq\n\nRun all tests with the command:\n\n```bash\npytest\n```\n\nNote: if you have installed lambeq in a virtual environment, remember to\ninstall pytest in the same environment using pip.\n\n## Building documentation\n\nTo build the documentation, first clone locally this repository and install the required dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\nthen run the command:\n\n```bash\n./build-docs.sh\n```\n\nThe docs will be under the `build` directory just under the repository root. To serve it locally:\n\n```bash\ncd build\npython -m http.server\n```\n\nand then go to `http://localhost:8000` to load the index page.\n\n## License\n\nDistributed under the Apache 2.0 license. See [`LICENSE`](LICENSE) for\nmore details.\n\n## Citation\n\nIf you wish to attribute our work, please cite\n[the accompanying paper](//arxiv.org/abs/2110.04236):\n\n```\n@article{kartsaklis2021lambeq,\n   title={lambeq: {A}n {E}fficient {H}igh-{L}evel {P}ython {L}ibrary for {Q}uantum {NLP}},\n   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},\n   year={2021},\n   journal={arXiv preprint arXiv:2110.04236},\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Flambeq-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Flambeq-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Flambeq-docs/lists"}