Installation

Package installation

To install the current release of the package, you can use pip

python -m pip install elfen

Alternatively, you can install the package from source:

python -m pip install git+https://github.com/mmmaurer/elfen.git

To install an editable version of the package, you can use the following command:

python -m pip install -e git+https://github.com/mmmaurer/elfen.git

All of these options will install the package and all its dependencies.

Additional resources and models

To use the package, you will need to install additional resources.

Backbone models

Since the NLP backbones are built on top of spaCy and stanza, you will need to install the respective models for the languages you want to use. You can find the installation instructions for spacy here and for stanza here.

For the default small English spacy model, you can install it using the following command:

python -m spacy download en_core_web_sm

Third-party resources

If you want to use the wordnet-based semantic features, you will need to download the respective open multilingual wordnet database. Consult the wn package documentation for more information.

To install the open multilingual wordnet database, you can use the following command:

python -m wn download omw:1.4

Note that for some languages, you will need to install another wordnet collection. For example, for German, you can use the following command:

python -m wn download odenet:1.4

For more information on the available wordnet collections, consult the wn package documentation.

The NRC emotion and sentiment lexicons need to be downloaded manually due to licensing restrictions. Without these lexicons, only a subset of features will be available. Please see this guide to download and install them: https://github.com/mmmaurer/elfen/blob/main/download_nrc.md

Default norms and lexicons

The package uses some established norms and lexicons for some features (psycholinguistic norms, etc.). These will be downloaded automatically when you first use the respective features via the extractor functionality [1] . Please note that the usage of these norms and lexicons is subject to their respective licenses.

Important

We only provide download functionality, and the user is responsible for complying with the respective licenses.

[1]

For more information on the extractor functionality, see the elfen.extractor module documentation or the Quickstart and Tutorials sections.

NRC emotion and sentiment lexicons

The NRC emotion and sentiment lexicons need to be downloaded manually due to licensing restrictions. Without these lexicons, only a subset of features will be available. Please see this guide to download and install them: https://github.com/mmmaurer/elfen/blob/main/download_nrc.md