sparv-sbx-emotions-kb-emoclass

Plugin to Sparv plugin to annotate sentences, paragraphs and texts with emotional classification.

Install

First, install Sparv as suggested,

with pipx:

pipx install sparv

or, with uv-pipx:

uvpipx install sparv

Then install sparv-sbx-emotions-kb-emoclass with,

if you used pipx above:

pipx inject sparv sparv-sbx-emotions-kb-emoclass

or, if you used uv-pipx above:

uvpipx install sparv-sbx-emotions-kb-emoclass --inject sparv

Usage

Depending on how many explicit exports of annotations you have you can decide to use this annotation exclusively by adding it as the only annotation to export under xml_export:

xml_export:
  annotations:
    - <sentence>:sbx_emotions_kb_emoclass.emotion--kb-emoclass

To use it together with other annotations you might add it under export:

export:
    annotations:
        - <sentence>:sbx_emotions_kb_emoclass.emotion--kb-emoclass
        ...

Configuration

You can configure this plugin in the following ways.

Language of Annotations

The language of the annotations defaults to en (English), but you can change that to sv (Swedish).

# file: config.yaml
sbx_emotions_kb_emoclass:
  annotation_lang: sv

Metadata

Model

Type	HuggingFace Model	Revision
Model	KBLab/emotional-classification	73f1663770e79ff5c1aa12a38063a13537a02ce0

Known issues

• InconsistentWarning because of using scikit-learn of version 1.7.2. See Issue 11.
  • Solved with: scikit-learn<1.3.0 and numpy<2.0.0

[!NOTE] You might need to put export CFLAGS="-Wno-error=incompatible-pointer-types" ; export CXXFLAGS="-Wno-error=incompatible-pointer-types" before installing

Minimum Supported Python Version Policy

The Minimum Supported Python Version is fixed for a given minor (1.x) version. However it can be increased when bumping minor versions, i.e. going from 1.0 to 1.1 allows us to increase the Minimum Supported Python Version. Users unable to increase their Python version can use an older minor version instead. Below is a list of sparv-sbx-emotions-kb-emoclass versions and their Minimum Supported Python Version:

• v0.1: Python 3.11.

Note however that sparv-sbx-emotions-kb-emoclass also has dependencies, which might have different MSPV policies. We try to stick to the above policy when updating dependencies, but this is not always possible.

Changelog

This project keeps a changelog.

License

This repository is licensed under the MIT license.

Development

Development prerequisites

• uv
• pre-commit

For starting to develop on this repository:

• Clone the repo (in one of the ways below):
  • git clone [email protected]:spraakbanken/sparv-sbx-emotions-kb-emoclass.git
  • git clone https://github.com/spraakbanken/sparv-sbx-emotions-kb-emoclass.git
• Setup environment: make dev
• Install pre-commit hooks: pre-commit install

Do your work.

Tasks to do:

• Test the code with make test or make test-w-coverage.
• Lint the code with make lint.
• Check formatting with make check-fmt.
• Format the code with make fmt.
• Type-check the code with make type-check.
• Test the examples with:
  • make test-example-small-txt

This repo uses conventional commits.

Release a new version

• Prepare the CHANGELOG: make prepare-release.
• Edit CHANGELOG.md to your liking.
• Add to git: git add --update
• Commit with git commit -m 'chore(release): prepare release' or cog commit chore 'prepare release' release.
• Bump version (depends on `bump-my-version)
  • Major: make bumpversion part=major
  • Minor: make bumpversion part=minor
  • Patch: make bumpversion part=patch or make bumpversion
• Push main and tags to GitHub: git push main --tags or make publish
  • GitHub Actions workflow will build, test and publish the package to PyPi.
• Add metadata for Språkbanken's resource
  • Generate metadata: make generate-metadata
  • Upload the files from assets/metadata/export/sbx_metadata/analysis to https://github.com/spraakbanken/metadata/tree/main/yaml/analysis.