Lambeq

Added:
- Support for using `jax` as backend of `tensornetwork` when setting `use_jit=True` in the `NumpyModel`. The interface is not affected by this change, but performance of the model is significantly improved.

Fixed:
- Fix a bug that caused the `BobcatParser` and the `WebParser` to trigger an SSL certificate error using Windows.
- Fix false positives in assigning conjunction rule using the `CCGBankParser`. The rule `, + X[conj] -> X[conj]` is a case of removing left punctuation, but was being assigned conjunction erroneously.

Added:
- `CCGRule`: Add `symbol` method that returns the ASCII symbol of a given CCG rule.
- `CCGTree`: Extend `deriv` method with CCG output. It is now capable of returning standard CCG diagrams.
- Command-line interface: CCG mode. When enabled, the output will be a string representation of the CCG diagram corresponding to the `CCGTree` object produced by the parser, instead of DisCoPy diagram or circuit.
- Documentation: Add a troubleshooting page.

Change:
- Change the behaviour of `spiders_reader` such that the spiders decompose logarithmically. This change also affects other rewrite rules that use spiders, such as coordination and relative pronouns.
- Rename `AtomicType.PREPOSITION` to `AtomicType.PREPOSITIONAL_PHRASE`.

Fixed:
- Fix a bug that raised a `dtype` error when using the `TketModel` on Windows.
- Fix a bug that caused the normalisation of scalar outputs of circuits without open wires using a `QuantumModel`.

Added:
- Add support for Python 3.10.
- Unify class hierarchies for parsers and readers: `CCGParser` is now a subclass of `Reader` and placed in the common package `text2diagram`. The old packages `reader` and `ccg2discocat` are no longer available. Compatibility problems with previous versions should be minimal, since from Release 0.2.0 and onwards all `lambeq` classes can be imported from the global namespace.
- Add `CurryRewriteRule`, which uses map-state duality in order to remove adjoint types from the boxes of a diagram. When used in conjunction with `discopy.rigid.Diagram.normal_form()`, this removes cups from the diagram, eliminating post-selection.
- The `Bobcat` parser now updates automatically when new versions are made available online.
- Allow customising available root categories for the parser when using the command-line interface.

Fixed:
- Update grammar file of `Bobcat` parser to avoid problems with conflicting unary rules.

Added:
- A new `Checkpoint` class that implements pickling and file operations from `Trainer` and `Model`.

Changed:
- Improvements to the `training` module, allowing multiple diagrams to be accepted as input to the `SPSAOptimizer`.
- Updated documentation, including sub-package structures and class diagrams.

**Added:**
- A new state-of-the-art CCG parser, fully integrated with `lambeq`, which replaces depccg as the default parser of the toolkit. The new `Bobcat` parser has better performance, simplifies installation, and provides compatibility with Windows (which was not supported due to a depccg conflict). depccg is still supported as an alternative external dependency.
- A `training` package, providing a selection of trainers, models, and optimizers that greatly simplify supervised training for most of `lambeq`'s use cases, classical and quantum. The new package adds several new features to `lambeq`, such as the ability to save to and restore models from checkpoints.
- Furthermore, the `training` package uses `DisCoPy`'s tensor network capability to contract tensor diagrams efficiently. In particular, `DisCoPy` 0.4.1's new unitary and density matrix simulators in result in substantially faster training speeds compared to the previous version.
- A command-line interface, which provides most of `lambeq`'s functionality from the command line. For example, `lambeq` can now be used as a standard command-line pregroup parser.
- A web parser class that can send parsing queries to an online API, so that local installation of a parser is not strictly necessary anymore. The web parser is particularly helpful for testing purposes, interactive usage or when a local parser is unavailable, but should not be used for serious experiments.
- A new `lambeq.pregroups` package that provides methods for easy creation of pregroup diagrams, removal of cups, and printing of diagrams in text form (i.e. in a terminal).
- A new `TreeReader` class that exploits the biclosed structure of CCG grammatical derivations.
- Three new rewrite rules for relative pronouns and coordination.
- Tokenisation features have been added in all parsers and readers.
- Additional generator methods and minor improvements for the `CCGBankParser` class.

**Changed:**
- Improved and more detailed package structure.
- Most classes and functions can now be imported from `lambeq` directly, instead of having to import from the sub-packages.
- The `circuit` and `tensor` modules have been combined into an `lambeq.ansatz` package. (However, as mentioned above, the classes and functions they define can now be imported directly from `lambeq` and should continue to do so in future releases.)
- Improved documentation and additional tutorials.

Minor changes:
- Add URLs to setup file

Fixes:
- Fix logo link in README
- Fix missing version when building docs in GitHub action
- Fix typo to description keyword in setup file