Skip to content

Commit

Permalink
ERRANT v2.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Bryant committed Feb 12, 2021
1 parent 2a08f30 commit 6c0d521
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Expand Up @@ -2,6 +2,10 @@

This log describes all the changes made to ERRANT since its release.

## v2.2.3 (12-02-21)

1. Changed the dependency version requirements in `setup.py` since ERRANT v2.2.x is not compatible with spaCy 3.

## v2.2.2 (14-08-20)

1. Added a copy of the NLTK Lancaster stemmer to `errant.en.lancaster` and removed the NLTK dependency. It was overkill to require the entire NLTK package just for this stemmer so we now bundle it with ERRANT.
Expand Down
7 changes: 4 additions & 3 deletions README.md
@@ -1,4 +1,4 @@
# ERRANT v2.2.2
# ERRANT v2.2.3

This repository contains the grammatical ERRor ANnotation Toolkit (ERRANT) described in:

Expand Down Expand Up @@ -34,14 +34,15 @@ The easiest way to install ERRANT and its dependencies is using `pip`. We also r
```
python3 -m venv errant_env
source errant_env/bin/activate
pip3 install -U pip setuptools wheel
pip3 install errant
python3 -m spacy download en
```
This will create and activate a new python3 environment called `errant_env` in the current directory. `pip` will then install ERRANT, [spaCy](https://spacy.io/), [python-Levenshtein](https://pypi.org/project/python-Levenshtein/) and spaCy's default English model in this environment. You can deactivate the environment at any time by running `deactivate`, but must remember to activate it again whenever you want to use ERRANT.
This will create and activate a new python3 environment called `errant_env` in the current directory. `pip` will then update some setup tools and install ERRANT, [spaCy](https://spacy.io/), [python-Levenshtein](https://pypi.org/project/python-Levenshtein/) and spaCy's default English model in this environment. You can deactivate the environment at any time by running `deactivate`, but must remember to activate it again whenever you want to use ERRANT.

#### ERRANT and spaCy 2

ERRANT was originally designed to work with spaCy v1.9.0 and works best with this version. SpaCy v1.9.0 does not work with Python >= 3.7 however, and so we were forced to update ERRANT to be compatible with spaCy 2. Since spaCy 2 uses a neural system to trade speed for accuracy (see the [official spaCy benchmarks](https://spacy.io/usage/facts-figures#spacy-models)), this means ERRANT v2.2.0 is **over 4x slower** than ERRANT v2.1.0.
ERRANT was originally designed to work with spaCy v1.9.0 and works best with this version. SpaCy v1.9.0 does not work with Python >= 3.7 however, and so we were forced to update ERRANT to be compatible with spaCy 2. Since spaCy 2 uses a neural system to trade speed for accuracy, this means ERRANT v2.2.0 is **~4x slower** than ERRANT v2.1.0.

There is no way around this if you use Python >= 3.7, but *we recommend installing ERRANT v2.1.0 if you use Python < 3.7*.
```
Expand Down
2 changes: 1 addition & 1 deletion errant/__init__.py
Expand Up @@ -3,7 +3,7 @@
from errant.annotator import Annotator

# ERRANT version
__version__ = '2.2.2'
__version__ = '2.2.3'

# Load an ERRANT Annotator object for a given language
def load(lang, nlp=None):
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Expand Up @@ -10,7 +10,7 @@

setup(
name = "errant",
version = "2.2.2",
version = "2.2.3",
license = "MIT",
description = "The ERRor ANnotation Toolkit (ERRANT). Automatically extract and classify edits in parallel sentences.",
long_description = readme,
Expand All @@ -20,7 +20,7 @@
url = "https://github.com/chrisjbryant/errant",
keywords = ["automatic annotation", "grammatical errors", "natural language processing"],
python_requires = ">= 3.3",
install_requires = ["spacy>=2.2.0", "python-Levenshtein==0.12.0"],
install_requires = ["spacy>=2.2.0,<3", "python-Levenshtein>=0.12.0"],
packages = find_packages(),
include_package_data=True,
entry_points = {
Expand Down

0 comments on commit 6c0d521

Please sign in to comment.