Skip to content

Commit 8b80d2c

Browse files
neiljdoDimitri Kartsaklis
and
Dimitri Kartsaklis
committed
Release version 0.4.3
Co-authored-by: Dimitri Kartsaklis <dimitri.kartsaklis@quantinuum.com>
1 parent e012aa9 commit 8b80d2c

File tree

110 files changed

+24
-15514
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+24
-15514
lines changed

.github/workflows/build-docs

-5
This file was deleted.

.github/workflows/build_test.yml

-17
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ on:
1212
env:
1313
SRC_DIR: lambeq
1414
TEST_DIR: tests
15-
DOCS_DIR: docs
1615

1716
jobs:
1817
lint:
@@ -82,22 +81,6 @@ jobs:
8281
--doctest-modules
8382
--durations=50
8483
--ignore=${{ env.TEST_DIR }}/text2diagram/test_depccg_parser.py
85-
--ignore=${{ env.DOCS_DIR }}/extract_code_cells.py
86-
- name: Preparation for notebook testing
87-
run: pip install nbmake
88-
- name: Test example notebooks
89-
env:
90-
TEST_NOTEBOOKS: 1
91-
run: >
92-
pytest --nbmake ${{ env.DOCS_DIR }}/examples/
93-
--nbmake-timeout=60
94-
- name: Test tutorial notebooks
95-
env:
96-
TEST_NOTEBOOKS: 1
97-
run: >
98-
pytest --nbmake ${{ env.DOCS_DIR }}/tutorials/
99-
--nbmake-timeout=60
100-
--ignore ${{ env.DOCS_DIR }}/tutorials/code
10184
- name: Coverage report
10285
run: coverage report -m
10386
type_check:

.github/workflows/clear-target-files

-3
This file was deleted.

.github/workflows/docs.yml

-66
This file was deleted.

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ htmlcov/
1313
# ignore the built documentation
1414
docs/_*
1515
!docs/_static/
16+
!docs/_templates/
1617
docs/puml/img
1718

1819
# ignore runs and related artifacts

.gitmodules

-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +0,0 @@
1-
[submodule "docs/quantinuum-sphinx"]
2-
path = docs/quantinuum-sphinx
3-
url = https://github.com/CQCL/quantinuum-sphinx.git
4-
branch = dist

README.md

+10-28
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# lambeq
22

3-
[![lambeq logo](https://cqcl.github.io/lambeq/_static/lambeq_logo.png)](//cqcl.github.io/lambeq)
3+
[![lambeq logo](https://cqcl.github.io/lambeq-docs/_static/lambeq_logo.png)](//cqcl.github.io/lambeq-docs)
44

55
![Build status](https://github.com/CQCL/lambeq/actions/workflows/build_test.yml/badge.svg)
66
[![License](https://img.shields.io/github/license/CQCL/lambeq)](LICENSE)
@@ -12,16 +12,11 @@
1212

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

15-
- Documentation: https://cqcl.github.io/lambeq/
15+
- Documentation: https://cqcl.github.io/lambeq-docs/
1616
- User support: <lambeq-support@cambridgequantum.com>
17-
- Contributions: Please read [our guide](https://cqcl.github.io/lambeq/CONTRIBUTING.html).
17+
- Contributions: Please read [our guide](https://cqcl.github.io/lambeq-docs/CONTRIBUTING.html).
1818
- If you want to subscribe to lambeq's mailing list, let us know by sending an email to <lambeq-support@cambridgequantum.com>.
1919

20-
---
21-
**Note:** Please do not try to read the documentation directly from the preview provided in the [repository](https://github.com/CQCL/lambeq/tree/main/docs), since some of the pages will not be rendered properly.
22-
23-
---
24-
2520
## Getting started
2621

2722
### Prerequisites
@@ -31,13 +26,15 @@ lambeq is a toolkit for quantum natural language processing (QNLP).
3126
### Installation
3227

3328
lambeq can be installed with the command:
29+
3430
```bash
3531
pip install lambeq
3632
```
3733

3834
The 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.
3935

4036
To install lambeq with optional dependencies for extra features, run:
37+
4138
```bash
4239
pip install lambeq[extras]
4340
```
@@ -57,12 +54,11 @@ python contrib/download_depccg_model.py
5754

5855
## Usage
5956

60-
The [docs/examples](//github.com/CQCL/lambeq/tree/main/docs/examples)
61-
directory contains notebooks demonstrating usage of the various tools in
62-
lambeq.
57+
The [docs/examples](//github.com/CQCL/lambeq-docs/tree/main/docs/examples)
58+
directory in lambeq's [documentation repository](https://github.com/CQCL/lambeq-docs) contains notebooks demonstrating usage of the various tools in lambeq.
6359

6460
Example - parsing a sentence into a diagram (see
65-
[docs/examples/ccg2discocat.ipynb](//github.com/CQCL/lambeq/blob/main/docs/examples/ccg2discocat.ipynb)):
61+
[docs/examples/parser.ipynb](//github.com/CQCL/lambeq-docs/blob/main/docs/examples/parser.ipynb)):
6662

6763
```python
6864
from lambeq import BobcatParser
@@ -75,28 +71,14 @@ diagram.draw()
7571
## Testing
7672

7773
Run all tests with the command:
74+
7875
```bash
7976
pytest
8077
```
8178

82-
Note: if you have installed in a virtual environment, remember to
79+
Note: if you have installed lambeq in a virtual environment, remember to
8380
install pytest in the same environment using pip.
8481

85-
## Building documentation
86-
87-
To build the documentation, first install the required dependencies:
88-
```bash
89-
pip install -r docs/requirements.txt
90-
```
91-
then run the commands:
92-
93-
```bash
94-
cd docs
95-
make clean
96-
make html
97-
```
98-
the docs will be under `docs/_build`.
99-
10082
## License
10183

10284
Distributed under the Apache 2.0 license. See [`LICENSE`](LICENSE) for

docs/CONTRIBUTING.rst

-66
This file was deleted.

docs/Makefile

-27
This file was deleted.

docs/_static/css/table-wrap.css

-8
This file was deleted.

docs/_static/images/CQ-logo.png

-14.4 KB
Binary file not shown.
-17.8 KB
Binary file not shown.

docs/_static/images/ccg-diagram.png

-45.4 KB
Binary file not shown.

docs/_static/images/ccgbank.png

-143 KB
Binary file not shown.

docs/_static/images/comm-diagram.png

-34.7 KB
Binary file not shown.

docs/_static/images/favicon.ico

-456 Bytes
Binary file not shown.

docs/_static/images/lambeq_logo.png

-3.37 KB
Binary file not shown.

docs/_static/images/linear.png

-121 KB
Binary file not shown.

docs/_static/images/pipeline.png

-73.7 KB
Binary file not shown.

docs/_static/images/pregroups.png

-45.7 KB
Binary file not shown.

docs/_static/images/snake-2.png

-4.06 KB
Binary file not shown.

docs/_static/images/snake.png

-3.29 KB
Binary file not shown.
-56.7 KB
Binary file not shown.
Binary file not shown.

docs/_static/images/use_cases.png

-79.7 KB
Binary file not shown.

docs/_static/nav-config.js

-27
This file was deleted.

docs/advanced.rst

-13
This file was deleted.

0 commit comments

Comments
 (0)