Frequently asked questions

Citing spacy-wrap

If you wish this library in your research, please cite it using (Changing the version if relevant):

@software{Enevoldsen_spaCy-wrap_For_Wrapping_2022,
   author = {Enevoldsen, Kenneth},
   doi = {10.5281/zenodo.6675315},
   month = {8},
   title = {{spaCy-wrap: For Wrapping fine-tuned transformers in spaCy pipelines}},
   url = {https://github.com/KennethEnevoldsen/spacy-wrap},
   version = {1.0.2},
   year = {2022}
}

Or if you prefer APA:

Enevoldsen, K. (2022). spaCy-wrap: For Wrapping fine-tuned transformers in spaCy pipelines (Version 1.0.2) [Computer software]. https://doi.org/10.5281/zenodo.6675315

How do I test the code and run the test suite?

This package comes with an extensive test suite. In order to run the tests, you’ll usually want to clone the repository and build the package from the source. This will also install the required development dependencies and test utilities defined in the extras_require section of the pyproject.toml.

pip install -e ".[tests]"

python -m pytest

which will run all the test in the tests folder.

Specific tests can be run using:

python -m pytest tests/desired_test.py

If you want to check code coverage you can run the following:

python -m pytest --cov=.

Does this package run on X?

This package is intended to run on all major OS, this includes Windows (latest version), MacOS (latest) and the latest version of Linux (Ubuntu). Similarly it also tested on python 3.8, and 3.9. Please note these are only the systems this package is being actively tested on, if you run on a similar system (e.g. an earlier version of Linux) this package will likely run there as well, if not please create an issue.

How is the documentation generated?

SpaCy-wrap uses sphinx to generate documentation. It uses the Furo theme with custom styling.

To make the documentation you can run:

# install sphinx, themes and extensions
pip install -e ".[docs]"

# generate html from documentations

make -C docs html