pie-documents

Annotation-, document- and metric implementations as well as utilities for Python-IE.

Available annotation types: see here.

Available document types: see here.

Available metrics:

• F1Metric
• ConfusionMatrix
• SpanLengthCollector
• RelationArgumentDistanceCollector
• SpanCoverageCollector
• SQuADF1

Document processing utilities:

• MultiSpanMerger
• SpansViaRelationMerger
• RegexPartitioner
• RelationArgumentSorter
• SentenceSplitter
• TextSpanTrimmer
• tokenization utils, e.g., text_based_document_to_token_based and token_based_document_to_text_based

Setup

pip install pie-documents

To install the latest version from GitHub:

pip install git+https://git@github.com/ArneBinder/pie-documents.git

Development

Setup

1. This project is build with Poetry. See here for installation instructions.
2. Get the code and switch into the project directory:

   git clone https://github.com/ArneBinder/pie-documents
   cd pie-documents
   

3. Create a virtual environment and install the dependencies (including development dependencies):

   poetry install --with dev
   

Finally, to run any of the below commands, you need to activate the virtual environment:

poetry shell

Note: You can also run commands in the virtual environment without activating it first: poetry run <command>.

Code Formatting, Linting and Static Type Checking

pre-commit run -a

Testing

run all tests with coverage:

pytest --cov --cov-report term-missing

Releasing

1. Create the release branch: git switch --create release main
2. Increase the version: poetry version <PATCH|MINOR|MAJOR>, e.g. poetry version patch for a patch release. If the release contains new features, or breaking changes, bump the minor version (this project has no main release yet). If the release contains only bugfixes, bump the patch version. See Semantic Versioning for more information.
3. Commit the changes: git commit --message="release <NEW VERSION>" pyproject.toml, e.g. git commit --message="release 0.13.0" pyproject.toml
4. Push the changes to GitHub: git push origin release
5. Create a PR for that release branch on GitHub.
6. Wait until checks passed successfully.
7. Merge the PR into the main branch. This triggers the GitHub Action that creates all relevant release artefacts and also uploads them to PyPI.
8. Cleanup: Delete the release branch. This is important, because otherwise the next release will fail.